Search Order By External Order Reference

资料正文

§1 Path: /order/202406/orders/external_order_search

§2 Method: [POST]

§3 Function Description

If you have used the Add External Order References API to sync information from your external order management system (OMS) to corresponding orders in TikTok Shop, you may call this API to search for order information in TikTok Shop based on information in your OMS.

§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.
platform	string	Y	SHOPIFY	The alias of your external order management system (OMS).
Possible values:

SHOPIFY
WOOCOMMERCE
BIGCOMMERCE
MAGENTO
SALESFORCE_COMMERCE_CLOUD
CHANNEL_ADVISOR
AMAZON
ORDER_MANAGEMENT_SYSTEM
WAREHOUSE_MANAGEMENT_SYSTEM
ERP_SYSTEM | external_order_id |string |Y |676461413038785752 |Order ID in your OMS. |

§6 Request Sample

Query

https://open-api.tiktokglobalshop.com/order/202406/orders/external_order_search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&platform=SHOPIFY&external_order_id=676461413038785752

Body

{}

§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
^orders	[]object		A list of returned orders.

^^id	string	576461413038785752	The unique identifier for a TikTok Shop order.

^^external_order	object		Order in your OMS.

^^^id	string	676461413038785752	Order ID in your OMS.

^^^platform	string	SHOPIFY	The alias of your OMS.

^^^line_items	[]object		Line items in the order.

^^^^id	string	577086512123755123	Line item ID in your OMS.

^^^^origin_id	string	677086512123755123	Line item ID in TikTok Shop.

§8 Response Sample

{"code":0,"data":{"orders":[{"id":"576461413038785752","external_order":{"id":"676461413038785752","platform":"SHOPIFY","line_items":[{"id":"577086512123755123","origin_id":"677086512123755123"}]}}]},"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