stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /supply_chain/202309/packages/sync
#§2 Method: [POST]
#§3 Function Description
This API enables a warehouse service provider to send package shipment information for an order. Only warehouse service providers who have been certified by the platform have permission to access this interface.
§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. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| warehouse_provider_id | string | Y | 7342984797904049750 | Warehouse provider ID, unique and provided by TikTok |
| packages | []object | Y | Package info list | |
| ^id | string | Y | 28427944530283 | Package ID |
| ^wms_order_id | string | Y | 324246554745 | Warehouse Management System order number |
| ^provider_warehouse_code | string | N | 7475973290484254255 | Warehouse code |
| ^shipping_origin_city | string | N | CityA | Origin city name for the shipment |
| ^time_zone | string | Y | UTC+8 | The warehouse time zone |
| ^ship_time_millis | int | Y | 1694176625765 | Time when the order is shipped out of the warehouse (Unix timestamp in milliseconds) |
| ^create_time_millis | int | Y | 1694176625765 | Time when warehouse receives the order (Unix timestamp in milliseconds) |
| ^handover_time_millis | int | Y | 1694176625765 | Time when the order is handed over to the shipping provider (Unix timestamp in milliseconds) |
| ^shipping_provider_id | string | Y | 2435653524354624 | Shipping service provider ID |
| ^shipping_provider_name | string | Y | ProviderA | Shipping service provider name |
| ^tracking_number | string | Y | WB53452356 | Tracking number |
| ^dimension | object | Y | Package dimension information | |
| ^^length | int | N | 34 | Package length value |
| ^^width | int | N | 425 | Package width value |
| ^^height | int | N | 42 | Package height value |
| ^^unit | string | N | METER | Package dimension unit |
| Possible values: |
- METER
- CENTIMETER
- MILLIMETER
- MICRON
- FOOT
- INCH | ^weight |object |N | |Package weight information | ^^value |int |N |342 |Package weight value | ^^unit |string |N |KILOGRAM |Package weight unit Possible values:
- KILOGRAM
- GRAM
- MILLIGRAM
- POUND
- OUNCE | ^skus |[]object |Y | |List of order SKUs | ^^id |string |Y |4235346547 |TikTok Shop SKU ID | ^^quantity |int |Y |13 |The quantity of each SKU | ^provider_warehouse_name |string |N |Central Warehouse |Warehouse name | ^tcw_warehouse_type |string |N |STANDARD |TikTok warehouse type Possible values:
- STANDARD: Standard warehouse that has not been specifically certified by TikTok
- TIKTOK_CERTIFIED_WAREHOUSE_FULFILLMENT: TikTok certified warehouse usually offering better service levels. Certified warehouses are required to meet fulfillment timeline standards set by TikTok |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/supply_chain/202309/packages/sync?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268
Body
{"warehouse_provider_id":"7342984797904049750","packages":[{"id":"28427944530283","wms_order_id":"324246554745","provider_warehouse_code":"7475973290484254255","shipping_origin_city":"CityA","time_zone":"UTC+8","ship_time_millis":1694176625765,"create_time_millis":1694176625765,"handover_time_millis":1694176625765,"shipping_provider_id":"2435653524354624","shipping_provider_name":"ProviderA","tracking_number":"WB53452356","dimension":{"length":34,"width":425,"height":42,"unit":"METER"},"weight":{"value":342,"unit":"KILOGRAM"},"skus":[{"id":"4235346547","quantity":13}],"provider_warehouse_name":"Central Warehouse","tcw_warehouse_type":"STANDARD"}]}
§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 | |
| ^success_packages | []string | ["5345241234","42365346"] | List of packages that have been successfully confirmed |
| ^errors | []object | Error list | |
| ^^code | string | 39003015 | Error code |
| ^^message | string | Provider is not supported by TikTok Shop | Error message |
| ^^detail | object | Failed package details | |
| ^^^package_id | string | 4645645645 | Failed package ID |
§9 Response Sample
{"code":0,"data":{"success_packages":["5345241234","42365346"],"errors":[{"code":"39003015","message":"Provider is not supported by TikTok Shop","detail":{"package_id":"4645645645"}}]},"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 |
|---|---|
| 39003015 | provider is not in package information send-back white list |
| 39003016 | package param invalid, please check detail fail reason |
| 39003017 | save warehouse package info err |
| 39003018 | the package list is empty in the request |
| 39003019 | warehouse provider id is invalid |
| 39003020 | the provider id in your request is not match your app_key |