快工助手跨境电商知识与商机助手

Search Target Collaborations

TikTok Shop 官方资料 · TikTok Shop Partner Center 开发者文档 · 适合开发者

stable本次发布有变化全部展示

来自 TikTok Shop 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
TikTok Shop / profile.tiktok.docs_api
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/tiktok_shopaudience/developercategory/api_doctopic/compliancetopic/developer

资料正文

§1 Path: /affiliate_seller/202508/target_collaborations/search

#

§2 Method: [POST]

#

§3 Function Description

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.


#

§4 Common Parameters

For common parameters, refer to How to call TikTok Shop APIs - Common Parameters

Properties Location Type Require Sample Properties description
shop_cipherquerystringYGCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3Use 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
content-typeheaderstringYapplication/jsonAllowed type: application/json
#

§5 Request Query Parameters

Properties Type Require Sample Properties description
app_keystringY38abcdEvery single app will have a unique key. Please use the specific key assigned to your app.
signstringY5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8cSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestampintY1623812664Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
page_sizeintN20The value of "page_size" must be 20, 50 or 100.
page_tokenstringNb2Zmc2V0PTAKPagination offset determines where you begin to search for. It's empty when raise your first request.
#

§6 Request Body Parameters

Properties Type Require Sample Properties description
creator_accept_statusstringNACCEPTFiltering 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 |N |WITH_FREE_SAMPLE |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 |N | |The search param. | ^keyword_type |string |Y |TARGET_COLLABORATION_NAME |Pass in the parameter type which you use to search for target collaborations. You can query based on:
  • PRODUCT_ID:If you use PRODUCT_ID to search, you can search for target collaboration information for a specified product ID.
  • PRODUCT_NAME: If you use PRODUCT_NAME to search, you can fuzzy search for target collaboration information involving related product names.
  • TARGET_COLLABORATION_ID: if you use Target_Collaboration_ID to search, you can search for target collaboration information for a specified target collaboration ID.
  • TARGET_COLLABORATION_NAME: If you use Target_Collaboration_NAME to search, you can fuzzy search for target collaboration information involving related target collaboration names. | ^keyword |string |Y |test |Search Keyword. | creator_user_open_id |string |N |uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg |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 |string |Y |ONGOING |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. |
#

§7 Request Sample

Query

https://open-api.tiktokglobalshop.com/affiliate_seller/202508/target_collaborations/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&page_size=20&page_token=b2Zmc2V0PTAK

Body

{"creator_accept_status":"ACCEPT","free_sample_setting":"WITH_FREE_SAMPLE","search_param":{"keyword_type":"TARGET_COLLABORATION_NAME","keyword":"test"},"creator_user_open_id":"uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg","collaboration_status":"ONGOING"}
#

§8 Response Parameters

Properties Type Sample Properties description
codeint0The success or failure status code returned in API response.
messagestringSuccessThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstring202203070749000101890810281E8C70B7Request log
dataobjectSpecific return information
^total_countint100The total count of target collaboration returned by this query.
^next_page_tokenstringb2Zmc2V0PTAKCursor for the next page request.
^target_collaborations[]objectThe basic information of target collaboration which creators can view in Targeted Invitation on TikTok EC Center.
^^idstring789078671231123124Target collaboration ID.
^^namestringtarget_collaborationTarget collaboration name.
^^messagestringtestMessage seller has sent to creators about seller's introduction and why excited to collaborate.
^^start_timeint1715654330The start time of the target collaboration.
^^end_timeint1715654330The end time of the target collaboration.
^^create_timeint1715654330The create time of the target collaboration.
^^update_timeint1715654330The update time of the target collaboration.
^^creator_inivited_countint10The count of creators invited in the target collaboration.
^^showcase_creator_countint2This field indicates the number of creators who added the product to the showcase from target collaboration.
^^content_creator_countint1The number of creators who posted content featuring products from target collaboration.
^^product_countint30The count of products added in the target collaboration.
^^free_sample_ruleobjectThe free sample rules set by the seller in the target collaboration.
^^^has_free_samplebooltrueIf true, free samples are provided to creators invited to the target collaboration.
^^^is_sample_approval_exemptbooltrueIf true, creators invited to the target collaboration are exempt from seller review and will automatically be approved for a free sample.
Note that if has_free_sample=false, this field will not take effect.
^^typestringSTANDARDThe type of target collaboration.
Field values:
  • STANDARD: The target collaboration is created by sellers manually selecting products and creators.
  • TOP_CREATOR_PROGRAM: The target collaboration created by seller joining TikTok Shop Top Creator Program, requiring only product submission. |
#

§9 Response Sample

{"code":0,"data":{"total_count":100,"next_page_token":"b2Zmc2V0PTAK","target_collaborations":[{"id":"789078671231123124","name":"target_collaboration","message":"test","start_time":1715654330,"end_time":1715654330,"create_time":1715654330,"update_time":1715654330,"creator_inivited_count":10,"showcase_creator_count":2,"content_creator_count":1,"product_count":30,"free_sample_rule":{"has_free_sample":true,"is_sample_approval_exempt":true},"type":"STANDARD"}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
#

§10 Error Code

For common error codes, refer to How to call TikTok Shop APIs - Common Error Code

Code Message
#