POST Cancel FBT MCF Order
Cancel FBT MCF Order Shop Required scope: seller.fbt.info After an order is shipped via FBT, an MCF Order may be split into one or more consign orders for fulfillment. This API supports order cancellation at the level of individual consign orders, which can be done by providing the corresponding mcf_order_id and its associated consign order information. You can retrieve the information of consign orders associated with a mcf_order_id via the Get FBF MCF Order Status API. Version 202601
POST/fbt/202601/mcf_outbound_orders/cancel
Request
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token. |
Query
| Properties | Type | Description |
|---|---|---|
| app_key Required | string | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign Required | string | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp Required | int | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| shop_cipher Required | string | Use 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 |
Body
| Properties | Type | Description |
|---|---|---|
| mcf_order_id Required | string | A unique ID that identifies different MCF orders |
| consign_orders | []object | The cancel list of consign order |
Example
CurlGoNode.jsJavaEnable word wrap
123456789101112curl-X POST 'https://open-api.tiktokglobalshop.com/fbt/202601/mcf_outbound_orders/cancel?timestamp=1623812664&shop_cipher=GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3&app_key=38abcd&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c' -H 'x-tts-access-token: TTP_pwSm2AAAAABmmtFz1xlyKMnwg74T2GJ5s0uQbS8jPjb_GkdFVCxPqzQXSyuyfXdQa0AqyDsea2tYFNVf4XeqgZHFfPyv0Vs659QqyLYfsGzanZ5XZAin3_ZkcIxxS0_In6u6XDeU96k' -H 'content-type: application/json' -d '{ "mcf_order_id": "7136104329798256386", "consign_orders": [ { "id": "OBF7136104329798256386" } ]}'
Response Parameters
| Properties | Type | Description |
|---|---|---|
| code | int | The success or failure status code returned in API response. |
| message | string | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | Request log |
| data | object | Specific return information |
Example
JSONEnable word wrap
{"code":0,"data":{"mcf_order":{"external_order_id":"shopify7136104329798256386","mcf_order_id":"7136104329798256386","consign_orders":[{"id":"OBF1234","status":"cancelled"}]}},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
Error Code
View common error codes
| Code | Message | | --- | --- | | 177001009 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
Is this content helpful?Helpful
Not Helpful
PreviousNext