Search Orders by External Order Reference

POST

/order/202406/orders/external_order_search

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.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

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

platform

required

string

Allowed values: SHOPIFY WOOCOMMERCE BIGCOMMERCE MAGENTO SALESFORCE_COMMERCE_CLOUD CHANNEL_ADVISOR AMAZON ORDER_MANAGEMENT_SYSTEM WAREHOUSE_MANAGEMENT_SYSTEM ERP_SYSTEM

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.

Request Body

Media typeapplication/json

object

Example

{}

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

orders

A list of TikTok Shop orders that match the specified external order ID and OMS platform. This field may be omitted when no orders match.

Array<object>

object

id

The unique identifier for a TikTok Shop order.

string

external_order

Order in your OMS.

object

id

Order ID in your OMS.

string

platform

The alias of your OMS.

string

line_items

Line item references between the external order and TikTok Shop.

Array<object>

object

id

Line item ID in your OMS.

string

origin_id

Line item ID in TikTok Shop.

string

Example

{
  "code": 0,
  "data": {
    "orders": [
      {
        "id": "576461413038785752",
        "external_order": {
          "id": "676461413038785752",
          "platform": "SHOPIFY",
          "line_items": [
            {
              "id": "577086512123755123",
              "origin_id": "677086512123755123"
            }
          ]
        }
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}