This API allows a seller to retrieve creator profiles, content counts, and promotion details for a specified product in open collaboration.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Identifies the shop. Obtain it from the Get Authorized Shops API.
Pagination token. Omit this parameter or pass an empty string for the first request. For subsequent requests, pass the next_page_token returned by the previous response and reuse the same product_id and page_size.
The value of “page_size” must be greater than 0 and less than or equal to 100.
The product ID that needs to be queried.
Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
Pagination token for the next page. Pass this value as page_token in the next request. An empty token means there are no more results.
Total count of creators that satisfy all the input search conditions.
Creator profiles, content counts, and promotion details for the specified product.
object
Creator’s profile details.
object
The creator’s username.
The creator’s nickname.
Number of followers of the creator.
The creator’s avatar details.
object
The URL for the creator’s TikTok profile avatar.
Creator Open ID. More details
This field indicates the number of videos posted by the creator.
This field indicates the number of lives posted by the creator.
Promotion status of the creator. Field values:
- NORMAL: When the creator is promoting normally, it returns to NORMAL status
- TERMINATING:When the creator is asked by the merchant to terminate the promotion, the status will return to TERMINATING, indicating that the creator’s promotion rights will expire soon.
End time of creator promotion.
Product details.
object
Product’s unique id.
The product image url.
Example
{ "code": 0, "data": { "next_page_token": "b2Zmc2V0PTEw", "total_count": 1, "creator_content_details": [ { "creator_profile": { "username": "example_creator", "nickname": "nickname", "follower_count": 10023, "avatar": { "url": "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/fa0387fa5a204dcfa44d5be75877a163~tplv-o3syd03w52-origin-webp.webp?from=3478900499" }, "creator_open_id": "uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg" }, "video_count": 101, "live_count": 2, "promotion_status": "NORMAL", "promotion_end_time": 1734682697 } ], "product": { "id": "1734823553672710512", "image_url": "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/fa0387fa5a204dcfa44d5be75877a163~tplv-o3syd03w52-origin-webp.webp?from=3478900499" } }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}