Create First Mile Bundle

POST

/fulfillment/202407/bundles

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

• accessToken

Request Body^required

Media typeapplication/json

object

order_ids

required

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.

Array<string>

handover_method

required

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.

string

Allowed values: PICKUP DROP_OFF

shipping_provider_id

The logistic provider ID in TikTok Shop. Required when handover_method == DROP_OFF.

string

tracking_number

The logistic tracking number of the bundle. Required when handover_method == DROP_OFF.

string

phone_tail_number

Last 4 digits of the sender’s phone number. Required when handover_method == DROP_OFF.

string

Example

{
  "order_ids": [
    "578967030217083407"
  ],
  "handover_method": "PICKUP",
  "shipping_provider_id": "7463353253533",
  "tracking_number": "SF1244442424",
  "phone_tail_number": "1234"
}

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

first_mile_bundle_id

The ID of the first-mile bundle.

string

url

The returned waybill link.

string

errors

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. Check this array and first_mile_bundle_id even when the top-level response code is 0. A present first_mile_bundle_id identifies the created bundle; if it is absent, this response does not identify a created bundle.

Array<object>

object

code

The code for the error associated with the requested order identified by detail.order_id.

integer format: int64

message

The message that explains the error associated with the requested order identified by detail.order_id.

string

detail

Error detail

object

order_id

TikTok Shop order ID

string

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"
}