Skip to main content

Promotion

v1

Description

Promotions are used to engage shoppers and earn substantial revenue in the short term. Get notified on the creation and updation of any promotion in your sales channel.


Supported Type

  • Create
  • Update

Payload

{
"event":{
"trace_id":[
"megatron.60927d19-d2f0-4055-a842-7d0c850f8399"
],
"name":"promotion",
"type":"create",
"version":"1",
"created_timestamp":1661316280142,
"id":"YM5MnjBY/Q2vZUKcV6pl9s+3wEWu6d/fVbQZqkOO6dE=",
"category":"application"
},
"company_id":1526,
"application_id":"61012f6a9250ccd1b9ef8a1d",
"contains":[
"promotion"
],
"payload":{
"promotion":{
"ownership":{
"payable_by":"",
"payable_category":"seller"
},
"apply_all_discount":false,
"buy_rules":{
"rule#1":{
"cart_quantity":{
"equals":1
},
"item_id":[
8364793,
8364794,
8374252
]
},
"rule#2":{
"item_id":[
7931785,
8364794,
8382156
]
}
},
"display_meta":{
"description":"<p>Test101</p>",
"name":"Test101",
"offer_text":"Test101"
},
"restrictions":{
"anonymous_users":true,
"user_id":[

],
"user_groups":[

],
"platforms":[
"web",
"android",
"ios"
],
"uses":{
"remaining":{
"user":0,
"total":0
},
"maximum":{
"user":0,
"total":0
}
},
"payments":{

},
"user_registered":{
"end":null,
"start":null
},
"post_order":{
"cancellation_allowed":true,
"return_allowed":true
}
},
"_schedule":{
"published":true,
"end":null,
"duration":0,
"start":"2022-08-24T04:44:28.191000+00:00",
"cron":"",
"next_schedule":[
{
"start":"2022-08-24T04:44:28.191000+00:00",
"end":null
}
]
},
"currency":"INR",
"date_meta":{
"modified_on":"2022-08-24T04:44:40.133760+00:00",
"created_on":"2022-08-24T04:44:40.133760+00:00"
},
"post_order_action":{
"action_type":"",
"action_date":null
},
"mode":"promotion",
"_id":"6305acb87aeb16ba75e1faa5",
"author":{
"created_by":"d933f5e8cc7ded2fa44a060d",
"modified_by":"d933f5e8cc7ded2fa44a060d"
},
"promotion_type":"bogo",
"application_id":"61012f6a9250ccd1b9ef8a1d",
"apply_priority":1,
"apply_exclusive":null,
"discount_rules":[
{
"buy_condition":"( rule#1 )",
"item_criteria":{
"buy_rules":[
"rule#2"
]
},
"discount_type":"bogo",
"offer":{
"max_offer_quantity":1
}
}
],
"stackable":true,
"promo_group":"product",
"visiblility":{
"coupon_list":false,
"pdp":true
}
}
}
}

Object Properties

