Skip to main content
POST
/
commerce
/
rules
/
purchaselimit
Error
A valid request URL is required to generate request examples
{
  "code": "<string>",
  "name": "<string>",
  "description": "<string>",
  "maxQty": 123,
  "productRules": [
    "<string>"
  ],
  "customerRules": [
    "<string>"
  ],
  "rank": 123,
  "enabled": true,
  "validForAllSites": true,
  "validSites": [
    123
  ],
  "metaData": "<unknown>",
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  }
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

responseFields
string

limits which fields are returned in the response body

Body

application/json

Purchase Limit Rule contract

code
string | null

Unique identifier of the PurchaseLimit.

name
string | null

PurchaseLimit name

description
string | null

PurchaseLimit description

maxQty
integer<int32>

Maximum quantity of the PurchaseLimit

productRules
string[] | null

List of product rule codes that apply to the PurchaseLimit

customerRules
string[] | null

List of customer rule codes that apply to the PurchaseLimit

rank
integer<int32>

Rank of the PurchaseLimit

enabled
boolean | null

Indicates if the PurchaseLimit is enabled

validForAllSites
boolean | null

Indicates if the PurchaseLimit is valid for all sites

validSites
integer<int32>[] | null

List of site IDs that the PurchaseLimit is valid for

metaData
any | null

Metadata for the PurchaseLimit which is a json format, used to store additional information

auditInfo
object

Response

Success

Purchase Limit Rule contract

code
string | null

Unique identifier of the PurchaseLimit.

name
string | null

PurchaseLimit name

description
string | null

PurchaseLimit description

maxQty
integer<int32>

Maximum quantity of the PurchaseLimit

productRules
string[] | null

List of product rule codes that apply to the PurchaseLimit

customerRules
string[] | null

List of customer rule codes that apply to the PurchaseLimit

rank
integer<int32>

Rank of the PurchaseLimit

enabled
boolean | null

Indicates if the PurchaseLimit is enabled

validForAllSites
boolean | null

Indicates if the PurchaseLimit is valid for all sites

validSites
integer<int32>[] | null

List of site IDs that the PurchaseLimit is valid for

metaData
any | null

Metadata for the PurchaseLimit which is a json format, used to store additional information

auditInfo
object