Confirm Order Split

POST

/fulfillment/202309/orders/{order_id}/split

Use this API to confirm an order split. 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

Authorizations

• accessToken

Parameters

Path Parameters

order_id

required

string

TikTok Shop order ID.

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

Request Body^required

Media typeapplication/json

object

splittable_groups

required

Groups of order line items to split. Each successfully split group is returned as a separate package.

Array<object>

object

id

required

A developer-defined identifier for this split group. The response returns the same value in splittable_group_id to correlate the group with its newly created package.

string

order_line_item_ids

required

The order line item IDs that need to be split into this group.

Array<string>

splittable_groups_v2

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

Array<object>

object

id

A developer-defined identifier for this split group. The response returns the same value in splittable_group_id to correlate the group with its newly created package.

string

order_line_list

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

Array<object>

object

order_line_id

The corresponding order line ID.

string

sub_item_id

The sub-order-line ID inside a bundle product.

• Required for bundle products.
• Not required for non-bundle products.

string

Example

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

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

packages

Packages created by the split. Each returned package includes the request group identifier in splittable_group_id and its new package ID in id.

Array<object>

object

splittable_group_id

The developer-defined id of the corresponding group from splittable_groups or splittable_groups_v2 in the request.

string

id

Package ID after success split. Use this new package ID to call Ship Package API to ship the package.

string

Example

{
  "code": 0,
  "data": {
    "packages": [
      {
        "splittable_group_id": "123",
        "id": "223362377512830222"
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}