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

Search Open Collaboration

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/202412/open_collaborations/search

#

§2 Method: [POST]

#

§3 Function Description

Retrieve all open collaboration information from merchants, including commission rate, add to showcase and post content creator count.


#

§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_tokenstringNb2Zmc2V0PTAKPagination offset determines where you begin to search for. It's empty when you raise your first request.
page_sizeintY50The value of "page_size" must be greater than 0 and less than or equal to 100.
sort_orderstringNDESCDefault value of "sort_order" is DESC.
Enum:
  • ASC:means to sort data in ascending order
  • DESC:means to sort data in descending order | sort_field |string |N |product_original_price |Some sorting fields are as follows:
  • product_original_price: sort by products' original price. By default, the open collaborations are sorted in descending order by creation time. |
#

§6 Request Body Parameters

Properties Type Require Sample Properties description
keyword_typestringNPRODUCT_IDPass in the parameter type which you use to query open collaborations.
You can query based on:
  • PRODUCT_ID:If you use PRODUCT_ID to search, you can search for open collaboration information for a specified product ID.
  • PRODUCT_NAME: If you use PRODUCT_NAME to search, you can fuzzy search for open collaboration information involving related product names. | keyword |string |N |7625459350921 |Search based on the product name or product ID. Pass in the appropriate value based on the keyword_type above. | top_level_category_id |string |N |60001 |The category of the searched product needs to be limited in this param. Prerequisites:
  • The value of field category_id must be greater than 0.
  • Currently, it only supports first-level categories |
#

§7 Request Sample

Query

https://open-api.tiktokglobalshop.com/affiliate_seller/202412/open_collaborations/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&page_token=b2Zmc2V0PTAK&page_size=50&sort_order=DESC&sort_field=product_original_price

Body

{"keyword_type":"PRODUCT_ID","keyword":"7625459350921","top_level_category_id":"60001"}
#

§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
^next_page_tokenstringb2Zmc2V0PTEwNext page token
^total_countint10000Total count of products that satisfy all the input search conditions.
^open_collaborations[]objectThe open collaborations
^^idstring94297006405The open collaboration id
^^statusstringNORMALStatus of open collaboration.
Field values:
  • NORMAL:NORMAL means the current open collaboration status is normal and in effect.
  • TERMINATING: TERMINATING means that the merchant has removed open collaboration and the open collaboration will expire soon. The expiration time can be found at the end_time of current_commission. The open collaborations which were removed and expired will not be returned in the response. | ^^current_commission |object | |The commission information is currently in effect for this open collaboration. | ^^^rate |int |3000 |The commission rate for this product is set by merchants for creators' public promotion. The range of this value is [100, 8000]. This value is expressed in 1/10000 increments. For example: 3000 means the actual commission rate is 30.00%, and 3555 means 35.55% | ^^^start_time |int |1725334422 |The time when the commission rate becomes effective. | ^^^end_time |int |1727625600 |The effective end time of the commission rate. | ^^showcase_creator_count |int |15 |This field indicates the number of creators who added the product to the showcase from open collaboration. | ^^content_creator_count |int |10 |This field indicates the number of creators who posted the LIve or Video from open collaboration. | ^^product |object | |The open collaboration bound product information. | ^^^id |string |1729432087292775344 |Product's unique id. | ^^^title |string |Blue t-shirt |Product's name. | ^^^main_image_url |string |https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/fa0387fa5a204dcfa44d5be75877a163~tplv-o3syd03w52-origin-webp.webp?from=3478900499 |The product image url. | ^^^status |string |LIVE |Product's status. Field values:
  • LIVE: When the product is normal for sale, return to the LIVE status
  • OUT_OF_STOCK: When the product is out of stock for the consumer, the OUT_OF_STOCK state is returned
  • SELLER_DEACTIVATE: When the product is deactivated by the merchant, the SELLER_DEACTIVATE status is returned
  • PLATFORM_DEACTIVATE: When the product is deactivated by the platform or is not available for sale, the PLATFORM_DEACTIVATE status is returned
  • GNE_REJECT: When the product is governed or the open collaboration is dismissed, the GNE_REJECT state is returned
  • DELETE: When the product is deleted, the DELETE status is returned
  • OTHER: When the product is in an unsaleable state, such as draft, frozen, review, etc, the OTHER status is returned | ^^^inventory |int |1274 |The inventory of this product. | ^^^original_price |object | |The product's original price | ^^^^currency |string |USD |Currency Symbol | ^^^^minimum_amount |string |12.21 |The minimum original price of all skus of this product. | ^^^^maximum_amount |string |100.00 |The maximum original price of all skus of this product. |
#

§9 Response Sample

{"code":0,"data":{"next_page_token":"b2Zmc2V0PTEw","total_count":10000,"open_collaborations":[{"id":"94297006405","status":"NORMAL","current_commission":{"rate":3000,"start_time":1725334422,"end_time":1727625600},"showcase_creator_count":15,"content_creator_count":10,"product":{"id":"1729432087292775344","title":"Blue t-shirt","main_image_url":"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/fa0387fa5a204dcfa44d5be75877a163~tplv-o3syd03w52-origin-webp.webp?from=3478900499","status":"LIVE","inventory":1274,"original_price":{"currency":"USD","minimum_amount":"12.21","maximum_amount":"100.00"}}}]},"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
#