v2.sbs.get_current_inventory

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 · 2026-09-06 12:15:14

打开官方原文 ↗

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.sbs.get_current_inventory

Get Seller Center Current Inventory Page Data

§2 Overview

Overview

Field	Value
Module	SBS
API type	Shop
HTTP method	GET
Path	/api/v2/sbs/get_current_inventory
Production URL	https://partner.shopeemobile.com/api/v2/sbs/get_current_inventory
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/sbs/get_current_inventory
Permission	ERP System; Seller In House System; Swam ERP

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
page_no	int32	No	1	Specifies the page number of data to return in the current call. Starting from 1. if data is more than one page, the page_no can be some entry to start next call. If empty, the default value is 1.
page_size	int32	No	10	Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call), and the "page_no" to start next call. This integer value is used to specify the maximum number of entries to return in a single "page" of data.; If empty, the default value is 10. The value should be between 1 and 100.
search_type	int32	No	2	0-All data；1-Product Name；2-SKU ID；3-Variations；4-Item ID
keyword	string	No		Bind Value and Search_type
whs_ids	string	No	IDL,IDG	Whs ID list, comma-separated
not_moving_tag	int32	No	0	Blank-All；0-No；1-Yes
inbound_pending_approval	int64	No	0	Blank-All；0-No；1-Yes
products_with_inventory	int32	No	0	Blank-All；0-No；1-Yes
category_id	int64	No	100002	Category id. Here you need to call the get_category API to retrieve the first-tier category_id.
stock_levels	string	No	1,2	1-Low Stock & No Sellable stock; 2-Low Stock & To replenish; 3-Low Stock & Replenished; 4-Excess
whs_region	string	Yes	CN	The warehouse region you want to query, can only query one region in a request Optional value: BR、CN、ID、MY、MX、TH、TW、PH、VN、SG If do not pass, will get error "block by gateway due to invalid cid"

§4 Response parameters

Response parameters

Name	Type	Sample	Description
request_id	string	123456abc	The identifier for an API request for error tracking.
error	string		Indicate error type if hit error. Empty if no error happened.
message	string		Indicate error details if hit error. Empty if no error happened.
response	object		Detail informations you are querying.
response.item_list	object[]		Data list of item sku
response.item_list.warehouse_item_id	string	900625438	Warehouse item id; To indicate an unique item in a warehouse one warehouse item id can match with multiple shop_item_id For Global Item, warehouse_item_id=Global Item id For Local Item, shop_item_id=item_id
response.item_list.item_name	string	跨境商品测试00002 - 1666171590	item name
response.item_list.item_image	string	http://img.ws.mms.shopee.sg/08b3fc410c8eaa7e3f52b06b486a8658	item image
response.item_list.sku_list	object[]		Data list of mtsku
response.item_list.sku_list.mtsku_id	string	900625438_10010402373	mtsku id
response.item_list.sku_list.model_id	string	10010402373	Warehouse model SKU ID; For CB global items, this is equal to the global model_id.; For local items, it differs from model_id; use shop_model_id to match the model_id
response.item_list.sku_list.fulfill_mapping_mode	int32	1	0-Null；1-Bundle SKU；2-Parent SKU
response.item_list.sku_list.model_name	string	Yellow,Middle	model name
response.item_list.sku_list.not_moving_tag	int32	0
response.item_list.sku_list.whs_list	object[]		Info of whs
response.item_list.sku_list.whs_list.whs_id	string	CNN	Warehouse ID
response.item_list.sku_list.whs_list.stock_level	int32	-1	-1-No need to calculate stock level；0-None；1-Low Stock & No Sellable stock; 2-Low Stock & To replenish; 3-Low Stock & Replenished; 4-Excess
response.item_list.sku_list.whs_list.ir_approval_qty	int64	0	IR approval but no ASN generated will be included
response.item_list.sku_list.whs_list.in_transit_pending_putaway_qty	int64	0	ASN in-transit，ASN pending putaway, Move transfer in transit and Move transfer pending putaway will be included
response.item_list.sku_list.whs_list.sellable_qty	int64	47	Stocks that are available for sale. This includes warehouse sellable stock, move transfer & rack transfer reserved stock that available for sale, pre-order stock.This quantity may be greater than qty displayed to buyers as it includes stock reserved for upcoming promotions.
response.item_list.sku_list.whs_list.reserved_qty	int64	3	Stocks reserved by buyer order, RTS. And also includes rack transfer reserved stock that are not available for sale
response.item_list.sku_list.whs_list.unsellable_qty	int64	0	Stocks in the warehouse that are not available for sale. This includes damaged stocks, isolated stock due to expired/near expiring, in warehouse staging location, missing, etc.
response.item_list.sku_list.whs_list.excess_stock	int64	0	Number of units that are above 6 days of sales coverage Days.
response.item_list.sku_list.whs_list.coverage_days	float	0.1	Days that the current sellable and pending inbound inventory are expected to last based on current selling speed.
response.item_list.sku_list.whs_list.in_whs_coverage_days	float	0.1	Days that the current sellable inventory are expected to last based on current selling speed.
response.item_list.sku_list.whs_list.selling_speed	float	0.2	Average daily sold quantity
response.item_list.sku_list.whs_list.last_7_sold	int64	0	Sales qty last 7 days
response.item_list.sku_list.whs_list.last_15_sold	int64	0	Sales qty last 15 days
response.item_list.sku_list.whs_list.last_30_sold	int64	0	Sales qty last 30 days
response.item_list.sku_list.whs_list.last_60_sold	int64	0	Sales qty last 60 days
response.item_list.sku_list.whs_list.last_90_sold	int64	0	Sales qty last 90 days
response.item_list.sku_list.shop_sku_list	object[]
response.item_list.sku_list.shop_sku_list.shop_sku_id	string		shop level sku_id shop_sku_id="item_id" _ "model_id"
response.item_list.sku_list.shop_sku_list.shop_item_id	string		shop_item_id="item_id" in Product Module For Global Item, warehouse_item_id=Global Item id For Local Item, shop_item_id=item_id
response.item_list.sku_list.shop_sku_list.shop_model_id	string		shop_model_id= item level model_id For Global Item, warehouse_item_id=Global Item id For Local Item, shop_item_id=item_id

