This API is used to retrieve detailed inventory change records for goods at the warehouse level.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Identifies the shop. Obtain it from the Get Authorized Shops API.
The number of results to return per page. Valid range: [1-100]. Pagination is limited to the first 20,000 results.
Pagination page token. It should be empty for the first page.
Request Body
Section titled “Request Body”object
The IDs of goods generated by the Fulfilled by TikTok system to search. Maximum: 100 IDs. If IDs are provided, the API returns only inventory records for those goods; if omitted, it returns inventory records for all goods with non-zero inventory.
The IDs of Fulfilled by TikTok warehouses to search. Maximum: 100 IDs. The API searches only warehouses available to the merchant: if IDs are provided, the search is limited to matching IDs; if omitted, all available warehouses are searched.
Filter 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.
Filter 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
{ "goods_ids": [ "256080616234", "2231616264" ], "fbt_warehouse_ids": [ "7232382932030232" ], "create_time_ge": 1293013251, "create_time_le": 1393013251}Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
A list of inventory records information.
object
The reference used to track products and SKUs within Fulfilled by TikTok’s network.
object
The identifier for goods generated by Fulfilled by TikTok system.
The identifier for goods defined by merchant.
The goods name.
The identifier for warehouse generated by Fulfilled by TikTok system.
The information of order that triggers current inventory change.
object
The identifier for order generated by Fulfilled by TikTok system.
The type of order. Possible values:
- INBOUND_ORDER
- RETURN_TO_SUPPLIER_ORDER
- DISPOSAL
- INVENTORY_STATUS_ADJUSTMENT_ORDER
- CONSIGN_ORDER
- INVENTORY_COUNT_ORDER
- FAILED_DELIVERY
- CUSTOMER_RETURN
- INVENTORY_QUANTITY_ADJUSTMENT_ORDER
- INVENTORY_TRANSFER_ORDER
The time when the inventory record is created, Unix timestamp in seconds.
The type of goods in current inventory record. Possible values:
- NORMAL
- DEFECTIVE
The number of goods units physically in the Fulfilled by TikTok warehouse before current inventory change, excluding those in transit.
The number of goods units physically in the Fulfilled by TikTok warehouse after current inventory change, excluding those in transit.
The change in the number of units is calculated as the final_on_hand_quantity - initial_on_hand_quantity.
An opaque token used to retrieve the next page of a paginated result set. Provide this value in the page_token parameter of your request if the current response does not return all the results.
The total number of the search results.
Example
{ "code": 0, "data": { "inventory_records": [ { "goods": { "id": "12324323", "reference_code": "water01", "name": "100ml water" }, "fbt_warehouse_id": "7232392932323", "order": { "id": "OBF8932302030203", "type": "INBOUND_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==", "total_count": 22113 }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}