API reference
Error
A valid request URL is required to generate request examples{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"code": "<string>",
"customerRules": [
"<string>"
],
"description": "<string>",
"enabled": true,
"maxQty": 123,
"metaData": "<unknown>",
"name": "<string>",
"productRules": [
"<string>"
],
"rank": 123,
"validForAllSites": true,
"validSites": [
123
]
}Get Purchase Limit Rule by Code
Gets purchase limit rule details by code.
GET
/
commerce
/
rules
/
purchaselimit
/
{code}
Error
A valid request URL is required to generate request examples{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"code": "<string>",
"customerRules": [
"<string>"
],
"description": "<string>",
"enabled": true,
"maxQty": 123,
"metaData": "<unknown>",
"name": "<string>",
"productRules": [
"<string>"
],
"rank": 123,
"validForAllSites": true,
"validSites": [
123
]
}Authorizations
JWT Authorization header using the Bearer scheme.
Path Parameters
The code of the purchase limit rule.
Query Parameters
limits which fields are returned in the response body
Response
Success
Purchase Limit Rule contract
Show child attributes
Show child attributes
Unique identifier of the PurchaseLimit.
List of customer rule codes that apply to the PurchaseLimit
PurchaseLimit description
Indicates if the PurchaseLimit is enabled
Maximum quantity of the PurchaseLimit
Metadata for the PurchaseLimit which is a json format, used to store additional information
PurchaseLimit name
List of product rule codes that apply to the PurchaseLimit
Rank of the PurchaseLimit
Indicates if the PurchaseLimit is valid for all sites
List of site IDs that the PurchaseLimit is valid for
⌘I