Create FBT MCF Order

POST

/fbt/202607/mcf_outbound_orders

For orders created on other sales channels that require fulfillment via FBT, this API enables you to create corresponding orders (hereinafter referred to as MCF Orders). Once MCF Orders are successfully created, they will be automatically submitted to the FBT system for fulfillment.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

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

Request Body^required

Media typeapplication/json

object

external_order_id

required

The corresponding order ID in your OMS. Maximum UTF-8 length: 127 bytes. It must be unique among active MCF orders for the same merchant. Reusing an external_order_id from an active order is rejected as a duplicate and is not an idempotent retry.

string

goods

required

The item IDs and quantities included in the order. The array must contain at least one item, and each item must be managed in the FBT system. The sum of quantity across all entries in goods must not exceed 50.

Array<object>

object

id

required

The goods ID generated by the Fulfilled by TikTok system. The value must be a positive base-10 integer string.

string

quantity

required

The quantity of this item. Must be greater than 0.

integer format: int64

consignee

required

The consignee contact info

object

name

required

The consignee name. Must not exceed 128 UTF-8 bytes.

string

phone_number

required

The phone number of consignee

string

email

required

The email of consignee

string

address

required

The consignee address must be a valid address; if the address verification fails, no order will be created.

object

country_code

required

The consignee address country code in two-character ISO 3166-1 alpha-2 format. Only US is accepted.

string

state_or_region

required

Consignee address state or region

string

district_or_county

Consignee address district or county

string

city

required

Consignee address city

string

address_line_1

required

The detail address line 1

string

address_line_2

The detail address line 2

string

postal_code

The 5-digit US ZIP code for the consignee address.

string

Example

{
  "external_order_id": "shopify202208291503530001100220033",
  "goods": [
    {
      "id": "1234567",
      "quantity": 1
    }
  ],
  "consignee": {
    "name": "username",
    "phone_number": "(+1)1211223910",
    "email": "username@example.com",
    "address": {
      "country_code": "US",
      "state_or_region": "Alabama",
      "district_or_county": "Baldwin",
      "city": "Bay Minette",
      "address_line_1": "312 Courthouse Square",
      "address_line_2": "Suite 10",
      "postal_code": "36507"
    }
  }
}

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

Information about the successfully created MCF order. On a successful response, this object contains mcf_order_id, external_order_id, and create_time.

object

external_order_id

The corresponding order ID in your OMS.

string

mcf_order_id

A unique ID that identifies different MCF orders

string

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",
      "create_time": 1661756811
    }
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}