Get Order Split Attributes

资料正文

§1 Path: /fulfillment/202309/orders/split_attributes

§2 Method: [GET]

§3 Function Description

Use this API to check whether an order(s) can be split into multiple packages or not.

§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 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.
order_ids	[]string	Y	556643423443,556643423444	Query list of TikTok Shop order IDs.

§6 Request Sample

Query

https://open-api.tiktokglobalshop.com/fulfillment/202309/orders/split_attributes?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&order_ids=556643423443,556643423444

§7 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
^split_attributes	[]object		Specific return information (can return multiple TikTok Shop order IDs).
^^order_id	string	556643423444	TikTok Shop order ID.
^^can_split	bool	false	Whether an order can be split:

true: The order can be split into multiple packages.
false: The order cannot be split into multiple packages. | ^^reason |string |Order has been canceled |The reason why the order cannot be split. Only return this field when can_split = false. | ^^must_split |bool |false |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. | ^^must_split_reasons |[]object | |The reason why the order must be split. Only return this field when must_split = true. | ^^^type |string |CATEGORY_ITEM_LIMITATION |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. | ^^^category_id |string |601990 |If the value of reason.type is "CATEGORY_ITEM_LIMITATION", this field will return a value. If the value of reason.type is "TOTAL_COUNT_LIMITATION", this field will return no value | ^^^max_count |string |2 |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. |

§8 Response Sample

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

§9 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.