POST Search Target Collaborations

Search Target Collaborations Shop Required scope: seller.affiliate_collaboration.read This API is used by Seller to search for all existing target collaborations. Sellers can search based on filters such as Invitation name, Invitation ID, Product name, Product ID and Creator name. Version 202508

POST/affiliate_seller/202508/target_collaborations/search

Request

Header

Properties	Type	Description
content-type Required	string	Allowed type: application/json
x-tts-access-token Required	string	The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller 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_size	int	The value of "page_size" must be 20, 50 or 100.
page_token	string	Pagination offset determines where you begin to search for. It's empty when raise your first request.
shop_cipher Required	string	Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. Get by API Get Authorization Shop

Body

Properties	Type	Description
creator_accept_status	string	Filtering by acceptance status of creators who are invited to target collaborations.You can query based on:- "ACCEPT", it means creators have already added the products to the showcase- "ALL""", it means regardless of whether the creator adds the product to the Showcase.By default, the target collaborations will be searched by "ALL" status.
free_sample_setting	string	Filtering by target collaborations' free sample setting.You can query based on:- "WITH_FREE_SAMPLE"- "ALL"By default, the target collaborations will be searched by "ALL" setting.
search_param	object	The search param.
creator_user_open_id	string	Creators' TikTok User Open ID.More details- CREATOR_OPEN_ID: If you use CREATOR_OPEN_ID to search, you can search for target collaboration information for a specified creator ID.
collaboration_status Required	string	Filtering by target collaborations' status.You can query based on:- ONGOING: If you use ONGOING to search, the remaining validity period of the returned target collaborations will be greater than 7 days.- EXPIRING: If you use EXPIRING to search, the remaining validity period of the returned target collaborations will be less than 7 days.- VALID: If you use VALID to search, all returned target collaborations will be valid.- CANCELING: If you use CANCELING to search, all returned target collaborations will be in the process of canceling.- COMPLETED: If you use COMPLETED to search, all returned target collaborations will be in the state of completed, including expired and canceled.

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