Skip to main content

promotion_update_push

Last Updated: 18 Aug 2022

Basics

PropertyValue
CategoryMarketing Push
Push Mechanism Namepromotion_update_push
Push Mechanism Code9
Push Mechanism DescriptionGet the promotion update
Push Mechanism Subscription RulesOriginal/ERP System/Seller In House System/Product Management/Marketing/Customized APP/Swam ERP
Time Out Seconds3s
Sequence GuaranteedNo
Can Repeated Same MessageYes
Retry Seconds300s,1800s,10800s

Push Parameters

NameTypeSampleDescription
dataobject
shop_idint122406687Shopee's unique identifier for a shop.
promotion_idint965808642693807The identity of item promotion.
promotion_typestringseller_discountThe type of promotion.Promotion type:seller_discount / product_promotion_SG / product_promotion_MY / product_promotion_ID / product_promotion_VN / product_promotion_TW / product_promotion_TH / product_promotion_PH / flash_sale (contains: in_shop_flash_sale, flash_sale, brand_sale) / add_on_deal_main / add_on_deal_sub / bundle_deal / group_buy
end_timetimestamp1660123171Promotion end time.
actionstringpromo_time_updatedThe action of the event. Action: added_in_promo / removed_from_promo / promo_time_updated
item_idint89526059511Shopee's unique identifier for an item.
variation_idint163967197734Shopee's unique identifier for a variation of an item.
shop_idint122406687Shopee's unique identifier for a shop.
codeint9Shopee's unique identifier for a push notification.
timestamptimestamp1660123173Timestamp that indicates the message was sent.

We will push messages when these three events occur:

  • item is added in a promotion
  • item is removed from a promotion
  • promotion start /end time is updated

Push logic:

1.when item is added in a promotion:

  • for reserved stock promotion(flash_sale/product_promotion),reserved_stock = reserved stock qty ;
  • for non-reserved stock promotion,reserved_stock field won't return
  • action = added_in_promo;

Json

{"data":{"shop_id":712661865,"promotion_id":22775521,"promotion_type":"bundle_deal","start_time":1660124460,"end_time":1661943600,"action":"added_in_promo","item_id":14662380213,"variation_id":0},"shop_id":712661865,"code":9,"timestamp":1660124466}

2.when item is removed form a promotion:

  • for reserved stock promotion(FS/PP),reserved_stock = the stock qty (the latest value);
  • action= removed_from_promo;
  • there is one cases when item is removed form a promotion:
    item is rejected/deleted,promotion still valid, notification will return the unique item that removed from a promotion;

Json

{"data":{"shop_id":526225965,"promotion_id":668908774363077,"promotion_type":"seller_discount","action":"removed_from_promo","item_id":20332329221,"variation_id":145413438373},"shop_id":526225965,"code":9,"timestamp":1660124435}

3.when promotion start/end time is update (include upcoming and ongoing promotion):

  • promotion_status = normal;
  • action= promo_time_updated;
  • start_time/ end_time  return the updated start/end  time;
  • no reserved stock field

Json

{"data":{"shop_id":722406687,"promotion_id":665808642693807,"promotion_type":"seller_discount","end_time":1660123171,"action":"promo_time_updated","item_id":19526059511,"variation_id":163767197734},"shop_id":722406687,"code":9,"timestamp":1660123173}

Update Log

DateUpdate Details
2022-08-18New Push Mechanism