(58) Get FBT MCF Order Status

资料正文

§1 (58) Get FBT MCF Order Status

§2 Trigger scenario

Trigger scenario

This webhook is triggered when the FBT multi-channel-fulfillment order status has changed/updated.

Prerequisite: The Fulfilled by TikTok(FBT) Info API scope is enabled in Partner Center. For more information, refer to Access Scope.

§3 Data business parameters

Data business parameters

Properties					Type	Example	Properties description
type					int	58	The ID of the webhook type.
tts_notification_id					string	7327112393057371910	The ID of the notification.
seller_open_id					string	VIyStQAAAADCBQ40s4TzOSSOEIW-bM5O9cod3vK8OytW8m-bnBYlXw	The open_id of the seller. For more information, refer to Authorization overview.
timestamp					int	1644412885	The UNIX timestamp when this webhook was triggered.
data
	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	OBF12345678	`consign order` unique id
>		>	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.
>		>	status		string	processing	The status of this consign order Possible Status Enumerations 1. SHIPPED - Order has been shipped out from the warehouse 2. HANDOVER - Order has been received by the logistics carrier and is in transit 3. CLOSED - Order has been closed 4. LOST - Order is lost 5. DAMAGE - Order is damaged 6. COMPLETED - Order has been completed 7. ABNORMAL - There is an issue related to this order and cannot be fulfilled.
>		>	goods		[]object		The goods id and quantity in this consign order.
>		>	>	id	string	1231231	Identifier for goods generated by Fulfilled by TikTok systemgoods id
>		>	>	quantity	int16	1	The goods quantity in this consign order
		>	is_platform_closed		string	true	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 information 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			int64	1661756811	The time when the mcf order is created

§4 Event example

Event example

{
  "type": 58,
  "creator_open_id": "VIyStQAAAADCBQ40s4TzOSSOEIW-bM5O9cod3vK8OytW8m-bnBYlXw",
  "tts_notification_id": "7327112393057371910",
  "timestamp": 1644412885,
  "data": {
    "mcf_order": {
      "external_order_id": "shopify202208291503530001100220033",
      "mcf_order_id": "7136104329798256386",
      "consign_orders": {
        "id": "OBF12345678",
        "tracking_number": "TN87654321",
        "carrier": "USPS",
        "status": "processing",
        "goods": {
          "id": "1231231",
          "quantity": 1
        }
      },
      "create_time": 1661756811
    }
  }
}