stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_partner/202508/campaigns/{campaign_id}/products/{product_id}/performance
#§2 Method: [GET]
#§3 Function Description
This API offers the ability to get the product fulfillment status for creators who added partner campaign products to their showcase
§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 |
| category_asset_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | The partner identifier used in API requests. Retrieve this value by using the Get Authorized Category Assets API. |
§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 | 10 | The number of results to be returned per page. Valid range: 1-50. |
| 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. |
§6 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_partner/202508/campaigns/{campaign_id}/products/{product_id}/performance?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&category_asset_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&page_size=10&page_token=b2Zmc2V0PTAK
§7 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_creator_count | int | 1 | The total number of creators involved in the campaign. |
| ^promotion_creators | []object | A list of objects representing information about the Affiliate Creator associated with the product promotion. | |
| ^^paid_amount | object | An object representing the total amount paid for this product. | |
| ^^^currency | string | USD | The currency code for the amount field. |
| ^^^amount | string | 3.00 | The total amount paid for this product. |
| ^^room_count | int | 1 | The number of live broadcast rooms associated with this promotion. |
| ^^video_count | int | 1 | The total number of videos associated with this promotion published by creators. |
| ^^free_sample_status | string | AWAITING_COLLECTION | Status of the Creator's sample application. |
- NOT_REQUESTED
- PENDING
- AWAITING_SHIPMENT
- AWAITING_COLLECTION
- SHIPPED
- CONTENT_PENDING
- REJECT_CANCELLED
- OVERDUE_CANCELLED
- UNFULFIL_CANCELLED
- DEL_PLAN_CANCELLED
- SELLER_NOT_SHIP_CANCELLED
- WITHDRAW_CANCELLED
- UNFULFILLABLE_CANCELLED
- OPERATOR_MANUAL_CANCELLED
- OPERATOR_MANUAL_FAILED
- OPERATOR_MANUAL_COMPLETED
- COMPLETED | ^^commission |string |100 |The commission rate in hundredths of a percent (0.01%). For example, a value of 1000 is 10.00%. | ^^effective_end_time |string |1731020040687 |The effective end time for the collaboration in Unix epoch time format. | ^^effective_start_time |string |1731019880391 |The effective start time for the collaboration in Unix epoch time format. | ^^creator |object | |An object representing information about the creator associated with the promotion. | ^^^nick_name |string |Test_Creator_E |The TikTok nickname of the creator. | ^^^avatar_url |string |https://p19-sign.tiktokcdn-us.com/tos-useast5-avt-0068-tx/c614d3b6ba4d93b31fbda5add0802dd7~c5_1080x1080.webp?lk3s=a5d48078\u0026nonce=6796\u0026refresh_token=634d776ec39c2291053675f60c576515\u0026x-expires=1736478000\u0026x-signature=0G6NmM8H8nDRYYVN7e8QazDMRb0%3D\u0026shp=a5d48078\u0026shcp=9f007bb8 |A URL for the creator's avatar image in the TikTok CDN. | ^^^follower_num |int |19 |The total count of TikTok followers for the creator. | ^^^user_name |string |us_lxq6213 |user name | ^^^creator_open_id |string |uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg |Creator Open ID. More details:https://partner.tiktokshop.com/docv2/page/3obfokj6 | ^^affiliate_product_id |string |123456789 |The affiliate product identifier. | ^next_page_token |string |tk811a4455s2 |Querying next page need this token. |
§8 Response Sample
{"code":0,"data":{"total_creator_count":1,"promotion_creators":[{"paid_amount":{"currency":"USD","amount":"3.00"},"room_count":1,"video_count":1,"free_sample_status":"AWAITING_COLLECTION","commission":"100","effective_end_time":"1731020040687","effective_start_time":"1731019880391","creator":{"nick_name":"Test_Creator_E","avatar_url":"https://p19-sign.tiktokcdn-us.com/tos-useast5-avt-0068-tx/c614d3b6ba4d93b31fbda5add0802dd7~c5_1080x1080.webp?lk3s=a5d48078\\u0026nonce=6796\\u0026refresh_token=634d776ec39c2291053675f60c576515\\u0026x-expires=1736478000\\u0026x-signature=0G6NmM8H8nDRYYVN7e8QazDMRb0%3D\\u0026shp=a5d48078\\u0026shcp=9f007bb8","follower_num":19,"user_name":"us_lxq6213","creator_open_id":"uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg"},"affiliate_product_id":"123456789"}],"next_page_token":"tk811a4455s2"},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§9 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|---|
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |