POST Split Orders
Split Orders Shop Required scope: seller.fulfillment.package.write 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 Version 202309
POST/fulfillment/202309/orders/{order_id}/split
Request
Path
| Properties | Type | Description |
|---|---|---|
| order_id Required | string | TikTok Shop order ID. |
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token. |
Query
| Properties | Type | Description |
|---|---|---|
| app_key Required | string | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign Required | string | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp Required | int | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| shop_cipher Required | string | 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 |
Body
| Properties | Type | Description |
|---|---|---|
| splittable_groups Required | []object | Input list of splittable groups. |
| splittable_groups_v2 | []object | 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 |
Example
CurlGoNode.jsJavaEnable word wrap
Response Parameters
| Properties | Type | Description |
|---|---|---|
| code | int | The success or failure status code returned in API response. |
| message | string | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | Request log |
| data | object | Specific return information |
Example
JSONEnable word wrap
Error Code
View common error codes
| Code | Message | | --- | --- | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. | | 21011005 | Invalid parameters. Please ensure you are passing the correct request parameter(s). | | 21011035 | split order not allowed |
Is this content helpful?Helpful
Not Helpful
PreviousNext