Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

code
string
required

The code of the purchase limit rule.

Query Parameters

responseFields
string

limits which fields are returned in the response body

Response

OK

Purchase Limit Rule contract

auditInfo
object
code
string | null

Unique identifier of the PurchaseLimit.

customerRules
string[] | null

List of customer rule codes that apply to the PurchaseLimit

description
string | null

PurchaseLimit description

enabled
boolean | null

Indicates if the PurchaseLimit is enabled

endDate
string<date-time> | null

End of the rule's effective window. Null = never expires. Must be >= StartDate when both supplied.

isActive
boolean | null

Read-only. Computed server-side: true when the current UTC instant is inside the effective window (StartDate null/≤now AND EndDate null/≥now), false otherwise. A rule with no dates is always active. This reflects the effective window alone and does not incorporate the enabled flag.

maxQty
integer<int32>

Maximum quantity of the PurchaseLimit

metaData
any | null

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

name
string | null

PurchaseLimit name

productRules
string[] | null

List of product rule codes that apply to the PurchaseLimit

rank
integer<int32>

Rank of the PurchaseLimit

startDate
string<date-time> | null

Start of the rule's effective window. Null = no lower bound (already active).

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