stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_seller/202508/target_collaborations
#§2 Method: [POST]
#§3 Function Description
This API is used to create a target collaboration. A target collaboration is a collaboration between a seller selected set of products (including a commission payout) and a set of creators the seller has added (invited) to the collaboration. Target collaborations are private and not visible in the Creator Marketplace to all creators; they are only visible to those that have been added to the 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 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. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| name | string | Y | openapi_test | The name of the target collaboration. |
| message | string | N | this is a message | The message sent to creators associated with the target collaboration. |
| end_time | string | Y | 1715654330 | The date at which the target collaboration ends, in Unix epoch time. |
| products | []object | Y | A list of metadata and data for the products provided by the seller for target collaboration. Maximum length of the list is 100 products. | |
| ^id | string | Y | 789078671231312312 | The product identifier. |
| ^target_commission_rate | int | Y | 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 a minimum of 100. |
| ^shop_ads_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 |["uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg"] | Maximum length of the list is
50user open identifiers. Creator Open ID. More details | seller_contact_info |object |Y | |Metadata and data associated with the seller contact information. | ^email |string |N |test@tiktokshop.com |The seller's email address. | ^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 | |A set of properties that control the free sample behavior for the product. | ^has_free_sample |bool |Y |true |If set totrue, free samples are provided to creators invited to the target collaboration group. If set tofalse, free samples are not provided. | ^is_sample_approval_exempt |bool |Y |true |If set totrue, creators invited to the target collaboration are exempt from seller review and are automatically approved for a free product sample. Note that thehas_free_sampleproperty overrides the free sample behavior. | preferred_content_type |string |N |LIVE |preferred creator content type, "LIVE" or "VIDEO" |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_seller/202508/target_collaborations?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"name":"openapi_test","message":"this is a message","end_time":"1715654330","products":[{"id":"789078671231312312","target_commission_rate":1000,"shop_ads_commission_rate":1000}],"creator_user_open_ids":["uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg"],"seller_contact_info":{"email":"test@tiktokshop.com","phone_number":"1234567890","whatsapp":"1234567890","telegram":"1234567890","line":"1234567890"},"free_sample_rule":{"has_free_sample":true,"is_sample_approval_exempt":true},"preferred_content_type":"LIVE"}
§8 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 | object | The target collaboration. | |
| ^^id | string | 7365861555575916210 | The target collaboration identifier. |
| ^target_collaboration_conflicts | []object | A list of user and product identifiers with target collaboration conflicts that caused target collaboration failure. | |
| ^^creator_user_open_id | string | uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg | Creator Open ID. More details |
| ^^product_id | string | 789078671231 | The product identifier. |
| ^invalid_open_id_list | []string | ["xxxx"] | The list of open id that caused the create to fail. |
| ^invalid_product_id_list | []string | ["1234"] | The list of product id that caused the create to fail. |
| ^create_time | int | 1715654330 | The create time of the target collaboration. |
§9 Response Sample
{"code":0,"data":{"target_collaboration":{"id":"7365861555575916210"},"target_collaboration_conflicts":[{"creator_user_open_id":"uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg","product_id":"789078671231"}],"invalid_open_id_list":["xxxx"],"invalid_product_id_list":["1234"],"create_time":1715654330},"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 |
|---|---|
| 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. |
| 16024019 | in sufficient quota to create invitation |
| 16024020 | remove excluded creators to create invitation |
| 16024021 | invitation contains creator exceed follower limit |
| 16024022 | This invitation has exist creator and product, please check conflict pair. |
| 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} |
