stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§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_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | 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 | |||||
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Path Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| target_collaboration_id | string | Y | 7890786712312312 | The unique id of specific target collaboration. |
§6 Request Query Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| app_key | string | Y | 38abcd | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign | string | Y | 5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp | int | Y | 1623812664 | Unix 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 |
|---|---|---|---|---|
| name | string | Y | openapi_test | The name of the target collaboration. |
| end_time | string | Y | 1715654330 | The end time of the target collaboration. |
| products | []object | Y | The 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. | ||||
| ^id | string | Y | 789078671231312312 | The product identifier. |
| ^commission_rate | int | Y | 1000 | The 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_rate | int | N | 1000 | The 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×tamp=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 |
|---|---|---|---|
| code | int | 0 | The success or failure status code returned in API response. |
| message | string | Success | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | 202203070749000101890810281E8C70B7 | Request log |
| data | object | Specific return information | |
| ^target_collaboration_conflicts | []object | A list of creators and products with target collaboration conflicts that caused target collaboration update failure. | |
| ^^creator_user_open_id | string | 7494656937121841111 | Creator Open ID. More details:https://partner.tiktokshop.com/docv2/page/3obfokj6 |
| ^^product_id | string | 789078671231 | The product identifier. |
| ^update_failed | object | Describe 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_products | object | The list of products that have not been successfully added. | |
| ^^^id | string | 789078671231312312 | The product identifier. |
| ^^^commission_rate | int | 1000 | The 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_commissions | object | The list of commission information that has not been successfully changed. | |
| ^^^product_id | string | 789078671231312312 | The product identifier. |
| ^^^commission_rate | int | 1000 | The 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_time | int | 1715654330 | The end time of the target collaboration, which has not been successfully updated. |
| ^^seller_contact_info | object | Contact information for the seller in the target collaboration which has not been successfully updated. | |
| string | test@bytedance.com | Seller's email contact information which has not been successfully updated. | |
| ^^^phone_number | string | (+62) 1234567890 | |
| The phone number of the seller. | |||
| string | (+62) 1234567890 | ||
| The phone number used by the seller to register for WhatsApp. | |||
| ^^^telegram | string | (+62) 1234567890 | |
| The seller's Telegram username or phone number. | |||
| ^^^line | string | (+62) 1234567890 | |
| The phone number used by the seller to register for the Line app | |||
| ^^name | string | openapi_test | The 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 |
|---|---|
| 16024004 | test account and non test account can not cross invite |
| 16024006 | The seller cannot invite their official creator. |
| 16024008 | There are products that do not belong to this merchant. |
| 16024016 | The invitation failed because the creator is already linked with a shop account. |
| 16024018 | seller can not invite his block creator |
| 16024019 | in sufficient quota to create invitation |
| 16024020 | remove excluded creators to create invitation |
| 16024021 | invitation contains creator exceed follower limit |
| 36009007 | request timeout |
| 50001701 | target collaboration has expired |
| 50001702 | Your invitation target contains an unavailable creator or product. Please check your request params.Remove the unavailable creator or product id and try again. |
| 50001703 | The request parameters contain sensitive words. |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
| 98001004 | Parameter {param_name} is invalid. Reason: {reason}. Expected: {expected_value} |
