Get FBT MCF Order Status

GET

/fbt/202601/mcf_outbound_orders

Use this API to retrieve an MCF order and the current status and fulfillment details of its consign orders. If the order requires multiple packages because of carrier restrictions or package-size limits, the FBT system splits it for fulfillment and returns one entry in consign_orders for each package.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

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

mcf_order_id

required

string

A unique ID that identifies different MCF orders

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

mcf_order

MCF order information

object

external_order_id

The corresponding order ID in your OMS.

string

mcf_order_id

A unique ID that identifies different MCF orders

string

consign_orders

The consign orders created for the MCF order. If fulfillment is split across multiple packages, this array contains one entry for each package.

Array<object>

object

id

consign order unique id

string

goods

The goods id and quantity in this consign order.

Array<object>

object

id

Identifier for goods generated by Fulfilled by TikTok systemgoods id

string

quantity

The goods quantity in this consign order

integer format: int64

tracking_number

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.

string | null

carrier

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.

string | null

status

The status of the consign order.

Possible values:

• PENDING - The order is pending warehouse processing.
• HANDLE_BY_WAREHOUSE - The order is being processed by the warehouse.
• SHIPPED - The order has shipped from the warehouse.
• HANDOVER - The logistics carrier has received the order and it is in transit.
• CLOSED - The order is closed.
• LOST - The order is lost.
• DAMAGE - The order is damaged.
• RETURNED - The order was returned.
• SCRAP - The order was scrapped.
• UNKNOWN - The consign-order status or shipping-exception subtype is unknown.
• COMPLETED - The order is complete.
• ABNORMAL - An issue prevents the order from being fulfilled.

string

Allowed values: PENDING HANDLE_BY_WAREHOUSE SHIPPED HANDOVER CLOSED LOST DAMAGE RETURNED SCRAP UNKNOWN COMPLETED ABNORMAL

is_platform_closed

Indicates who canceled the consign order when status is CLOSED. true means the FBT platform canceled the order; false means it was canceled through your OMS.

boolean

issue

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.

string

shipping_provider

Any of:

object

object

id

The shipping carrier unique id.

string

name

The shipping carrier name.

string

null

null

create_time

The Unix timestamp, in seconds, when the MCF order was created.

integer format: int64

Example

{
  "code": 0,
  "data": {
    "mcf_order": {
      "external_order_id": "shopify202208291503530001100220033",
      "mcf_order_id": "7136104329798256386",
      "consign_orders": [
        {
          "id": "1234",
          "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"
}