v2.sbs.get_expiry_report

GET /api/v2/sbs/get_expiry_report

Seller Center Expiry Report page data

Endpoint URL

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

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 40.
whs_ids	string	False	IDL,IDG
expiry_status	string	False	2,4	0-Expired，2-Expiring，4-expiry_blocked，5-damaged，6-normal。Multiple selections allowed, separated by commas.
category_id_l1	int64	False	100002	Only Level 1 Category can be filtered
sku_id	string	False	801866836_10006075010
item_id	string	False	801866836
variation	string	False
item_name	string	False
whs_region	string	True	CN	Num 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		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[]
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_image	string	http://mms.img.susercontent.com/08b3fc410c8eaa7e3f52b06b486a8658
sku_list	object[]
mtsku_id	string	900625438_10010402373	Unique ID for a warehouse SKU "warehouse_item_id"_"warehouse_model_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
variation	string	Yellow,Middle
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
whs_list	object[]
whs_id	string	CNN	warehouse ID
expiring_qty	int64	0	Stocks that are expiring soon and should be sold as soon as possible.
expired_qty	int64	0	Stock past expiry date.
expiry_blocked_qty	int64	0	Stocks that are too near to expiry and cannot be sold any more.
damaged_qty	int64	0	Stock in damaged condition and cannot be sold.
normal_qty	int64	10	Stocks that are normal.
total_qty	int64	10	Total stocks on hand.

No Request Example Set.