stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /fbt/202601/mcf_outbound_orders/cancel
#§2 Method: [POST]
#§3 Function Description
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.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| shop_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | 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 | |||||
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Query Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| app_key | string | Y | 38abcd | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign | string | Y | 5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp | int | Y | 1623812664 | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| mcf_order_id | string | Y | 7136104329798256386 | A unique ID that identifies different MCF orders |
| consign_orders | []object | N | The cancel list of consign order | |
| ^id | string | N | OBF7136104329798256386 | The consign order id |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/fbt/202601/mcf_outbound_orders/cancel?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"mcf_order_id":"7136104329798256386","consign_orders":[{"id":"OBF7136104329798256386"}]}
§8 Response Parameters
| Properties | Type | Sample | Properties description |
|---|---|---|---|
| code | int | 0 | The success or failure status code returned in API response. |
| message | string | Success | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | 202203070749000101890810281E8C70B7 | Request log |
| data | object | Specific return information | |
| ^mcf_order | object | The mcf order information and related consign order status. | |
| ^^external_order_id | string | shopify7136104329798256386 | The corresponding order ID in your OMS. |
| ^^mcf_order_id | string | 7136104329798256386 | A unique ID that identifies different MCF orders |
| ^^consign_orders | []object | Consign orders cancel results of this mcf order | |
| ^^^id | string | OBF1234 | The consign order id |
| ^^^status | string | cancelled | The status of this consign order |
Possible Status Enumerations
- PENDING - Order is pending warehouse processing
- HANDLE_BY_WAREHOUSE - Order is being processed by the warehouse
- SHIPPED - Order has been shipped out from the warehouse
- HANDOVER - Order has been received by the logistics carrier and is in transit
- CLOSED - Order has been closed
- LOST - Order is lost
- DAMAGE - Order is damaged
- COMPLETED - Order has been completed
- ABNORMAL - There is an issue related to this order and cannot be fulfilled |
§9 Response Sample
{"code":0,"data":{"mcf_order":{"external_order_id":"shopify7136104329798256386","mcf_order_id":"7136104329798256386","consign_orders":[{"id":"OBF1234","status":"cancelled"}]}},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§10 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|---|
| 177001009 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |