If you send multiple packages to TikTok Shop warehouse in a single first-mile bundle, you can use the API to create a first-mile bundle on TikTok Shop and get the bundle ID.
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
The IDs of all the orders sent in a single first-mile bundle. Maximum: 9,999 order IDs per request. The orders must follow the restrictions:
- Each of the orders must exist and be RTS and shipping label printed.
- The orders are sent by the same seller.
- The orders belong to a single group of TikTok Shop service districts. The groups are:
- Group 1: PH, SG, MY, VN, TH, and JP.
- Group 2: DE, FR, IT, ES.
You can not create first mile bundles for US/UK orders using this API.
The way you send the first-mile bundle. Possible enumerations are:
PICKUP: You use the logistic service provided by TikTok Shop to send the bundle.DROP_OFF: You contact the logistic provider and send the bundle. The logistic provider must be registered at TikTok Shop.
The logistic provider ID in TikTok Shop. Required when handover_method == DROP_OFF.
The logistic tracking number of the bundle. Required when handover_method == DROP_OFF.
Last 4 digits of the sender’s phone number. Required when handover_method == DROP_OFF.
Example
{ "order_ids": [ "578967030217083407" ], "handover_method": "PICKUP", "shipping_provider_id": "7463353253533", "tracking_number": "SF1244442424", "phone_tail_number": "1234"}Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
The ID of the first-mile bundle.
The returned waybill link.
Errors associated with requested orders. An entry can indicate that the requested order could not be resolved, or that a package associated with the order could not be included in the bundle. Multiple errors may be returned, including when the top-level code is 0.
object
The code for the error associated with the requested order identified by detail.order_id.
The message that explains the error associated with the requested order identified by detail.order_id.
Error detail
object
TikTok Shop order ID
Example
{ "code": 0, "data": { "first_mile_bundle_id": "BA123444534", "url": "https://open-fs-va.tiktokshop.com/doc_tts/object/28b05?skipCookie=true&timeStamp=1721272360&sign=ef63cd6", "errors": [ { "code": 21008121, "message": "invalid order id", "detail": { "order_id": "578967030217083407" } } ] }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}