stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /fbt/202408/inventory/search
#§2 Method: [POST]
#§3 Function Description
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.
§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 | int | 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 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 | 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. |
| sku_ids | []string | N | ["256080616234"] | 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. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/fbt/202408/inventory/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"],"sku_ids":["256080616234"]}
§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 | |
| ^next_page_token | string | cGFnZV9udW1iZXI9Mg== | 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. |
| ^total_count | int | 22113 | The total number of the search results. |
| ^inventory | []object | A list of inventory information. | |
| ^^goods | object | The reference used to track products and SKUs within Fulfilled by TikTok's network. | |
| ^^^id | string | 69167899745030 | The identifier for goods generated by Fulfilled by TikTok system. |
| ^^^reference_code | string | water01 | The identifier for goods defined by the merchant, commonly used to reference the ID from the merchant's other order management systems. |
| ^^^name | string | 100ml water | The goods name. |
| ^^^skus | []object | A list of inventory information for Stock Keeping Units (SKUs) matched with current Fulfilled by TikTok goods. | |
| ^^^^id | string | 73243612345 | The identifier for SKU generated by TikTok Shop system. |
| ^^^^on_hand_detail | object | The inventory information of SKU physically in the warehouse, excluding those in transit or broken. | |
| ^^^^^total_quantity | int | 20 | The total number of units for current SKU, consist of available_quantity and reserved_quantity. |
| ^^^^^available_quantity | int | 5 | The number of units available for sale. |
| Note: | |||
| The number does not include reserved units. | |||
| ^^^^^reserved_quantity | int | 15 | The number of units reserved for customer orders or return to supplier shipment. |
| ^^fbt_warehouse_id | string | 7232382932030232 | The identifier for warehouse generated by Fulfilled by TikTok system. |
| ^^in_transit_quantity | int | 10 | The number of goods units currently en route to the warehouse. The inventory includes inbound replenishments, customer returns, unsuccessful delivery returns, etc. |
| ^^on_hand_detail | object | The current-in-warehouse inventory detail for the goods. | |
| ^^^total_quantity | int | 20 | The total number of units physically in the Fulfilled by TikTok warehouse, excluding those in transit. This total is the sum of available_quantity, reserved_quantity, and unfulfillable_quantity. |
| ^^^available_quantity | int | 5 | The number of units available for sale. |
| Note: | |||
| The number does not include reserved units. | |||
| ^^^reserved_quantity | int | 15 | The number of units reserved for customer orders or return to supplier shipment. |
| ^^^unfulfillable_quantity | int | 0 | The number of units that are currently unavailable for sale. |
§9 Response Sample
{"code":0,"data":{"next_page_token":"cGFnZV9udW1iZXI9Mg==","total_count":22113,"inventory":[{"goods":{"id":"69167899745030","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","in_transit_quantity":10,"on_hand_detail":{"total_quantity":20,"available_quantity":5,"reserved_quantity":15,"unfulfillable_quantity":0}}]},"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 |
|---|