stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_seller/202508/target_collaborations/search
#§2 Method: [POST]
#§3 Function Description
This API is used by Seller to search for all existing target collaborations. Sellers can search based on filters such as Invitation name, Invitation ID, Product name, Product ID and Creator name.
§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. |
| page_size | int | N | 20 | The value of "page_size" must be 20, 50 or 100. |
| page_token | string | N | b2Zmc2V0PTAK | Pagination offset determines where you begin to search for. It's empty when raise your first request. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| creator_accept_status | string | N | ACCEPT | Filtering by acceptance status of creators who are invited to target collaborations. |
| You can query based on: |
- "ACCEPT", it means creators have already added the products to the showcase
- "ALL""", it means regardless of whether the creator adds the product to the Showcase. By default, the target collaborations will be searched by "ALL" status. | free_sample_setting |string |N |WITH_FREE_SAMPLE |Filtering by target collaborations' free sample setting. You can query based on:
- "WITH_FREE_SAMPLE"
- "ALL" By default, the target collaborations will be searched by "ALL" setting. | search_param |object |N | |The search param. | ^keyword_type |string |Y |TARGET_COLLABORATION_NAME |Pass in the parameter type which you use to search for target collaborations. You can query based on:
- PRODUCT_ID:If you use PRODUCT_ID to search, you can search for target collaboration information for a specified product ID.
- PRODUCT_NAME: If you use PRODUCT_NAME to search, you can fuzzy search for target collaboration information involving related product names.
- TARGET_COLLABORATION_ID: if you use Target_Collaboration_ID to search, you can search for target collaboration information for a specified target collaboration ID.
- TARGET_COLLABORATION_NAME: If you use Target_Collaboration_NAME to search, you can fuzzy search for target collaboration information involving related target collaboration names. | ^keyword |string |Y |test |Search Keyword. | creator_user_open_id |string |N |uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg |Creators' TikTok User Open ID.More details
- CREATOR_OPEN_ID: If you use CREATOR_OPEN_ID to search, you can search for target collaboration information for a specified creator ID. | collaboration_status |string |Y |ONGOING |Filtering by target collaborations' status. You can query based on:
- ONGOING: If you use ONGOING to search, the remaining validity period of the returned target collaborations will be greater than 7 days.
- EXPIRING: If you use EXPIRING to search, the remaining validity period of the returned target collaborations will be less than 7 days.
- VALID: If you use VALID to search, all returned target collaborations will be valid.
- CANCELING: If you use CANCELING to search, all returned target collaborations will be in the process of canceling.
- COMPLETED: If you use COMPLETED to search, all returned target collaborations will be in the state of completed, including expired and canceled. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_seller/202508/target_collaborations/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&page_size=20&page_token=b2Zmc2V0PTAK
Body
{"creator_accept_status":"ACCEPT","free_sample_setting":"WITH_FREE_SAMPLE","search_param":{"keyword_type":"TARGET_COLLABORATION_NAME","keyword":"test"},"creator_user_open_id":"uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg","collaboration_status":"ONGOING"}
§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 count of target collaboration returned by this query. |
| ^next_page_token | string | b2Zmc2V0PTAK | Cursor for the next page request. |
| ^target_collaborations | []object | The basic information of target collaboration which creators can view in Targeted Invitation on TikTok EC Center. | |
| ^^id | string | 789078671231123124 | Target collaboration ID. |
| ^^name | string | target_collaboration | Target collaboration name. |
| ^^message | string | test | Message seller has sent to creators about seller's introduction and why excited to collaborate. |
| ^^start_time | int | 1715654330 | The start time of the target collaboration. |
| ^^end_time | int | 1715654330 | The end time of the target collaboration. |
| ^^create_time | int | 1715654330 | The create time of the target collaboration. |
| ^^update_time | int | 1715654330 | The update time of the target collaboration. |
| ^^creator_inivited_count | int | 10 | The count of creators invited in the target collaboration. |
| ^^showcase_creator_count | int | 2 | This field indicates the number of creators who added the product to the showcase from target collaboration. |
| ^^content_creator_count | int | 1 | The number of creators who posted content featuring products from target collaboration. |
| ^^product_count | int | 30 | The count of products added in the target collaboration. |
| ^^free_sample_rule | object | The free sample rules set by the seller in the target collaboration. | |
| ^^^has_free_sample | bool | true | If true, free samples are provided to creators invited to the target collaboration. |
| ^^^is_sample_approval_exempt | bool | 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. | |||
| ^^type | string | STANDARD | The type of target collaboration. |
| Field values: |
- STANDARD: The target collaboration is created by sellers manually selecting products and creators.
- TOP_CREATOR_PROGRAM: The target collaboration created by seller joining TikTok Shop Top Creator Program, requiring only product submission. |
§9 Response Sample
{"code":0,"data":{"total_count":100,"next_page_token":"b2Zmc2V0PTAK","target_collaborations":[{"id":"789078671231123124","name":"target_collaboration","message":"test","start_time":1715654330,"end_time":1715654330,"create_time":1715654330,"update_time":1715654330,"creator_inivited_count":10,"showcase_creator_count":2,"content_creator_count":1,"product_count":30,"free_sample_rule":{"has_free_sample":true,"is_sample_approval_exempt":true},"type":"STANDARD"}]},"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 |
|---|
