Fields
amount
FloatPer unit discount amount applied with current promotion. Example: 50.0
applied_free_articles
[AppliedFreeArticles]Applied free articles for free gift promotions. Example: [{ article_id: '5fdc737e3c05146138192f79', quantity: 1 }]
article_quantity
IntQuantity of article on which promotion is applicable. Example: 2
buy_rules
[BuyRules]Buy rules for promotions. Example: [{ item_criteria: { brands: [123] } }]
code
StringPromotion code. Example: 'DIWALI10'
discount_rules
[DiscountRulesApp]Discount rules for promotions. Example: [{ offer: { percentage: 10 } }]
meta
JSONMeta object for extra data. Example: { stackable: true }
mrp_promotion
BooleanWhether promotion applies on product MRP or ESP. Example: true
offer_text
StringOffer text of current promotion. Example: '10% OFF'
offer_label
StringOffer label for display. Example: 'Festive Offer'
ownership
OwnershipOwnership of promotion. Example: { payable_by: 'merchant', payable_category: 'marketing' }
promo_id
StringPromotion id. Example: 'PROMO123'
promotion_group
StringPromotion group. Example: 'payment'
promotion_name
StringPromotion name. Example: 'Diwali Sale'
promotion_type
StringPromotion type. Example: 'percentage'
cancellation_allowed
BooleanWhether cancellation is allowed for orders with this coupon. Example: true
currency
CartCurrencyCurrency of the price for the cart. Example: { code: 'INR', symbol: '₹' }
custom_fields
[CustomField]Additional custom attributes associated with the applied promotion for extended functionality and tracking
Was this section helpful?