v2

latestOpenAPI 3.1.12026-08-078549932.4 MB
PriceRules

post/PriceRules

Request body

namestring
descriptionstring nullable
isActiveboolean
ruleTypestring
scopestring
groupCodeIdstring nullable
validFromstring date-time nullable
validTostring date-time nullable
stackingOverridestring nullable
clientTagIdsstring[]

Customer-tag ids that gate this rule (empty = applies to any client).

Response

Created

idstring
namestring
descriptionstring nullable
isActiveboolean
ruleTypestring

One of: BuyXGetYFree, BuyXGetYPercentOff, SpendThreshold, QuantityTier.

scopestring

One of: GroupCode, Global.

groupCodeIdstring nullable
validFromstring date-time nullable
validTostring date-time nullable
stackingOverridestring nullable

One of: BestWins, Stack, or null to inherit the tenant setting.

clientTagIdsstring[]

Customer-tag ids that gate this rule. Empty = applies to any client; when non-empty the rule fires only for clients carrying at least one of them.

createdAtstring date-time
updatedAtstring date-time