Get External Order References

GET

/order/202406/orders/{order_id}/external_orders

If you have used the Add External Order References API, use this API to retrieve the external order references associated with a TikTok Shop order for the specified external order management system (OMS) platform.

Authorizations

• accessToken

Parameters

Path Parameters

order_id

required

string

The unique identifier for a TikTok Shop order.

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

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

external_orders

A list of orders that have been synced between your OMS and TikTok Shop.

Note: If you’ve synced order information between multiple OMSs to the same TikTok Shop order, you’ll retrieve all external order information.

Array<object>

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": {
    "external_orders": [
      {
        "id": "676461413038785752",
        "platform": "SHOPIFY",
        "line_items": [
          {
            "id": "577086512123755123",
            "origin_id": "677086512123755123"
          }
        ]
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}