v2.order.split_order
POST /api/v2/order/split_order
Use this api to split an order into multiple packages. Orders that include installation services cannot be split by quantity.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/order/split_order
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| order_sn | string | True | 2012300NQJVTYN | Shopee's unique identifier for an order. |
| package_list | object[] | True | The list of packages that you want to split. Note: - Orders that include installation services cannot be split by quantity. - When splitting the order, must contain all items in the order in one request. - You can split the order into 30 parcels at most in TW and 5 parcels at most in other regions. | |
| item_list | object[] | True | The list of items under the same package. | |
| item_id | int64 | True | 3600140554 | Shopee's unique identifier for an item. |
| model_id | int64 | True | 10000605797 | Shopee's unique identifier for a model of an item. For single item without variation, you can set model_id as 0. |
| order_item_id | int | False | The identify of order item. For items in one same bundle deal promotion, the order_item_id should share the same id, such as 1,2. For items not in bundle deal promotion, the order_item_id should be the same as item_id. | |
| promotion_group_id | int | False | The identify of product promotion.It's required for add on deal and bundle deal items. For items in one same add on deal or bundle deal promotion, the promotion_group_id should share the same id. For items not in add on deal or bundle deal promotion, the promotion_group_id should be 0. And the data is from promotion_group_id of v2,order.get_order_detail. | |
| model_quantity | int32 | False | 2 | The number of identical items put in the package, the quantity sum of the same item from each parcel must be the full item quantity of the whole order. This field is only eligible for the shop whitelisted to the unit-level split in SG/TH/TW/MY markets. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | common.error_auth | Indicate error type if hit error. Empty if no error happened. |
| message | string | Invalid access_token. | Indicate error details if hit error. Empty if no error happened. |
| response | object | Detail informations you are querying. | |
| order_sn | string | 2012300NQJVTYN | Shopee's unique identifier for an order. |
| package_list | object[] | The list of package under this order you have split. | |
| package_number | string | 2521728636547073446 | Shopee's unique identifier for the package under an order. |
| item_list | object[] | The list of items under this package. | |
| item_id | int64 | 3600140567 | Shopee's unique identifier for an item. |
| model_id | int64 | 2000502199 | Shopee's unique identifier for a model. |
| order_item_id | int | The identify of order item. For items in one same bundle deal promotion, the order_item_id should share the same id, such as 1,2. For items not in bundle deal promotion, the order_item_id should be the same as item_id. | |
| promotion_group_id | int | The identify of product promotion. For items in one same add on deal promotion, the promotion_group_id should share the same id. For items not in add on deal promotion, the promotion_group_id should be 0. And the data is from group_id of shopee.orders.GetOrderDetails. | |
| model_quantity | int | The number of identical items put in the package. | |
| request_id | string | 02a3a65749ea47d2b4bba11e1ea30056 | The identifier of the API request for error tracking. |