Enable or disable a promotion
Use this endpoint to change promotion status by enabling or disabling a promotion. Note that you cannot change the status of a promotion that is currently ACTIVE. You can enable the promotions that are currently disabled and disable the promotions that have not expired yet.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Merchant's 24-character tenant ID
The sales channel ID.
The platform where the request is made.
A unique request ID.
Path Parameters
Promotion ID to toggle the promotion
Body
True: promotion will be enabled<br />False: promotion be disabled
Response
A 24-character system-generated promotion ID.
The name of the promotion.
Promotion status
ACTIVE
, SCHEDULED
, DISABLED
, EXPIRED
The start time of the promotion, in UTC format.
The end time of the promotion, in UTC format.
Promotion types. The options are:<br />Product: Also referred to as SKU promotion. Promotion or discount is applied on SKUs based on the value mentioned in the discount
object of the request body.<br />CART: Also referred to as cart promotion. Promotion or discount is applied on the minimum order amount of the cart based on the ORDER_VALUE
mentioned in the condition
object of the request body.<br />QUANTITY: Quantity promotion provides discounts on items based on the quantity requirement set in the promotion.<br />SHIPPING: Shipping promotion provides discounts on the shipping cost.<br />BUYGET: BuyGet promotion specifies the Buy conditions and corresponding Get discounts.<br />SPEND_GET: SpendGet promotion specifies the total order value required to qualify for discounts and the discounts applicable based on the order value.
PRODUCT
, CART
, QUANTITY
, SHIPPING
, BUYGET
, SPEND_GET
Record's creation time
Record's last updated time
Promotion execution order. Promotion types are assigned a default execution order. First, level 1 promotions will be evaluated. The result of level 1 will be used as a base price for level 2. Similarly, the result of level 2 will be used as a base price for level 3, and so on.
true: Promotion can be applied on top of other promotions<br />false: Promotion cannot be applied with any other promotions
A flag indicating whether the promotion is always applied regardless of any exclusive promotions on the same item. Set to true
if the promotion is always applied and set to false
if the promotion is not applied on the item by default.
A placeholder for additional attributes related to promotions, in key-value pairs.
Message description for the promotion
Was this page helpful?