Create coupon
Enables you to create a coupon that can be applied to get discounts
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.
Body
Coupon title
3 - 120Start date of the promotion
End date of the promotion
A flag indicating whether a coupon can be stacked with an existing promotion. Set it to true to prevent the coupon from being applied to items that already have promotions and false to allow coupon to be applied with existing promotions.
Promotion type.<br /> Product: SKU promotion. Promotion or discount on SKUs based on the value mentioned in discount object<br />CART: Cart promotion. Promotion or discount on minimum cart value based on the ORDER_VALUE that is set in condition object<br />QUANTITY: Quantity promotion provides discounts based on the quantity requirement set in the promotion<br />BOGO: Buy One Get One promotion provides discounts based on the Buy conditions and Get discounts<br />SHIPPING: Shipping promotion provides discounts on the shipping cost<br />BUYGET: BuyGet promotion specifies the Buy conditions and Get discounts<br />SHIPPING: Shipping promotion provides discounts on the shipping cost<br />SPEND_GET: SpendGet promotion can specify the requirement of cart order value and the corresponding Get discounts
PRODUCT, CART, QUANTITY, BOGO, SHIPPING, BUYGET, SPEND_GET A list of coupon codes that are applicable only for coupons. For coupons, the response includes promo codes associated with the coupon. For promotions, the response includes an empty array.
It is used to define operator between different Buy conditions (different conditions as mentioned in the condition object)
AND, OR Defines the rules for how a promotion can be combined with other promotions. This field determines whether a specific promotion can be applied in conjunction with other active promotions during a transaction or if it must be used exclusively. Possible values: - STACKABLE: This promotion can be combined with other stackable promotions, allowing multiple
discounts to be applied together. The order in which stackable promotions are applied
is determined by the level field, with promotions having a higher priority (lower numeric value)
being applied before those with a lower priority.
EXCLUSIVE: This promotion cannot be combined with any other promotions. Thelevelfield is used to determine which exclusive promotion will be evaluated and applied first. Once an exclusive promotion is applied, no other promotions can be used in the same transaction.TYPE_EXCLUSIVE: This promotion cannot be combined with other promotions of the same type. Thelevelfield is used to determine which promotion within the same type will be evaluated and applied first.UNIVERSAL: This promotion can be combined with any other promotions without restrictions. Universal promotions will be evaluated last. We don't need to definelevelfor this type.
STACKABLE, EXCLUSIVE, TYPE_EXCLUSIVE, UNIVERSAL The promotion execution order. Promotion types are assigned default execution orders. Initial evaluation begins with level 1 promotions. The result of level 1 is used as the base price for level 2. Similarly, the result of level 2 becomes the base price for level 3, and so on.
Required for shipping type promo to provide eligible shipment methods
IDs of the price lists to which this promotion is applied
Promotion note or description
Array of limits for the coupon to be applied
A placeholder for additional attributes associated with promotions, in key-value pairs.
Response
A 24-character system-generated promotion ID.
A unique identifier of the promotion, for external use.
A list of coupon codes that are applicable only for coupons. For coupons, the response includes promo codes associated with the coupon. For promotions, the response includes an empty array.
Promotion status. <br /> ACTIVE indicates that the promotion is applied to SKUs or items for which it is set as Active. Active promotions cannot be disabled.<br />SCHEDULED indicates that the promotion is scheduled to be applied to SKUs or items based on the defined start date.<br />DISABLED indicates that the promotion is set as disabled and is not in use. Only Disabled promotions can be enabled.<br />EXPIRED indicates that the promotion is stopped by setting the expiration date. That is, the start date and end date as the current date. Only those promotions that are not expired can be enabled.
ACTIVE, SCHEDULED, DISABLED, EXPIRED A flag indicating whether an offer is applied automatically. Set it to true for promotions, which should be applied automatically and false for coupons, which must be applied explicitly.
Title of the promotion
It is used to define operator between different Buy conditions (different conditions as mentioned in the condition object)
AND, OR Start date of the promotion
End date of the promotion
A flag indicating whether a coupon can be stacked with an existing promotion. Set it to true to prevent the coupon from being applied to items that have promotions and false to allow coupon to be applied with existing promotions.
Promotion type.<br /> Product: SKU promotion. Promotion or discount on SKUs based on the value mentioned in discount object<br />CART: Cart promotion. Promotion or discount on cart amount based on the ORDER_VALUE that is set in condition object<br />QUANTITY: Quantity promotion provides discounts based on the quantity requirement set in the promotion<br />BOGO: Buy One Get One promotion provides discounts based on the Buy conditions and Get discounts<br />SHIPPING: Shipping promotion provides discounts on the shipping cost<br />BUYGET: BuyGet promotion specifies the Buy conditions and Get discounts<br />SPEND_GET: SpendGet promotion can specify the requirement of cart order value and the corresponding Get discounts
PRODUCT, CART, QUANTITY, BOGO, SHIPPING, BUYGET, SPEND_GET Defines the rules for how a promotion can be combined with other promotions. This field determines whether a specific promotion can be applied in conjunction with other active promotions during a transaction or if it must be used exclusively. Possible values: - STACKABLE: This promotion can be combined with other stackable promotions, allowing multiple
discounts to be applied together. The order in which stackable promotions are applied
is determined by the level field, with promotions having a higher priority (lower numeric value)
being applied before those with a lower priority.
EXCLUSIVE: This promotion cannot be combined with any other promotions. Thelevelfield is used to determine which exclusive promotion will be evaluated and applied first. Once an exclusive promotion is applied, no other promotions can be used in the same transaction.TYPE_EXCLUSIVE: This promotion cannot be combined with other promotions of the same type. Thelevelfield is used to determine which promotion within the same type will be evaluated and applied first.UNIVERSAL: This promotion can be combined with any other promotions without restrictions. Universal promotions will be evaluated last. We don't need to definelevelfor this type.
STACKABLE, EXCLUSIVE, TYPE_EXCLUSIVE, UNIVERSAL The promotion execution order. Promotion types are assigned default execution orders. Initial evaluation begins with level 1 promotions. The result of level 1 is used as the base price for level 2. Similarly, the result of level 2 becomes the base price for level 3, and so on.
Required for Shipping type promo to provide eligible shipment Methods
IDs of the price lists to which this promotion is applied
Array of limits for the promotion to be applied
Promotion note or description
Creation date of the record
Last updated date of the record
Was this page helpful?