快工助手跨境电商知识与商机助手

Get FBT MCF Order Status

TikTok Shop 官方资料 · TikTok Shop Partner Center 开发者文档 · 适合开发者

stable本次发布有变化全部展示

来自 TikTok Shop 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
TikTok Shop / profile.tiktok.docs_api
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/tiktok_shopaudience/developercategory/api_doctopic/compliancetopic/developer

资料正文

§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_cipherquerystringYGCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3Use 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-typeheaderstringYapplication/jsonAllowed type: application/json
#

§5 Request Query Parameters

Properties Type Require Sample Properties description
app_keystringY38abcdEvery single app will have a unique key. Please use the specific key assigned to your app.
signstringY5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8cSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestampintY1623812664Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
mcf_order_idstringY7136104329798256386A 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&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&mcf_order_id=7136104329798256386
#

§7 Response Parameters

Properties Type Sample Properties description
codeint0The success or failure status code returned in API response.
messagestringSuccessThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstring202203070749000101890810281E8C70B7Request log
dataobjectSpecific return information
^mcf_orderobjectMCF order information
^^external_order_idstringshopify202208291503530001100220033The corresponding order ID in your OMS.
^^mcf_order_idstring7136104329798256386A unique ID that identifies different MCF orders
^^consign_orders[]objectOnce the order has been shipped, the consign_orders field will display the consignment details of the order.
^^^idstringOBF1234consign order unique id
^^^goods[]objectThe goods id and quantity in this consign order.
^^^^idstring123124124Identifier for goods generated by Fulfilled by TikTok systemgoods id
^^^^quantityint1The goods quantity in this consign order
^^^tracking_numberstringTN87654321The 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.
^^^carrierstringUSPSThe 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.
^^^statusstringPENDINGThe status of this consign order

Possible Status Enumerations

  1. PENDING - Order is pending warehouse processing
  2. HANDLE_BY_WAREHOUSE - Order is being processed by the warehouse
  3. SHIPPED - Order has been shipped out from the warehouse
  4. HANDOVER - Order has been received by the logistics carrier and is in transit
  5. CLOSED - Order has been closed
  6. LOST - Order is lost
  7. DAMAGE - Order is damaged
  8. COMPLETED - Order has been completed
  9. 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 order is 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
177001009Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support.
177001010Order information cannot be retrieved via the mcf_order_id you provided; please check if your ID is correct.
#