stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_creator/202405/target_collaborations/search
#§2 Method: [POST]
#§3 Function Description
This API is used to search for creator's target collaborations and the products within these target collaborations.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| 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. |
| page_token | string | N | b2Zmc2V0PTAK | An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page. |
| page_size | int | Y | 20 | The number of results to be returned per page. Valid range: [0-100]. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| shop_id | string | Y | 789078671231 | The TikTok Shop identifier. |
| keyword_type | string | N | TARGET_COLLABORATIONS_ID | Target collaborations in the response are restricted to the the expressed type. This is an enumerated wtype with values: |
- TARGET_COLLABORATIONS_ID
- TARGET_COLLABORATIONS_NAME
TARGET_COLLABORATIONS_ID returns target collaborations with state set to LIVE, EXPIRED, DELETED, and ENDED.
TARGET_COLLABORATIONS_NAME returns target collaborations with state set to LIVE only. |
keyword |string |N |12312312 |Target collaborations in the response are restricted to the expressed name. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_creator/202405/target_collaborations/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&page_token=b2Zmc2V0PTAK&page_size=20
Body
{"shop_id":"789078671231","keyword_type":"TARGET_COLLABORATIONS_ID","keyword":"12312312"}
§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 | |
| ^total_count | int | 100 | The total number of target collaboration groups in the response. |
| ^next_page_token | string | b2Zmc2V0PTAK | An opaque token used to retrieve the next page of a paginated result set. |
| ^target_collaborations | []object | A list of target collaboration objects. | |
| ^^id | string | 789078671231123124 | The target collaboration identifier. |
| ^^name | string | target_collaboration | The target collaboration name. |
| ^^status | string | LIVE | The target collaboration state. This is an enumerated type with values: |
- LIVE
- EXPIRED
- DELETED
- ENDED | ^^products |[]object | |A list of products associated with the target collaboration. | ^^^id |string |1729432087292775344 |The product identifier. | ^^^title |string |Blue t-shirt |The product 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 in the TikTok Shop. | ^^^commission |object | |Metadata and data associated with the target collaboration. | ^^^^rate |int |1000 |The commission rate for the target collaboration in hundredths of a percent. For example,
3587is a commission rate of35.87%. | ^^^^amount |string |121.23 |The total amount paid in commission paid for this this product. | ^^^^currency |string |USD |The currency code. |
§9 Response Sample
{"code":0,"data":{"total_count":100,"next_page_token":"b2Zmc2V0PTAK","target_collaborations":[{"id":"789078671231123124","name":"target_collaboration","status":"LIVE","products":[{"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","commission":{"rate":1000,"amount":"121.23","currency":"USD"}}]}]},"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 |
|---|