POST Search Order By External Order Reference
Search Order By External Order Reference Shop Required scope: seller.order.ext_ref.read 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. Version 202406
POST/order/202406/orders/external_order_search
Request
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token. |
Query
| Properties | Type | Description |
|---|---|---|
| app_key Required | string | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign Required | string | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp Required | int | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| platform Required | string | 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 Required | string | Order ID in your OMS. |
| shop_cipher Required | string | 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 |
Example
CurlGoNode.jsJavaEnable word wrap
12345curl-X POST 'https://open-api.tiktokglobalshop.com/order/202406/orders/external_order_search?external_order_id=676461413038785752&app_key=38abcd&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1623812664&shop_cipher=GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3&platform=SHOPIFY' -H 'x-tts-access-token: TTP_pwSm2AAAAABmmtFz1xlyKMnwg74T2GJ5s0uQbS8jPjb_GkdFVCxPqzQXSyuyfXdQa0AqyDsea2tYFNVf4XeqgZHFfPyv0Vs659QqyLYfsGzanZ5XZAin3_ZkcIxxS0_In6u6XDeU96k' -H 'content-type: application/json' -d '{}'
Response Parameters
| Properties | Type | Description |
|---|---|---|
| code | int | The success or failure status code returned in API response. |
| message | string | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | Request log |
| data | object | Specific return information |
Example
JSONEnable word wrap
{"code":0,"data":{"orders":[{"id":"576461413038785752","external_order":{"id":"676461413038785752","platform":"SHOPIFY","line_items":[{"id":"577086512123755123","origin_id":"677086512123755123"}]}}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
Error Code
View common error codes
| Code | Message | | --- | --- | | Empty. No business logic error codes. |
Is this content helpful?Helpful
Not Helpful
PreviousNext