object

AppliedPromotion

Fields to determine the applied promotions details on a product.
Fields
amount
Float
Per 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
Int
Quantity of article on which promotion is applicable. Example: 2
buy_rules
[BuyRules]
Buy rules for promotions. Example: [{ item_criteria: { brands: [123] } }]
code
String
Promotion code. Example: 'DIWALI10'
discount_rules
[DiscountRulesApp]
Discount rules for promotions. Example: [{ offer: { percentage: 10 } }]
meta
JSON
Meta object for extra data. Example: { stackable: true }
mrp_promotion
Boolean
Whether promotion applies on product MRP or ESP. Example: true
offer_text
String
Offer text of current promotion. Example: '10% OFF'
offer_label
String
Offer label for display. Example: 'Festive Offer'
ownership
Ownership
Ownership of promotion. Example: { payable_by: 'merchant', payable_category: 'marketing' }
promo_id
String
Promotion id. Example: 'PROMO123'
promotion_group
String
Promotion group. Example: 'payment'
promotion_name
String
Promotion name. Example: 'Diwali Sale'
promotion_type
String
Promotion type. Example: 'percentage'
cancellation_allowed
Boolean
Whether cancellation is allowed for orders with this coupon. Example: true
currency
CartCurrency
Currency 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