stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /order/202406/orders/external_orders
#§2 Method: [POST]
#§3 Function Description
If you are using your own external OMS (order management system) to manage TikTok Shop orders, the corresponding order IDs between your OMS and TikTok Shop may be different. Use this endpoint to attach the information in your OMS to the correct order(s) in TikTok Shop for further reference.
§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. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| orders | []object | Y | Max count: 100. | |
| ^id | string | Y | 576461413038785752 | The unique identifier for a TikTok Shop order. |
| ^external_order | object | Y | Order information in your external order management system (OMS). | |
| ^^id | string | Y | 676461413038785752 | The corresponding order ID in your OMS. |
| ^^platform | string | Y | SHOPIFY | The alias of your OMS. |
| Possible values: |
- SHOPIFY
- WOOCOMMERCE
- BIGCOMMERCE
- MAGENTO
- SALESFORCE_COMMERCE_CLOUD
- CHANNEL_ADVISOR
- AMAZON
- ORDER_MANAGEMENT_SYSTEM
- WAREHOUSE_MANAGEMENT_SYSTEM
- ERP_SYSTEM
Notes:
- To attach information from multiple OMSs to the same order in TikTok Shop, call this API multiple times, each with the same TikTok Shop order and a different OMS.
- To edit the attached information for a TikTok Shop order, call the API with the same OMS. | ^^line_items |[]object |Y | |Max count: 100. | ^^^id |string |Y |577086512123755123 |Line item ID in your OMS. | ^^^origin_id |string |Y |677086512123755123 |Line item ID in TikTok Shop. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/order/202406/orders/external_orders?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"orders":[{"id":"576461413038785752","external_order":{"id":"676461413038785752","platform":"SHOPIFY","line_items":[{"id":"577086512123755123","origin_id":"677086512123755123"}]}}]}
§8 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 | |
| ^errors | []object | A list of error codes and their corresponding messages. | |
| ^^code | string | 36020001 | A machine-readable response code that represents the request result. |
| ^^message | string | Invalid order_id | A human-readable message that describes the success or failure of the API request. |
| ^^detail | object | The details of the error message. | |
| ^^^order_id | string | 576461413038785752 | The unique identifier for a TikTok Shop order. |
| ^^^external_order | object | The order information in your OMS. | |
| ^^^^id | string | 676461413038785752 | The corresponding order ID in your OMS. |
| ^^^^platform | string | SHOPIFY | The alias of your OMS. |
§9 Response Sample
{"code":0,"data":{"errors":[{"code":"36020001","message":"Invalid order_id","detail":{"order_id":"576461413038785752","external_order":{"id":"676461413038785752","platform":"SHOPIFY"}}}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§10 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|