stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /fulfillment/202512/packages
#§2 Method: [POST]
#§3 Function Description
Use this API to ship orders (purchase labels). This API is region specific to the US and JP. The shipping fee and delivery time is an estimate only and is based on the package dimensions and weight you provided. Based on the package attributes, options listed below may differ from your shipping subscriptions.
§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 |
|---|---|---|---|---|
| ship_type | string | Y | 2 | 1:All the products in one order are shipped in one package with one tracking number |
| 2:Partical products in one parent order are shipped in multiple packages with multiple tracking numbers | ||||
| 3:All the products in multiple orders are shipped in one package with one tracking number. | ||||
| order_id | string | N | 2882335594258860015 | TikTok Shop order ID. |
| If ship_type=0&1,This is a required field;If ship_type=2,we will not use | ||||
| order_line_item | []object | N | List of order line item IDs. | |
| If ship_type=2,This is a required field;If ship_type=1&3,we will not use this field | ||||
| ^order_line_id | string | N | 2882335594258860015 | List of order line item IDs. |
| If ship_type=2,This is a required field;If ship_type=1&3,we will not use this field | ||||
| ^sub_item_id | string | N | 2882335594258860015 | Only for virtual bundle items,list of sub item ids. |
| If ship_type=2,This is a required field;If ship_type=1&3,we will not use this field | ||||
| order_list_ids | []string | N | [" "] | List of order line item IDs. |
| If ship_type=3,This is a required field;If ship_type=1&2,we will not use this field | ||||
| dimension | object | N | Package dimensions. | |
| ^length | string | Y | 1.2 | Package length. |
| The length, width, and height must be passed together. | ||||
| ^width | string | Y | 0.2 | Package width. |
| The length, width, and height must be passed together. | ||||
| ^height | string | Y | 0.03 | Package height. |
| The length, width, and height must be passed together. | ||||
| ^unit | string | Y | CM | The unit of measurement for the package dimensions. |
Available values:
CMINCH| shipping_service_id |string |N |288233559123860015 |Specify the shipping service used. If not specified, use the default service obtained from Get Eligible Shipping Service. | weight |object |N | |Package weight. | ^value |string |Y |1.2 |The numerical value of the package weight. | ^unit |string |Y |GRAM |The unit of measurement for the package weight.
Available values:
GRAMPOUND|
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/fulfillment/202512/packages?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"ship_type":"2","order_id":"2882335594258860015","order_line_item":[{"order_line_id":"2882335594258860015","sub_item_id":"2882335594258860015"}],"order_list_ids":[" "],"dimension":{"length":"1.2","width":"0.2","height":"0.03","unit":"CM"},"shipping_service_id":"288233559123860015","weight":{"value":"1.2","unit":"GRAM"}}
§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 | |
| ^dimension | object | Package dimensions. | |
| ^^length | string | 1.2 | Package length. |
| ^^width | string | 0.2 | Package width. |
| ^^height | string | 0.03 | Package height. |
| ^^unit | string | CM | The unit of measurement for the package dimensions. |
Available values:
CMINCH| ^shipping_service_info |object | |The available shipping service's information. | ^^id |string |288233559123860015 |Shipping service ID. | ^^name |string |UPS-first class |Shipping service name. | ^^price |string |10 |Estimated price for this service. | ^^currency |string |dollar |Currency of the price. | ^^earliest_delivery_days |int |3 |The minimum estimated duration required for package delivery.US only. | ^^latest_delivery_days |int |5 |The maximum estimated duration required for package delivery.US only. | ^^shipping_provider_id |string |2882322591238 |Shipping provider ID.US only. | ^^shipping_provider_name |string |UPS |Shipping provider name.US only. | ^package_id |string |2882335594258860015 |Package ID. | ^weight |object | |Package weight. | ^^value |string |1.2 |The numerical value of the package weight. | ^^unit |string |GRAM |The unit of measurement for the package weight.
Available values:
GRAMPOUND| ^create_time |int |1623812664 |The time when the product was created. Unix timestamp. |
§9 Response Sample
{"code":0,"data":{"dimension":{"length":"1.2","width":"0.2","height":"0.03","unit":"CM"},"shipping_service_info":{"id":"288233559123860015","name":"UPS-first class","price":"10","currency":"dollar","earliest_delivery_days":3,"latest_delivery_days":5,"shipping_provider_id":"2882322591238","shipping_provider_name":"UPS"},"package_id":"2882335594258860015","weight":{"value":"1.2","unit":"GRAM"},"create_time":1623812664},"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. |
| 11001002 | invalid param. |
| 11001027 | System timeout. If this error persists, please contact the platform for assistance. |
| 11003011 | Shipping service operation conflict error, please double check the shipping service ID. |
| 11021009 | No available shipping services for this request. Please modify the package weight or check the recipient address. If the error persists, please contact the platform for assistance. |
| 11021012 | illegal address |
| 11021014 | product oversize |
| 11028006 | This tracking number cannot be matched to any carrier, please check the tracking number and upload again. |
| 11050001 | invalid param |
| 21001001 | Invalid parameters. Please ensure you are passing the correct request parameter(s). |
| 21001011 | System process error, please try again later. |
| 21004008 | create label shipping service not found |
| 21004010 | Your country does not support the use of this feature. |
| 21008025 | Seller cannot operate orders which are fulfilled by platform |
| 21008042 | seller already print shipping label |
| 21008106 | This interface cannot be used in this region. |
| 21011001 | Package not found. If the error persists, please contact the platform for assistance. |
| 21011003 | fulfill_unit action not allowed |
| 21011006 | These orders are already shipped. |
| 21011007 | Package item has after-sale request, please process the after-sale request first. |
| 21011012 | not match trade rule |
| 21011020 | These orders are already shipped. |
| 21011029 | order does not belong to fulfill unit |
| 21011033 | order already combined |
| 21011035 | split order not allowed |
| 21011037 | There are no available shipping services for this request. Please modify the package weight, or double check the recipient address. If after multiple retries you continue to experience this error, please contact the platform for assistance. |
| 21011046 | Order has combine, not allow split order |
| 21011048 | There are multiple packages that can be shipped, please specify the order line that needs to be shipped. |
| 21022025 | A shipping label has already been purchased. |
| 21022026 | Cannot purchase shipping label, please try again later. |
| 21022029 | System process error, please try again later. |
| 21030005 | Processing create_label_status not allow to operate this action |
| 21030006 | Shipping label purchase successful. This operation is not allowed in the current order status. |
| 21032001 | fulfill unit status not allow to update pkg attr |