v2
latestOpenAPI 3.1.02026-08-07168434918.5 KBCopy Store Promotion
Path parameters
Response
Successful Response
The name of the promotion
The start date of the promotion in seconds when the promotion starts to be applied
The end date of the promotion in seconds when the promotion ends to be applied
The discount percent of the promotion
The bonus percent of the promotion for a stackable items
The maximum purchase count of the promotion. If the user exceeds this count, the promotion will not be applied.
The maximum purchase count per user. If the user exceeds this count, the promotion will not be applied. This setting is mutually exclusive with 'max_purchase_count'
The rewards points percent of the promotion
The fixed rewards points amount
The loyalty points percent of the promotion
The fixed loyalty points amount
Store ids that the promotion is applied to
Item ids that the promotion is applied to
Category ids that the promotion is applied to
Turn off discount benefit for items that can be purchased with reward points
The user will receive a quantity equivalent to the set percentage of the total USD (in cents) purchase.
The item ID that the user will receive a quantity equivalent to the set percentage of the total USD (in cents) purchase.
The fixed quantity of the bonus item
Background image URL to override item background during the promotion
Featured card background image URL to override item featured card background during the promotion
Allows to enable or disable the promotion
The date when the promotion is archived in seconds
Custom text for store items bonus badge during the promotion
Custom text to override store items custom badge during the promotion
Whether the promotion should be applied to free items