POST Search FBT Inventory

Search FBT Inventory Shop Required scope: seller.fbt.info This API is used to retrieve detailed inventory information for goods and matched SKUs, including sellable inventory, reserved inventory, unsellable inventory, and in-transit inventory at the warehouse level. Version 202408

POST/fbt/202408/inventory/search

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
page_size Required	int	The number of results to be returned per page. Valid range: [1-100].
page_token	string	Pagination page token. It should be empty for the first page.
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
goods_ids	[]string	The identifiers for goods generated by Fulfilled by TikTok system, maximum length 100. If specificed, it will only show inventory information belonging to those goods, otherwise, all goods with non-zero inventory will be returned.Note: This API only allows either goods_ids or sku_ids, and returns results that satisfy all specified criteria.
fbt_warehouse_ids	[]string	The identifiers for warehouses generated by Fulfilled by TikTok system. If specificed, it will only show inventory records belonging to those warehouses, otherwise, all warehouses subscribed by merchant will be returned.
sku_ids	[]string	A list of identifiers for Stock Keeping Units(SKUs) generated by TikTok Shop, maximum length 100. Filter inventory information to display only those belonging to the goods matched with specified SKUs. Refer to note in goods_ids for more usage information.

Example

CurlGoNode.jsJavaEnable word wrap

12345678910111213141516curl-X POST 'https://open-api.tiktokglobalshop.com/fbt/202408/inventory/search?sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1623812664&shop_cipher=GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3&page_size=50&page_token=cGFnZV9udW1iZXI9Mg==&app_key=38abcd' -H 'x-tts-access-token: TTP_pwSm2AAAAABmmtFz1xlyKMnwg74T2GJ5s0uQbS8jPjb_GkdFVCxPqzQXSyuyfXdQa0AqyDsea2tYFNVf4XeqgZHFfPyv0Vs659QqyLYfsGzanZ5XZAin3_ZkcIxxS0_In6u6XDeU96k' -H 'content-type: application/json' -d '{ "goods_ids": [ "256080616234", "2231616264" ], "fbt_warehouse_ids": [ "7232382932030232" ], "sku_ids": [ "256080616234" ]}'

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":{"next_page_token":"cGFnZV9udW1iZXI9Mg==","total_count":22113,"inventory":[{"goods":{"id":"12345","reference_code":"water01","name":"100ml water","skus":[{"id":"73243612345","on_hand_detail":{"total_quantity":20,"available_quantity":5,"reserved_quantity":15}}]},"fbt_warehouse_id":"7232382932030232",

Error Code

View common error codes

| Code | Message | | --- | --- | | Empty. No business logic error codes. |

Is this content helpful?Helpful

Not Helpful

PreviousNext