KeyTypeDescription
promotion.apply_all_discountBooleanIndicates whether multiple discount rules can be applied together or not
promotion.author.modified_byStringID of the user who last modified the promotion
promotion.author.created_byStringID of the user who created the promotion
promotion.currencyStringISO code of the currency
promotion.visiblility.coupon_listBooleanShow promotions under coupon list. Used when promotion mode is coupon
promotion.visiblility.pdpBooleanShow promotion on PDP page
promotion._schedule.startStringPromotion validity start date
promotion._schedule.publishedBooleanIf promotion is published or marked inactive
promotion._schedule.endStringPromotion validity end date
promotion._schedule.next_schedule.startStringPromotion validity start ISO date string
promotion._schedule.next_schedule.endStringPromotion validity end ISO date string
promotion.promotion_typeStringPromotion Type. Possible values: percentage, amount, fixed_price, bogo, contract_price, ladder_price, custom
promotion.stackableBooleanIndicates if promotion can be applied along with another promotion
promotion._idStringID of the promotion
promotion.application_idStringID of the application (sales channel) where promotion is applicable
promotion.apply_priorityIntegerPriority of applying a promotion. Higher value promotions are applied first
promotion.discount_rules.0.offer.discount_percentageFloatDiscount percentage
promotion.discount_rules.0.offer.discount_amountFloatDiscount amount
promotion.discount_rules.0.offer.max_offer_quantityIntegerMaximum quantity allowed
promotion.discount_rules.0.offer.discount_priceFloatReduced price (generally less than the MRP)
promotion.discount_rules.0.offer.min_offer_quantityIntegerMinimum quantity required to avail the offer
promotion.discount_rules.0.offer.codeStringPromo code required to avail the offer
promotion.discount_rules.0.buy_conditionStringAND/OR expression of buy_rules dictionary rule keys. Added buy rules will be considered to apply current discount rule
promotion.discount_rules.0.discount_typeStringCurrent discount object type. Possible values: percentage, amount, fixed_price, fixed_unit_price, bogo, shipping_price, free_items, cashback, coupon_code
promotion.discount_rules.0.item_criteria.item_id[Integer]List of item uids on which offer will be applied
promotion.discount_rules.0.item_criteria.item_store[Integer]List of store uids as filter
promotion.discount_rules.0.item_criteria.item_brand[Integer]List of brand uids as filter
promotion.discount_rules.0.item_criteria.item_sku[String]List of sku codes as filter
promotion.discount_rules.0.item_criteria.item_company[Integer]List of company uids sizes as filter
promotion.discount_rules.0.item_criteria.item_size[String]List of item's sizes as filter
promotion.discount_rules.0.item_criteria.item_category[Integer]List of item category as filter
promotion.discount_rules.0.item_criteria.item_exclude_brand[Integer]List of excluded brands as filter
promotion.discount_rules.0.item_criteria.item_exclude_sku[String]List of excluded sku as filter
promotion.discount_rules.0.item_criteria.item_exclude_store[Integer]List of excluded store uids as filter
promotion.discount_rules.0.item_criteria.item_exclude_category[Integer]List of excluded category uids as filter
promotion.discount_rules.0.item_criteria.item_exclude_company[Integer]List of excluded company uids as filter
promotion.promo_groupStringPromotion group. Possible values: product, cart, contract, ladder_price
promotion.post_order_action.action_dateStringISODate for sending cashback/coupon code for post order action type promotions
promotion.post_order_action.action_typeStringType of post order action. Possible values: cashback, coupon_code
promotion.date_meta.created_onStringPromotion creation ISOdate
promotion.date_meta.modified_onStringPromotion last modified ISOdate
promotion.apply_exclusiveStringIf allowed, any other promotion after current promotion is applied. Possible values: article, cart, null
promotion.display_meta.nameStringName of promotion on Fynd Platform Panel
promotion.display_meta.offer_textStringPromotional offer text to be shown on PDP or Cart
promotion.display_meta.descriptionStringPromotion T&C description
promotion.restrictions.user_id[String]List of only allowed user _ids for whom promotion should be applicable
promotion.restrictions.order_quantityIntegerMax. order quantity to be allowed in current promotion
promotion.restrictions.post_order.return_allowedBooleanIndicates whether customers can return an order purchased with promotion applied
promotion.restrictions.post_order.cancellation_allowedBooleanIndicates whether customers can cancel an order purchased with promotion applied
promotion.restrictions.user_registered.startStringAllow promotion to be applied for users registered after mentioned ISO date
promotion.restrictions.user_registered.endStringAllow promotion to be applied for users registered before mentioned ISO date
promotion.restrictions.paymentsObjectAllow payment mode for which promotion should be applicable
promotion.restrictions.uses.maximum.userIntegerMaximum usage of promotion per user
promotion.restrictions.uses.maximum.totalIntegerMaximum total usage of promotion
promotion.restrictions.uses.remaining.userIntegerRemaining usage of promotion per user
promotion.restrictions.uses.remaining.totalIntegerRemaining total usage of promotion
promotion.restrictions.anonymous_usersBooleanAllow anonymous users to avail this promotion
promotion.restrictions.platforms[String]List of device platforms on which promotion is allowed. Possible values: web, ios, android
promotion.modeStringType of promotion. Possible values: promotion, coupon
promotion.buy_rules.<rule_slug_key>.item_id[Integer]List of item uids which needs to be bought to apply current promotion
promotion.buy_rules.<rule_slug_key>.item_store[Integer]List of store uids
promotion.buy_rules.<rule_slug_key>.item_brand[Integer]List of brand uids as filter
promotion.buy_rules.<rule_slug_key>.item_sku[Integer]List of sku codes as filter
promotion.buy_rules.<rule_slug_key>.item_company[Integer]List of company uids sizes as filter
promotion.buy_rules.<rule_slug_key>.item_size[Integer]List of item's sizes as filter
promotion.buy_rules.<rule_slug_key>.item_category[Integer]List of item category as filter
promotion.buy_rules.<rule_slug_key>.item_exclude_brand[Integer]List of excluded brands as filter
promotion.buy_rules.<rule_slug_key>.item_exclude_sku[Integer]List of excluded sku as filter
promotion.buy_rules.<rule_slug_key>.item_exclude_store[Integer]List of excluded store uids as filter
promotion.buy_rules.<rule_slug_key>.item_exclude_category[Integer]List of excluded category uids as filter
promotion.buy_rules.<rule_slug_key>.item_exclude_company[Integer]List of excluded company uids as filter