GET Get Inbound Order
Get Inbound Order Shop Required scope: seller.fbt.info This API is used to retrieve the inbound order details including the planned inbound detail, actual inbound detail and inbound status, etc. Version 202602
GET/fbt/202602/inbound_orders
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. |
| order_ids Required | []string | The list of numeric identifiers of the inbound orders to fetch information for. Note: Provide the numeric sequence only; do not include the "IBR" prefix (e.g., use 123456 instead of IBR123456). There is a limit of 10 orders to be fetched in each request.You can get the value in data.inbound_order_id in Inbound FBT order status change webhook or in data.inventory_records.order.id in the response of Search FBT Inventory Record. |
| include_carton_details | bool | A boolean flag that determines whether the response should include granular information for each individual carton within the shipment.Note: When set to true, the response will include the carton_details field. If set to false or omitted, this field will be excluded from the response payload to optimize performance. |
| 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 |
Example
CurlGoNode.jsJavaEnable word wrap
1234curl-XGET 'https://open-api.tiktokglobalshop.com/fbt/202602/inbound_orders?include_carton_details=true×tamp=1623812664&app_key=38abcd&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&shop_cipher=GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3&order_ids=5766071177167344427,5766071177167344428' -H 'content-type: application/json' -H 'x-tts-access-token: TTP_pwSm2AAAAABmmtFz1xlyKMnwg74T2GJ5s0uQbS8jPjb_GkdFVCxPqzQXSyuyfXdQa0AqyDsea2tYFNVf4XeqgZHFfPyv0Vs659QqyLYfsGzanZ5XZAin3_ZkcIxxS0_In6u6XDeU96k'
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":{"inbound_orders":[{"order_id":"5766071177167344427","order_id_string":"IBR5766071177167344427","order_plan_id":"5766071177167345050","merchant":{"id":"493493403043","name":"ExampleCompany"},"create_time":1773778751,"ship_time":1773778751,"expected_arrival_time":1773778751,"actual_arrival_time":1773778751,"warehouse":{"fbt_warehouse_id":"121219993203023","business_warehouse_ids":["121219993209983"],"name":"TikTok Warehouse","type":"FC"
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. | | 39015009 | SellerId input is invalid | | 39015010 | No inbound orders found for the merchant. | | 39015020 | Number of orders in request exceeds the configured limit. |
Is this content helpful?Helpful
Not Helpful
PreviousNext