POST Search Creator Target Collaborations
Search Creator Target Collaborations Creator Required scope: creator.affiliate_collaboration.read This API is used to search for creator's target collaborations and the products within these target collaborations. Version 202405
POST/affiliate_creator/202405/target_collaborations/search
Request
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The creator access_token value from Get Access Token, when user_type = 1. Follow this guide to get creator access_token. |
Query
| Properties | Type | Description |
|---|---|---|
| app_key Required | string | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign Required | string | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp Required | int | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| page_token | string | An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page. |
| page_size Required | int | The number of results to be returned per page. Valid range: [0-100]. |
Body
| Properties | Type | Description |
|---|---|---|
| shop_id Required | string | The TikTok Shop identifier. |
| keyword_type | string | Target collaborations in the response are restricted to the the expressed type. This is an enumerated wtype with values:- TARGET_COLLABORATIONS_ID- TARGET_COLLABORATIONS_NAMETARGET_COLLABORATIONS_ID returns target collaborations with state set to LIVE, EXPIRED, DELETED, and ENDED. TARGET_COLLABORATIONS_NAME returns target collaborations with state set to LIVE only. |
| keyword | string | Target collaborations in the response are restricted to the expressed name. |
Example
CurlGoNode.jsJavaEnable word wrap
Response Parameters
| Properties | Type | Description |
|---|---|---|
| code | int | The success or failure status code returned in API response. |
| message | string | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | Request log |
| data | object | Specific return information |
Example
JSONEnable word wrap
Error Code
View common error codes
| Code | Message | | --- | --- | | Empty. No business logic error codes. |
Is this content helpful?Helpful
Not Helpful
PreviousNext