stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_partner/202508/campaigns/{campaign_id}/products/{product_id}/creator/{creator_temp_id}/content/statistics/sample/status
#§2 Method: [GET]
#§3 Function Description
Get progress on creator's sample status
§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 Path Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| campaign_id | string | Y | 123 | The campaign identifier. |
| product_id | string | Y | 123 | The product identifier. |
| creator_temp_id | string | Y | uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg | Creator Open ID. More details |
§6 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. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_partner/202508/campaigns/123/products/123/creator/uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg/content/statistics/sample/status?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&category_asset_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
§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 | |
| ^sample_status | object | The creator's sample status | |
| ^^shipping_provider_name | string | USPS | The name of the shipping provider |
| ^^delivery_option | string | PREMIUM_SHIPPING | The delivery option: |
- ECONOMY_SHIPPING
- PREMIUM_SHIPPING | ^^estimated_earliest_delivery_date |string |1712941200 |The earliest estimated delivery date in Unix epoch format. | ^^estimated_latest_delivery_date |string |1712941200 |The longest estimated delivery date in Unix epoch format. | ^^quantity |int |1 |The quantity of products delivered. | ^^tracking_results |[]object | |A list of objects representing tracking events. | ^^^tracking_event_update_date |string |1712941200 |The date at which the tracking event was last updated, in Unix epoch format. | ^^^tracking_event_description |string |THE_PACKAGE_HAS_BEEN_DELIVERED |The title of the tracking event.
- THE_PACKAGE_HAS_BEEN_DELIVERED
- OUT_FOR_DELIVERY
- ORDER_PACKED_AND_READY_FOR_DROP_OFF_AT_CARRIERS_FACILITY
- ORDER_PLACED | ^^^tracking_event_description_extended |string |delivering | More information about the tracking event |
§9 Response Sample
{"code":0,"data":{"sample_status":{"shipping_provider_name":"USPS","delivery_option":"PREMIUM_SHIPPING","estimated_earliest_delivery_date":"1712941200","estimated_latest_delivery_date":"1712941200","quantity":1,"tracking_results":[{"tracking_event_update_date":"1712941200","tracking_event_description":"THE_PACKAGE_HAS_BEEN_DELIVERED","tracking_event_description_extended":"delivering"}]}},"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 |
|---|---|
| 16032001 | nvalid parameter Creator and Seller, please ensure Region mismatch. |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |