Skip to main content

POST Search FBT Inventory Record

Search FBT Inventory Record Shop Required scope: seller.fbt.info This API is used to retrieve detailed inventory change records for goods at the warehouse level. Version 202410

POST/fbt/202410/inventory_records/search

Request

Header

PropertiesTypeDescription
content-type RequiredstringAllowed type: application/json
x-tts-access-token RequiredstringThe seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token.

Query

PropertiesTypeDescription
page_size RequiredintThe number of results to be returned per page. Valid range: [1-100].
page_tokenstringPagination page token. It should be empty for the first page.
app_key RequiredstringEvery single app will have a unique key. Please use the specific key assigned to your app.
sign RequiredstringSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp RequiredstringUnix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
shop_cipher RequiredstringUse 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

PropertiesTypeDescription
goods_ids[]stringThe identifiers for goods generated by Fulfilled by TikTok system, maximum length 100. If specificed, it will only show inventory records belonging to those goods, otherwise, all goods with non-zero inventory will be returned.
fbt_warehouse_ids[]stringThe 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.
create_time_geintFilter inventory record creation time to show only those that are created on or after the specified date and time. Unix timestamp in seconds. create_time_ge is 0 by default.
create_time_leintFilter inventory record creation time to show only those that are created on or before the specified date and time. Unix timestamp in seconds. create_time_le is the current time by default.

Example

CurlGoNode.jsJavaEnable word wrap

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

Response Parameters

PropertiesTypeDescription
codeintThe success or failure status code returned in API response.
messagestringThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstringRequest log
dataobjectSpecific return information

Example

JSONEnable word wrap

{"code":0,"data":{"inventory_records":[{"goods":{"id":"12324323","reference_code":"water01","name":"100ml water"},"fbt_warehouse_id":"7232392932323","order":{"id":"OBF8932302030203","type":"OUTBOUND_ORDER"},"create_time":1212139230,"inventory_goods_type":"NORMAL","initial_on_hand_quantity":10,"final_on_hand_quantity":12,"changed_quantity":2}],"next_page_token":"cGFnZV9udW1iZXI9Mg==",

Error Code

View common error codes

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

Is this content helpful?Helpful

Not Helpful

PreviousNext