来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /fbt/202601/mcf_outbound_orders
#§2 Method: [GET]
#§3 Function Description
This API allows you to query the status of MCF Orders. When an order has not been shipped, the consign_orders field will contain no data; once the order has been shipped, the consign_orders field will display the consignment details of the order. If a single package cannot accommodate the entire order (due to carrier restrictions or packaging size limitations), the FBT system will split the order into multiple packages for fulfillment, in which case the consign_orders field will contain multiple entries corresponding to the respective packages.
§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. |
| mcf_order_id | string | Y | 7136104329798256386 | A unique ID that identifies different MCF orders |
§6 Request Sample
Query
https://open-api.tiktokglobalshop.com/fbt/202601/mcf_outbound_orders?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&mcf_order_id=7136104329798256386
§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 | |
| ^mcf_order | object | MCF order information | |
| ^^external_order_id | string | shopify202208291503530001100220033 | The corresponding order ID in your OMS. |
| ^^mcf_order_id | string | 7136104329798256386 | A unique ID that identifies different MCF orders |
| ^^consign_orders | []object | Once the order has been shipped, the consign_orders field will display the consignment details of the order. | |
| ^^^id | string | OBF1234 | consign order unique id |
| ^^^goods | []object | The goods id and quantity in this consign order. | |
| ^^^^id | string | 123124124 | Identifier for goods generated by Fulfilled by TikTok systemgoods id |
| ^^^^quantity | int | 1 | The goods quantity in this consign order |
| ^^^tracking_number | string | TN87654321 | The tracking number of this consign order. If the order has not yet been handed over to the logistics carrier, this field may be a null value. |
| ^^^carrier | string | USPS | The shipping carrier of this consign order. If the order has not yet been handed over to the logistics carrier, this field may be a null value. |
| ^^^status | string | PENDING | The status of this consign order |
Possible Status Enumerations
- PENDING - Order is pending warehouse processing
- HANDLE_BY_WAREHOUSE - Order is being processed by the warehouse
- SHIPPED - Order has been shipped out from the warehouse
- HANDOVER - Order has been received by the logistics carrier and is in transit
- CLOSED - Order has been closed
- LOST - Order is lost
- DAMAGE - Order is damaged
- COMPLETED - Order has been completed
- ABNORMAL - There is an issue related to this order and cannot be fulfilled | ^^^is_platform_closed |bool |false |This field indicates whether a consign order has been canceled by the FBT platform. If the value is true, it means the order has been canceled by the platform; if it is false, it means the order has been canceled by your OMS. | ^^^issue |string |Lack of inventory |This field displays the reason for order stalling. When a
consign orderis in an abnormal status (such as ABNORMAL, LOST, etc.), specific issue reasons will be shown here. | ^^^shipping_provider |object | |The shipping carrier detailed informatioin of this consign order. If the order has not yet been handed over to the logistics carrier, this field may be a null value. | ^^^^id |string |7345645330412603141 |The shipping carrier unique id. | ^^^^name |string |UPS |The shipping carrier name. | ^^create_time |int |1661756811 |The time when the mcf order is created |
§8 Response Sample
{"code":0,"data":{"mcf_order":{"external_order_id":"shopify202208291503530001100220033","mcf_order_id":"7136104329798256386","consign_orders":[{"id":"OBF1234","goods":[{"id":"123124124","quantity":1}],"tracking_number":"TN87654321","carrier":"USPS","status":"PENDING","is_platform_closed":false,"issue":"Lack of inventory","shipping_provider":{"id":"7345645330412603141","name":"UPS"}}],"create_time":1661756811}},"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 |
|---|---|
| 177001009 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
| 177001010 | Order information cannot be retrieved via the mcf_order_id you provided; please check if your ID is correct. |
