stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /fulfillment/202309/orders/{order_id}/split
#§2 Method: [POST]
#§3 Function Description
Use this API to confirm an order split. Note that supported split levels vary by region:
- Some regions support item-level splits (splitting individual units of the same SKU).
- Others only support all-units splits (splitting different SKUs into separate packages).
Here are two examples of supported splits:
- Case 1: all-units split, applicable for orders in BR, SEA, MX (local sellers) Split a buyer order of SKU A of quantity 2 and SKU B of quantity 1 into two separate packages:
- Package 1: all units of SKU A
- Package 2: all units of SKU B
- Case 2: item-level split, applicable for orders in EU, JP, MX (global sellers), UK, US Split the same order contents into three individual packages:
- Package 1: 1 unit of SKU A
- Package 2: 1 unit of SKU A
- Package 3: 1 unit of SKU B
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| shop_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | Use 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 | |||||
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Path Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| order_id | string | Y | 556643423444 | TikTok Shop order ID. |
§6 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. |
§7 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| splittable_groups | []object | Y | Input list of splittable groups. | |
| ^id | string | Y | 123 | A unique identifier designated by the developer. This identifier will represent a group of items that will be split into a new package. Once split is confirmed, the platform will be assigned a new package ID for this group of items. |
For example, if you input 123 as request, the response will return 123 as your unique identification. The seller uses this field to label each group of items that have been split, and the platform will assign new package IDs to them. | ||||
| ^order_line_item_ids | []string | Y | ["57646237751283022", "576462377512830223"] | The order line item IDs that need to be split into this group. |
| splittable_groups_v2 | []object | N | This new parameter is completely backward compatible with the previous splittable groups field and in addition this supports bundle order splitting, use the sub items accordingly | |
| ^id | string | N | 123 | A unique identifier designated by the developer. This identifier will represent a group of items that will be split into a new package. Once split is confirmed, the platform will be assigned a new package ID for this group of items. |
For example, if you input 123 as request, the response will return 123 as your unique identification. The seller uses this field to label each group of items that have been split, and the platform will assign new package IDs to them. | ||||
| ^order_line_list | []object | N | This new parameter is completely backward compatible with the previous oder_line_items_ids field and in addition this supports bundle order splitting, use the sub items accordingly | |
| ^^order_line_id | string | N | 57646237751283022 | The corresponding order line ID. |
| ^^sub_item_id | string | N | 57646237751283022 | The sub-order-line ID inside a bundle product. |
- Required for bundle products.
- Not required for non-bundle products. |
§8 Request Sample
Query
https://open-api.tiktokglobalshop.com/fulfillment/202309/orders/556643423444/split?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"splittable_groups":[{"id":"123","order_line_item_ids":["57646237751283022","576462377512830223"]}],"splittable_groups_v2":[{"id":"123","order_line_list":[{"order_line_id":"57646237751283022","sub_item_id":"57646237751283022"}]}]}
§9 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 | |
| ^packages | []object | The number of packages returned is dependent on the number of splittable_group_ids you sent in the request. | |
| ^^splittable_group_id | string | 123 | The ID of split group in request body. |
| ^^id | string | 223362377512830222 | Package ID after success split. Use this new package ID to call Ship Package API to ship the package. |
§10 Response Sample
{"code":0,"data":{"packages":[{"splittable_group_id":"123","id":"223362377512830222"}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§11 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|---|
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
| 21001028 | The order is being processed. Try again later. |
| 21011005 | An invalid request parameter was passed. Please check that you have the correct parameter type(s) and format. |
| 21011035 | split order not allowed |