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

Update Target 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/202508/target_collaborations/{target_collaboration_id}

#

§2 Method: [PUT]

#

§3 Function Description

This API is used by Seller to update STANDARD target collaboration.


#

§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 Path Parameters

Properties Type Require Sample Properties description
target_collaboration_idstringY7890786712312312The unique id of specific target collaboration.
#

§6 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.
#

§7 Request Body Parameters

Properties Type Require Sample Properties description
namestringYopenapi_testThe name of the target collaboration.
end_timestringY1715654330The end time of the target collaboration.
products[]objectYThe information about the products provided by the seller for target collaboration with creators in the target collaboration.
The maximum number of products is 100.
When a product is deleted from the product list, if the deleted product has been added to the showcase by the creator, it will take effect at 0:00 the next day, otherwise it will take effect immediately.
^idstringY789078671231312312The product identifier.
^commission_rateintY1000The desired commission rate for the target collaboration. The value is measured in ten thousandths. For example, 3587 means the commission fee equals 35.87% of the original price. The range is [100, 8000].
Increasing product commissions will take effect immediately, while reducing product commissions will take effect at 00:00 the next day if the current product has been added to the showcase by a creator, otherwise it will take effect immediately.
^target_ad_commission_rateintN1000The commission rate applies only to orders generated from ads. If a creator’s video is used as an ad without this rate being set, the resulting orders will instead earn either:
  • The Shop Ads commission you configured in open collaboration, or
  • The standard commission defined in this invitation. The commission rate is specified in increments of 1/10,000. For example, 1000 stands for 0.1 or 10%. | creator_user_open_ids |[]string |Y |["123123213213"] |The list of Creators' TikTok User Open IDs invited in the target collaboration. The maximum number of creators is 50. More details | seller_contact_info |object |Y | |Contact information for the seller in the target collaboration. | ^email |string |Y |test@bytedance.com |Seller's email contact information | ^phone_number |string |N |1234567890 |The phone number of the seller. | ^whatsapp |string |N |1234567890 |The phone number used by the seller to register for WhatsApp. | ^telegram |string |N |1234567890 |The seller's Telegram username or phone number. | ^line |string |N |1234567890 |The phone number used by the seller to register for the Line app | free_sample_rule |object |Y | |The free sample rules set by the seller in the target collaboration. | ^has_free_sample |bool |Y |true |If true, free samples are provided to creators invited to the target collaboration. | ^is_sample_approval_exempt |bool |Y |true |If 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. |
#

§8 Request Sample

Query

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

Body

{"name":"openapi_test","end_time":"1715654330","products":[{"id":"789078671231312312","commission_rate":1000,"target_ad_commission_rate":1000}],"creator_user_open_ids":["123123213213"],"seller_contact_info":{"email":"test@bytedance.com","phone_number":"1234567890","whatsapp":"1234567890","telegram":"1234567890","line":"1234567890"},"free_sample_rule":{"has_free_sample":true,"is_sample_approval_exempt":true}}
#

§9 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
^target_collaboration_conflicts[]objectA list of creators and products with target collaboration conflicts that caused target collaboration update failure.
^^creator_user_open_idstring7494656937121841111Creator Open ID. More details:https://partner.tiktokshop.com/docv2/page/3obfokj6
^^product_idstring789078671231The product identifier.
^update_failedobjectDescribe which fields were not updated successfully.
^^remove_creator_open_ids[]string["12345"]The list of creators' TikTok User Open IDs that have not been successfully removed. More details:https://partner.tiktokshop.com/docv2/page/3obfokj6
^^remove_product_ids[]string["12345"]The list of product ids that have not been successfully removed.
^^add_creator_open_ids[]string["12345"]The list of creators' TikTok User Open IDs that have not been successfully added. More details:https://partner.tiktokshop.com/docv2/page/3obfokj6
^^add_productsobjectThe list of products that have not been successfully added.
^^^idstring789078671231312312The product identifier.
^^^commission_rateint1000The desired commission rate for the target collaboration. The desired commission rate is expressed in hundredths of a percent. For example, 3587 is a commission rate of 35.87%. This value must be a minimum of 1000.
^^change_commissionsobjectThe list of commission information that has not been successfully changed.
^^^product_idstring789078671231312312The product identifier.
^^^commission_rateint1000The desired commission rate for the target collaboration. The desired commission rate is expressed in hundredths of a percent. For example, 3587 is a commission rate of 35.87%. This value must be a minimum of 1000.
^^end_timeint1715654330The end time of the target collaboration, which has not been successfully updated.
^^seller_contact_infoobjectContact information for the seller in the target collaboration which has not been successfully updated.
^^^emailstringtest@bytedance.comSeller's email contact information which has not been successfully updated.
^^^phone_numberstring(+62) 1234567890
The phone number of the seller.
^^^whatsappstring(+62) 1234567890
The phone number used by the seller to register for WhatsApp.
^^^telegramstring(+62) 1234567890
The seller's Telegram username or phone number.
^^^linestring(+62) 1234567890
The phone number used by the seller to register for the Line app
^^namestringopenapi_testThe name of the target collaboration.
^^invalid_product_id_list[]string["1234"]The list of product id that caused the update to fail.
^^invalid_open_id_list[]string["xxxxxx"]The list of open id that caused the update to fail.
#

§10 Response Sample

{"code":0,"data":{"target_collaboration_conflicts":[{"creator_user_open_id":"7494656937121841111","product_id":"789078671231"}],"update_failed":{"remove_creator_open_ids":["12345"],"remove_product_ids":["12345"],"add_creator_open_ids":["12345"],"add_products":{"id":"789078671231312312","commission_rate":1000},"change_commissions":{"product_id":"789078671231312312","commission_rate":1000},"end_time":1715654330,"seller_contact_info":{"email":"test@bytedance.com","phone_number":"(+62) 1234567890\n","whatsapp":"(+62) 1234567890\n","telegram":"(+62) 1234567890\n","line":"(+62) 1234567890\n"},"name":"openapi_test","invalid_product_id_list":["1234"],"invalid_open_id_list":["xxxxxx"]}},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
#

§11 Error Code

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

Code Message
16024004test account and non test account can not cross invite
16024006The seller cannot invite their official creator.
16024008There are products that do not belong to this merchant.
16024016The invitation failed because the creator is already linked with a shop account.
16024018seller can not invite his block creator
16024019in sufficient quota to create invitation
16024020remove excluded creators to create invitation
16024021invitation contains creator exceed follower limit
36009007request timeout
50001701target collaboration has expired
50001702Your invitation target contains an unavailable creator or product. Please check your request params.Remove the unavailable creator or product id and try again.
50001703The request parameters contain sensitive words.
36009003Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support.
98001004Parameter {param_name} is invalid. Reason: {reason}. Expected: {expected_value}
#