Cancel FBT MCF Order

POST

/fbt/202601/mcf_outbound_orders/cancel

An FBT multi-channel fulfillment (MCF) order may be split into one or more consign orders for fulfillment. Use this API to cancel the MCF order or selected consign orders by providing the mcf_order_id. To cancel selected consign orders, provide their consign order IDs. You can retrieve IDs that have already been assigned by calling the Get FBT MCF Order Status API; use IDs returned while the target consign orders are still in a cancellable pre-shipment state.

Cancellation is rejected for target consign orders that have reached SHIPPED, HANDOVER, COMPLETED, or a shipping-exception state such as LOST, DAMAGE, RETURNED, or SCRAP.

After the request, match the target consign order IDs against this API’s response. A returned status of CLOSED means that the consign order has been canceled.

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

mcf_order_id

required

The MCF order ID as a numeric string.

string

consign_orders

The consign orders to cancel. Omit this field to cancel all consign orders in the specified MCF order.

Array<object>

object

id

The consign order ID as a numeric string without the OBF prefix.

string

Example

{
  "mcf_order_id": "7136104329798256386",
  "consign_orders": [
    {
      "id": "7136104329798256386"
    }
  ]
}

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

The mcf order information and related consign order status.

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

All consign orders in the MCF order and their current statuses after the cancellation request. Match the requested consign order IDs to the returned items; a status of CLOSED means that the consign order has been canceled.

Array<object>

object

id

The consign order ID, returned as a numeric string without the OBF prefix.

string

status

The current status of this consign order. In a cancellation response, CLOSED means that the consign order has been canceled.

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 canceled
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
10. RETURNED - Order has been returned
11. SCRAP - Order has been scrapped
12. UNKNOWN - Order status is unknown

string

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

Example

{
  "code": 0,
  "data": {
    "mcf_order": {
      "external_order_id": "shopify7136104329798256386",
      "mcf_order_id": "7136104329798256386",
      "consign_orders": [
        {
          "id": "1234",
          "status": "CLOSED"
        }
      ]
    }
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}