Get Order Split Attributes

GET

/fulfillment/202309/orders/split_attributes

Checks whether one or more TikTok Shop orders can be split into multiple packages. For each evaluated order, the response indicates whether it can be split and may include a reason when splitting is not allowed and mandatory package-splitting limits when applicable.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

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

order_ids

required

Array<string>

A comma-separated list of TikTok Shop order IDs to check for package split eligibility.

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

split_attributes

Split-eligibility results for the evaluated TikTok Shop orders. Each result identifies an order and indicates whether it can be split; it may also include a reason when splitting is not allowed and mandatory package-splitting limits when applicable.

Array<object>

object

order_id

TikTok Shop order ID.

string

can_split

Whether an order can be split:

• true: The order can be split into multiple packages.
• false: The order cannot be split into multiple packages.

boolean

reason

The reason why the order cannot be split. Only return this field when can_split = false.

string

must_split

Whether an order must be split:

• true: The order must be split into multiple packages.
• false: The order does not have to be split into multiple packages.

boolean

must_split_reasons

The reason why the order must be split. Only return this field when must_split = true.

Array<object>

object

type

It will return which type of verification is hit. There are two types of verification: CATEGORY_ITEM_LIMITATION means category verification and TOTAL_COUNT_LIMITATION means total product quantity verification.

string

category_id

The category ID associated with this split limitation. A value is returned when type is CATEGORY_ITEM_LIMITATION; no value is returned when type is TOTAL_COUNT_LIMITATION.

string

max_count

For category verification, return the maximum quantity of goods allowed for this category in a single package; for total product quantity verification within the package, return the total quantity limit of goods in a single package.

string

Example

{
  "code": 0,
  "data": {
    "split_attributes": [
      {
        "order_id": "556643423444",
        "can_split": false,
        "reason": "Order has been canceled",
        "must_split": false,
        "must_split_reasons": [
          {
            "type": "CATEGORY_ITEM_LIMITATION",
            "category_id": "601990",
            "max_count": "2"
          }
        ]
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}