REreacherapp
GMV Max

Posts usable in a Product GMV Max campaign

Changed on

TikTok's gmv_max/video/get, read on the request: the posts (videos) this store can use in a Product GMV Max campaign, with linked products, identity and video details. Filter by products, caption or post ID, and identity_ids from gmv_max_identities; set custom_posts_eligible for videos that can become customized posts for one product. Read-only. Single shop only.

post/gmv-max/posts

Request

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

Request body

spu_idsstring[] nullable

Only posts linked to these products. With custom_posts_eligible, exactly one product.

custom_posts_eligibleboolean

Videos that can become customized posts for one product (spu_ids must hold exactly one).

keywordstring nullable

Caption text (fuzzy), or a post ID of 19+ digits (exact).

identity_idsstring[] nullable

Only posts from these identities of this store (IDs from gmv_max_identities; not AUTH_CODE ones).

include_auth_code_postsboolean

Include posts authorized with video codes. TikTok returns nothing when this is false and no identity_ids are given.

sort_field'GMV' | 'POST_TIME' | 'VIDEO_VIEWS' | 'VIDEO_LIKES' | 'CLICK_THROUGH_RATE' | 'PRODUCT_CLICKS' nullable

Not with custom_posts_eligible.

sort_type'ASC' | 'DESC' nullable
pageinteger
page_sizeinteger

Response

Successful Response

shop_idinteger required
advertiser_idstring required
store_idstring required

This shop's TikTok Shop (store) ID.

source'live'

Always live: read from TikTok on the request.

fetched_atstring nullable required

Changes