stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /fulfillment/202407/bundles
#§2 Method: [POST]
#§3 Function Description
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.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| 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 |
|---|---|---|---|---|
| order_ids | []string | Y | ["578967030217083407"] | The 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 |string |Y |PICKUP |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. | shipping_provider_id |string |N |7463353253533 |The logistic provider ID in TikTok Shop. Required whenhandover_method == DROP_OFF. | tracking_number |string |N |SF1244442424 |The logistic tracking number of the bundle. Required whenhandover_method == DROP_OFF. | phone_tail_number |string |N |1234 |Last 4 digits of the sender's phone number. Required whenhandover_method == DROP_OFF. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/fulfillment/202407/bundles?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268
Body
{"order_ids":["578967030217083407"],"handover_method":"PICKUP","shipping_provider_id":"7463353253533","tracking_number":"SF1244442424","phone_tail_number":"1234"}
§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 | |
| ^first_mile_bundle_id | string | BA123444534 | The ID of the first-mile bundle. |
| ^url | string | https://open-fs-va.tiktokshop.com/doc_tts/object/28b05?skipCookie=true&timeStamp=1721272360&sign=ef63cd6 | The returned waybill link. |
| ^errors | []object | Specific return information (returns multiple errors and reasons) | |
| ^^code | int | 10007014 | The success or failure status code returned in API response. |
| ^^message | string | invalid package id | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| ^^detail | object | Error detail | |
| ^^^order_id | string | 578967030217083407 | TikTok Shop order ID |
§9 Response Sample
{"code":0,"data":{"first_mile_bundle_id":"BA123444534","url":"https://open-fs-va.tiktokshop.com/doc_tts/object/28b05?skipCookie=true\u0026timeStamp=1721272360\u0026sign=ef63cd6","errors":[{"code":10007014,"message":"invalid package id","detail":{"order_id":"578967030217083407"}}]},"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 |
|---|