Promotions

Every activity on the shop, live from TikTok

Changed on

All product discount, flash sale, shipping and buy-more-save-more activities on the shop as TikTok lists them, including ones made in Seller Center. Nothing is stored. Search returns no products; read one with GET /promotions/activities/{activity_id} for products, prices and used_quantity. Coupons are listed under /promotions/coupons. Paged by walking TikTok's cursor, so page N costs N upstream calls; pages beyond 20 are refused. TikTok returns no GMV, orders, discount totals or ROI per promotion.

get/promotions/activities/search

Request

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

Query parameters

pageinteger
page_sizeinteger
status'DRAFT' | 'NOT_START' | 'ONGOING' | 'EXPIRED' | 'DEACTIVATED' | 'NOT_EFFECTIVE'

TikTok activity status.

activity_type'FIXED_PRICE' | 'DIRECT_DISCOUNT' | 'FLASHSALE' | 'SHIPPING_DISCOUNT' | 'BUY_MORE_SAVE_MORE' | 'BUY_X_GET_Y' | 'GIFT_WITH_PURCHASE'

activity_type values search returns (spec plus GIFT_WITH_PURCHASE seen live); wider than ActivityType.

TikTok activity type; all types when omitted.

titlestring nullable

TikTok's title keyword match.

Response

Successful Response

shop_idinteger required

Changes