Use this API to ship orders (purchase labels). This API is available in the US, UK, EMEA, and JP regions. The shipping fee and delivery time is an estimate only and is based on the package dimensions and weight you provided.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Identifies the shop. Obtain it from the Get Authorized Shops API.
Request Bodyrequired
Section titled “Request Bodyrequired”object
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.
The TikTok Shop order ID. Required when ship_type is 1 or 2; not used when ship_type is 3.
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
object
The TikTok Shop order line item ID.
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
The TikTok Shop order IDs to combine into one package. Required when ship_type is 3; provide at least two order IDs.
Package dimensions. For ship_type 1 and 2, each dimension must be between 0.01 and 999999 and have no more than two decimal places.
object
Package length.
The length, width, and height must be passed together.
Package width.
The length, width, and height must be passed together.
Package height.
The length, width, and height must be passed together.
The unit of measurement for the package dimensions. For packages in the US, use INCH.
Available values:
CMINCH
Specify the shipping service used. If not specified, use the default service obtained from Get Eligible Shipping Service.
Package weight. For ship_type 1 and 2, the value must be between 0.01 and 999999 and have no more than two decimal places.
object
The numerical value of the package weight.
The unit of measurement for the package weight.
Available values:
GRAMPOUND
Example
{ "ship_type": "2", "order_id": "2882335594258860015", "order_line_item": [ { "order_line_id": "2882335594258860015", "sub_item_id": "2882335594258860015" } ], "order_list_ids": [ "2882335594258860015", "2882335594258860016" ], "dimension": { "length": "1.2", "width": "0.2", "height": "0.03", "unit": "CM" }, "shipping_service_id": "288233559123860015", "weight": { "value": "1.2", "unit": "GRAM" }}Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
Package dimensions.
object
Package length.
Package width.
Package height.
The unit of measurement for the package dimensions.
Available values:
CMINCH
Information about the shipping service selected for the package.
object
Shipping service ID.
Shipping service name.
Estimated price for this service.
Currency of the price.
The minimum estimated duration required for package delivery.US only.
The maximum estimated duration required for package delivery.US only.
Shipping provider ID.US only.
Shipping provider name.US only.
Package ID.
Package weight.
object
The numerical value of the package weight.
The unit of measurement for the package weight.
Available values:
GRAMPOUND
The time when the product was created. Unix timestamp.
Example
{ "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": "USD", "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"}