stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /fbt/202602/inbound_orders/tracking_update
#§2 Method: [POST]
#§3 Function Description
This API manages carton-level tracking information for inbound orders. It utilizes upsert logic to create new tracking records or overwrite existing entries as required. Only orders which are shipped but have not yet been marked as "Delivered" or "Received" yet can be updated, with a 5-time edit limit per carton.
§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 |
|---|---|---|---|---|
| order_id | string | Y | 5766071177167344427 | The numeric identifier of the inbound order to update tracking information for. |
Note: Provide the numeric sequence only; do not include the "IBR" prefix (e.g., use 123456 instead of IBR123456). | ||||
| parcel_tracking_info | []object | N | Carton-level parcel tracking information for the inbound order, including carton number, logistics provider name, and tracking number. | |
| ^provider_name | string | Y | FEDEX | The provider_name field must contain exactly one of the following strings. |
FEDEX(Federal Express)UPS(United Parcel Service)DHL(DHL Express)USPS(United States Postal Service)OTHER(All other logistics providers)
Note: Input must match the uppercase string exactly (e.g., "provider_name": "FEDEX"). |
^tracking_number |string |Y |889042812410 |The tracking number to be associated with this carton. |
^carton_number |string |Y |C0001 |The carton number from inbound order to be associated with this tracking number. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/fbt/202602/inbound_orders/tracking_update?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"order_id":"5766071177167344427","parcel_tracking_info":[{"provider_name":"FEDEX","tracking_number":"889042812410","carton_number":"C0001"}]}
§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 |
§9 Response Sample
{"code":0,"data":{},"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 |
|---|---|
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
| 39001002 | Request or request parameters are empty. Please recheck the input parameters. |
| 39015007 | Access denied. The API requires the seller to be bound to exactly one merchant. |
| 39015009 | SellerId input is invalid |
| 39015010 | No inbound orders found for the merchant. |
| 39015015 | Parcel tracking info list is empty. |
| 39015016 | Tracking provider is invalid or unsupported. |
| 39015017 | Carton number is invalid or missing. |
| 39015018 | Failed to update tracking info for inbound order. Please check that the inbound order is in "Shipped" status and try again. If the issue persists and the cause is unknown, please contact platform support. |
| 39015019 | Tracking number is invalid or missing. |