Skip to main content
POST

Authorizations

Authorization
string
header
required

Enter your API key as: Bearer your-api-key

Body

application/json
storeId
string
required
Minimum string length: 1
name
string
required
Minimum string length: 1
automatic
boolean
default:false
usageLimit
integer | null
Required range: x > 0
startDate
string<date-time> | null
endDate
string<date-time> | null
enabled
boolean
default:true
ruleOperator
enum<string>
default:OR
Available options:
AND,
OR
combinesWithOrderLevelDiscounts
boolean
default:false
combinesWithLineItemDiscounts
boolean
default:false
combinesWithShippingDiscounts
boolean
default:false
forceCombine
boolean
default:false
oncePerCustomer
boolean
default:false
rules
object[]
actions
object[]
promotionCodes
object[]

Optional. Redeemable codes to create atomically alongside the promotion. Each entry mirrors the POST /promotion-codes/create body (without promotionId, which is inferred). Uniqueness is enforced per store and per batch; a failure on any code rolls back the whole promotion.

Response

Successful response