v2.sbs.get_current_inventory

GET /api/v2/sbs/get_current_inventory

Get Seller Center Current Inventory Page Data

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/sbs/get_current_inventory

Common Request 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

Request Parameters

Name	Type	Required	Sample	Description
page_no	int32	False	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	False	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	False	2	0-All data；1-Product Name；2-SKU ID；3-Variations；4-Item ID
keyword	string	False		Bind Value and Search_type
whs_ids	string	False	IDL,IDG	Whs ID list, comma-separated
not_moving_tag	int32	False	0	Blank-All；0-No；1-Yes
inbound_pending_approval	int64	False	0	Blank-All；0-No；1-Yes
products_with_inventory	int32	False	0	Blank-All；0-No；1-Yes
category_id	int64	False	100002	Category id. Here you need to call the get_category API to retrieve the first-tier category_id.
stock_levels	string	False	1,2	1-Low Stock & No Sellable stock; 2-Low Stock & To replenish; 3-Low Stock & Replenished; 4-Excess
whs_region	string	True	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"

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.
item_list	object[]		Data list of item sku
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
item_name	string	跨境商品测试00002 - 1666171590	item name
item_image	string	http://img.ws.mms.shopee.sg/08b3fc410c8eaa7e3f52b06b486a8658	item image
sku_list	object[]		Data list of mtsku
mtsku_id	string	900625438_10010402373	mtsku id
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
fulfill_mapping_mode	int32	1	0-Null；1-Bundle SKU；2-Parent SKU
model_name	string	Yellow,Middle	model name
not_moving_tag	int32	0
whs_list	object[]		Info of whs
whs_id	string	CNN	Warehouse ID
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
ir_approval_qty	int64	0	IR approval but no ASN generated will be included
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
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.
reserved_qty	int64	3	Stocks reserved by buyer order, RTS. And also includes rack transfer reserved stock that are not available for sale
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.
excess_stock	int64	0	Number of units that are above 6 days of sales coverage Days.
coverage_days	float	0.1	Days that the current sellable and pending inbound inventory are expected to last based on current selling speed.
in_whs_coverage_days	float	0.1	Days that the current sellable inventory are expected to last based on current selling speed.
selling_speed	float	0.2	Average daily sold quantity
last_7_sold	int64	0	Sales qty last 7 days
last_15_sold	int64	0	Sales qty last 15 days
last_30_sold	int64	0	Sales qty last 30 days
last_60_sold	int64	0	Sales qty last 60 days
last_90_sold	int64	0	Sales qty last 90 days
shop_sku_list	object[]
shop_sku_id	string		shop level sku_id shop_sku_id="item_id" _ "model_id"
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
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

No Request Example Set.