Skip to main content

POST Create First Mile Bundle(V2)

Create First Mile Bundle(V2) Shop Required scope: seller.fulfillment.basic 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. Version 202510

POST/fulfillment/202510/first_mile_bundle

Request

Header

PropertiesTypeDescription
content-type RequiredstringAllowed type: application/json
x-tts-access-token RequiredstringThe seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token.

Query

PropertiesTypeDescription
app_key RequiredstringEvery single app will have a unique key. Please use the specific key assigned to your app.
sign RequiredstringSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp RequiredintUnix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
shop_cipher RequiredstringUse 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

Body

PropertiesTypeDescription
order_ids Required[]stringThe IDs of all the orders sent in a single first-mile bundle.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.
handover_method RequiredstringThe 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.
shipping_provider_idstringThe logistic provider ID in TikTok Shop. Required when handover_method == DROP_OFF.
tracking_numberstringThe logistic tracking number of the bundle. Required when handover_method == DROP_OFF.
phone_tail_numberstringLast 4 digits of the sender's phone number. Required when handover_method == DROP_OFF.

Example

CurlGoNode.jsJavaEnable word wrap

12345678910111213curl-X POST 'https://open-api.tiktokglobalshop.com/fulfillment/202510/first_mile_bundle?timestamp=1623812664&app_key=38abcd&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&shop_cipher=GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3' -H 'content-type: application/json' -H 'x-tts-access-token: TTP_pwSm2AAAAABmmtFz1xlyKMnwg74T2GJ5s0uQbS8jPjb_GkdFVCxPqzQXSyuyfXdQa0AqyDsea2tYFNVf4XeqgZHFfPyv0Vs659QqyLYfsGzanZ5XZAin3_ZkcIxxS0_In6u6XDeU96k' -d '{ "order_ids": [ "578967030217083407" ], "handover_method": "PICKUP", "shipping_provider_id": "7463353253533", "tracking_number": "SF1244442424", "phone_tail_number": "1234"}'

Response Parameters

PropertiesTypeDescription
codeintThe success or failure status code returned in API response.
messagestringThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstringRequest log
dataobjectSpecific return information

Example

JSONEnable word wrap

{"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":10007014,"message":"invalid package id","detail":{"order_id":"578967030217083407"}}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}

Error Code

View common error codes

| Code | Message | | --- | --- | | Empty. No business logic error codes. |

Is this content helpful?Helpful

Not Helpful

PreviousNext