POST Cancel Inbound Order
Cancel Inbound Order Shop Required scope: seller.fbt.info This API is used to cancel an inbound order prior to warehouse arrival, preventing further processing and updating the order status.
If cancelling an inbound order that is part of a D2FC inbound plan, please make sure to cancel all orders under the inbound plan, otherwise non-compliance fees may be charged. Version 202602
POST/fbt/202602/inbound_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 |
|---|---|---|
| order_id Required | string | The numeric identifier of the inbound order to update tracking information for. Note: Provide the numeric sequence only; do not include the "IBR" prefix (e.g., use 123456 instead of IBR123456). |
| cancel_reason Required | string | Reason for cancelling the inbound order. |
Example
CurlGoNode.jsJavaEnable word wrap
12345678curl-X POST 'https://open-api.tiktokglobalshop.com/fbt/202602/inbound_orders/cancel?app_key=38abcd&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1623812664&shop_cipher=GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3' -H 'x-tts-access-token: TTP_pwSm2AAAAABmmtFz1xlyKMnwg74T2GJ5s0uQbS8jPjb_GkdFVCxPqzQXSyuyfXdQa0AqyDsea2tYFNVf4XeqgZHFfPyv0Vs659QqyLYfsGzanZ5XZAin3_ZkcIxxS0_In6u6XDeU96k' -H 'content-type: application/json' -d '{ "order_id": "5766071177167344427", "cancel_reason": "Order created by mistake."}'
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":{},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
Error Code
View common error codes
| Code | Message | | --- | --- | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. | | 39001002 | Request or request parameters are empty. Please recheck the input parameters. | | 39015007 | Access denied. The API requires the seller to be bound to exactly one merchant. | | 39015009 | SellerId input is invalid | | 39015010 | No inbound orders found for the merchant. | | 39015013 | Invalid or missing cancel reason. | | 39015014 | Failed to cancel inbound order due to status or other business restrictions. Please check the inbound order status and try again. If the issue persists and the cause is unknown, please contact platform support. |
Is this content helpful?Helpful
Not Helpful
PreviousNext