stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_seller/202412/open_collaborations
#§2 Method: [POST]
#§3 Function Description
This API allows the seller to create an open collaboration. You create an open collaboration by selecting products and setting a commission rate.
§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 |
|---|---|---|---|---|
| product_id | string | Y | 789078671231 | The product ID for adding to the affiliate open collaboration. |
| commission_rate | int | Y | 1000 | The desired commission rate for the open 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. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_seller/202412/open_collaborations?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"product_id":"789078671231","commission_rate":1000}
§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 | |
| ^open_collaboration | object | The open collaboration. | |
| ^^id | string | 7365861555575916210 | The open collaboration identifier. |
| ^^product_id | string | 789078671231 | The product identifier. |
| ^^effective_time | int | 1715654330 | The effective time of the open collaboration in Unix epoch time format. |
§9 Response Sample
{"code":0,"data":{"open_collaboration":{"id":"7365861555575916210","product_id":"789078671231","effective_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 |
|---|---|
| 16003012 | An open collaboration containing this product already exists. |
| 16003025 | The seller's account is deactivated. |
| 16003033 | The commission rate must be between 1% and 80%. |
| 16003035 | One or more of the products you are trying to add are currently restricted by the platform. |
| 16603010 | The seller is currently restricted by the platform. |