REreacherapp
Promotions

Create a promotion activity and attach its products

Changed on

Creates a FLASHSALE, FIXED_PRICE or DIRECT_DISCOUNT activity on the shop's TikTok account and attaches the products (or SKUs at VARIATION level) in batches of at most 300. The activity id is recorded the moment TikTok returns it, so a lost answer or a failed attach never creates a second activity: the response state says how far it got and retry-attach finishes it.

TikTok requires begin_time in the future and refuses a title it already has. Coupons cannot be created through the API.

Requires read_write scope, the shop's TikTok grant with seller.promotion.write, and an Idempotency-Key (the same key with the same body replays; a different body is 409). X-Dry-Run: true returns the create and attach bodies that would be sent without calling TikTok.

post/promotions/activities

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/promotions/activities
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Headers

Idempotency-Keystring nullable
X-Dry-Runstring nullable

Request body

titlestring required
activity_type'FLASHSALE' | 'FIXED_PRICE' | 'DIRECT_DISCOUNT' required
product_level'PRODUCT' | 'VARIATION' required
begin_timeinteger required

Unix seconds; TikTok requires the future.

end_timeinteger required

Unix seconds.

participation_limit'BUYER_NO_LIMIT' | 'BUYER_LIMIT_ONLY_ONE'

Response

The Idempotency-Key was already processed (replayed: true); a dry run answers 200 with {dry_run, would} instead.

replayedboolean

True when this Idempotency-Key had already been processed.

Changes