stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /fbt/202410/inventory_records/search
#§2 Method: [POST]
#§3 Function Description
This API is used to retrieve detailed inventory change records for goods at the warehouse level.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| shop_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | 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 | |||||
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Query Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| page_size | int | Y | 50 | The number of results to be returned per page. |
| Valid range: [1-100]. | ||||
| page_token | string | N | cGFnZV9udW1iZXI9Mg== | Pagination page token. It should be empty for the first page. |
| app_key | string | Y | 38abcd | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign | string | Y | 5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp | string | Y | 1623812664 | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| goods_ids | []string | N | ["256080616234","2231616264"] | The 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 | []string | N | ["7232382932030232"] | 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. |
| create_time_ge | int | N | 1293013251 | 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. |
| create_time_le | int | N | 1393013251 | 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. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/fbt/202410/inventory_records/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&page_size=50&page_token=cGFnZV9udW1iZXI9Mg==
Body
{"goods_ids":["256080616234","2231616264"],"fbt_warehouse_ids":["7232382932030232"],"create_time_ge":1293013251,"create_time_le":1393013251}
§8 Response Parameters
| Properties | Type | Sample | Properties description |
|---|---|---|---|
| code | int | 0 | The success or failure status code returned in API response. |
| message | string | Success | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | 202203070749000101890810281E8C70B7 | Request log |
| data | object | Specific return information | |
| ^inventory_records | []object | A list of inventory records information. | |
| ^^goods | object | The reference used to track products and SKUs within Fulfilled by TikTok's network. | |
| ^^^id | string | 12324323 | The identifier for goods generated by Fulfilled by TikTok system. |
| ^^^reference_code | string | water01 | The identifier for goods defined by merchant. |
| ^^^name | string | 100ml water | The goods name. |
| ^^fbt_warehouse_id | string | 7232392932323 | The identifier for warehouse generated by Fulfilled by TikTok system. |
| ^^order | object | The information of order that triggers current inventory change. | |
| ^^^id | string | OBF8932302030203 | The identifier for order generated by Fulfilled by TikTok system. |
| ^^^type | string | INBOUND_ORDER | 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 | ^^create_time |int |1212139230 |The time when the inventory record is created, Unix timestamp in seconds. | ^^inventory_goods_type |string |NORMAL |The type of goods in current inventory record. Possible values:
- NORMAL
- DEFECTIVE | ^^initial_on_hand_quantity |int |10 |The number of goods units physically in the Fulfilled by TikTok warehouse before current inventory change, excluding those in transit. | ^^final_on_hand_quantity |int |12 |The number of goods units physically in the Fulfilled by TikTok warehouse after current inventory change, excluding those in transit. | ^^changed_quantity |int |2 |The change in the number of units is calculated as the
final_on_hand_quantity-initial_on_hand_quantity. | ^next_page_token |string |cGFnZV9udW1iZXI9Mg== |An opaque token used to retrieve the next page of a paginated result set. Provide this value in thepage_tokenparameter of your request if the current response does not return all the results. | ^total_count |int |22113 |The total number of the search results. |
§9 Response Sample
{"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"}
§10 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|