§5 Common parameters

Common parameters

Name	Type	Sample	Description
partner_id	int	1	Partner ID is assigned upon registration is successful. Required for all requests.
timestamp	timestamp	1610000000	This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_token	string	c09222e3fc40ffb25fc947f738b1abf1	The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_id	int	600000	Shopee's unique identifier for a shop. Required param for most APIs.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2

§6 Response sample

Response sample

§7 JSON

JSON

{
	"request_id": "123456abc",
	"error": "-",
	"message": "-",
	"response": {
		"cursor": "eyJDdXJyZW50UGFnZU5vIjoxLCJMZWZ0U29ydFZhbHVlcyI6WyI5MDA2MjU0MzgiXSwiUmlnaHRTb3J0VmFsdWVzIjpbIjkwMDYyNjk0NCJdfQ==",
		"item_list": [
			{
				"item_id": "900625438",
				"item_name": "跨境商品测试00002 - 1666171590",
				"item_image": "http://img.ws.mms.shopee.sg/08b3fc410c8eaa7e3f52b06b486a8658",
				"sku_list": [
					{
						"mtsku_id": "900625438_10010402373",
						"model_id": "10010402373",
						"fulfill_mapping_mode": 1,
						"model_name": "Yellow,Middle",
						"not_moving_tag": 0,
						"whs_list": [
							{
								"whs_id": "CNN",
								"stock_level": -1,
								"ir_approval_qty": 0,
								"in_transit_pending_putaway_qty": 0,
								"sellable_qty": 47,
								"reserved_qty": 3,
								"unsellable_qty": 0,
								"excess_stock": 0,
								"coverage_days": 0.1,
								"in_whs_coverage_days": 0.1,
								"selling_speed": 0.2,
								"last_7_sold": 0,
								"last_15_sold": 0,
								"last_30_sold": 0,
								"last_60_sold": 0,
								"last_90_sold": 0
							}
						]
					}
				]
			}
		]
	}
}

§8 Errors

Errors

Error	Description	Solution
error_data	parse data failed
error_data	data not exist
error_param	parameter invalid
error_param	The information you queried is not found.
error_param	Wrong parameters, detail: {msg}.
error_server	Something wrong. Please try later.

§9 Common errors

Common errors

Error	Description	Solution
error_auth	partner_id is invalid
error_auth	The App is deleted, and you'll be unable to make any API call.
error_auth	App developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_param	There is no partner_id in query.
error_param	Invalid partner_id.
error_param	no timestamp
error_param	Invalid timestamp
error_param	There is no sign in query.
error_sign	Wrong sign.
invalid_partner_id	Invalid partner_id, please have a check.
error_auth	No permission to current api.
error_api_call_restricted	The App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspended	The API is offline. Please call v2 API instead.
error_limit	The total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limit	Too many requests. You have reached the rate limit. Please try again later.
source_ip_undeclared	Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_param	Permission denied. This API is currently offline or the request path is incorrect.
error_param	Partner_id is invalid, should be an integer between 0 and 4294967295.
error_param	no timestamp.
error_param	Timestamp is invalid, should be an integer between 0 and 4294967295.
error_param	Timestamp is expired.
error_partner_key_expired	Your API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permission	This app type has no permission to this API.
error_param	There is no access_token in query.
error_auth	Invalid access_token.
error_auth	Invalid partner_id or shopid.
shop_no_linked	Partner and shop has no linked.
shop_banned	The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_token	Invalid access_token, please have a check.
partner_shop_no_link	Invalid partner_id or shop_id, please have a check.
error_ashop_api_permission	The shop is Affiliate shop has no permission to call this API.
error_kyc_auth	No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_auth	System error, please try again later.
error_param	There is no shop_id in query.
error_param	shop_id is invalid, should be an integer between 0 and 4294967295.

§10 Update log

Update log

Date	Change
2025-05-15	New API

这条内容对你有帮助吗？