stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /product/202309/inventory/search
#§2 Method: [POST]
#§3 Function Description
Retrieve inventory information for multiple products or SKUs. Note:
- Searches can be based on either product IDs or SKU IDs, not both at the same time.
- Passing Product IDs returns the inventory information of all SKUs under the specified products.
- Passing SKU IDs returns the inventory information for the specified SKUs.
§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 |
|---|---|---|---|---|
| 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 |
|---|---|---|---|---|
| product_ids | []string | N | ["1729592969712207008"] | A list of product IDs used to search for inventory information. |
| Max IDs: 100 | ||||
| sku_ids | []string | N | ["1729388324987897824"] | |
| A list of SKU IDs used to search for inventory information. | ||||
| Max IDs: 600 | ||||
Note: If both sku_ids and product_ids are passed, sku_ids will take precedence. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/product/202309/inventory/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"product_ids":["1729592969712207008"],"sku_ids":["1729388324987897824"]}
§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 | []object | Inventory information for the requested products or SKUs. | |
| ^^product_id | string | 1729592969712207008 | The ID of the requested product. |
| ^^skus | []object | The list of requested SKUs. | |
| ^^^id | string | 1729388324987897824 | The SKU ID generated by TikTok Shop. |
| ^^^seller_sku | string | Color-Red-XM01 | An internal code/name for managing SKUs, not visible to buyers. |
| ^^^total_available_quantity | int | 100 | The total number of units available for ordering across all warehouses. |
It is the sum of the warehouse_inventory.available_quantity values in all warehouses. | |||
| ^^^total_committed_quantity | int | 10 | The total number of units reserved by existing customer orders across all warehouses (and therefore not available for ordering). |
It is the sum of the warehouse_inventory.committed_quantity values in all warehouses. | |||
| ^^^warehouse_inventory | []object | SKU warehouse inventory information. | |
| ^^^^warehouse_id | string | 7054915283043174149 | The ID of the warehouse where the SKU is stored. |
| Retrieve details of the warehouse from the Get Warehouse List API. | |||
| ^^^^available_quantity | int | 100 | The total number of units available for ordering in this warehouse. |
This is equivalent to the inventory.quantity value returned in the Get Product API. | |||
| ^^^^committed_quantity | int | 10 | The total number of units reserved by existing customer orders in this warehouse (and therefore not available for ordering). |
| ^^^total_available_inventory_distribution | object | The distribution of the total available inventory for the SKU across different channels. | |
| ^^^^campaign_inventory | []object | Inventory that is allocated to a specific campaign. | |
| ^^^^^quantity | int | 30 | The number of units allocated. |
| ^^^^^campaign_name | string | Big Sale | The name of the associated campaign. |
| ^^^^creator_inventory | []object | Inventory that is allocated to TikTok creators. | |
| ^^^^^quantity | int | 20 | The number of units allocated. |
| ^^^^^creator_name | string | py001 | The name of the associated TikTok creator. |
| ^^^^in_shop_inventory | object | The remaining inventory available for the shop after deducting those allocated for campaigns and creators. | |
| ^^^^^quantity | int | 50 | The number of units allocated. |
§9 Response Sample
{"code":0,"data":{"inventory":[{"product_id":"1729592969712207008","skus":[{"id":"1729388324987897824","seller_sku":"Color-Red-XM01","total_available_quantity":100,"total_committed_quantity":10,"warehouse_inventory":[{"warehouse_id":"7054915283043174149","available_quantity":100,"committed_quantity":10}],"total_available_inventory_distribution":{"campaign_inventory":[{"quantity":30,"campaign_name":"Big Sale"}],"creator_inventory":[{"quantity":20,"creator_name":"py001"}],"in_shop_inventory":{"quantity":50}}}]}]},"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 |
|---|---|
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
| 12019008 | Product id is invalid |
| 12019015 | The number of SKU exceed the limit |
| 12019022 | SKU must contain a valid warehouse. |
| 12019112 | seller id is invalid |
| 12019114 | Seller has no permission |
| 12019120 | The number of provided product IDs exceeds the limit. |