快工助手跨境电商知识与商机助手
快工云仓服务介绍

v2.sbs.get_expiry_report

Shopee 官方资料 · Shopee Open Platform 接口参考 · 适合开发者

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

来自 Shopee 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存，可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
Shopee / profile.shopee.api_reference
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.sbs.get_expiry_report

Seller Center Expiry Report page data

#

§2 Overview

Overview

FieldValue
ModuleSBS
API typeShop
HTTP methodGET
Path/api/v2/sbs/get_expiry_report
Production URLhttps://partner.shopeemobile.com/api/v2/sbs/get_expiry_report
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/sbs/get_expiry_report
PermissionERP System; Seller In House System; Swam ERP
#

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
page_noint32No1Specifies 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_sizeint32No10Each 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_idsstringNoIDL,IDG
expiry_statusstringNo2,40-Expired，2-Expiring，4-expiry_blocked，5-damaged，6-normal。Multiple selections allowed, separated by commas.
category_id_l1int64No100002Only Level 1 Category can be filtered
sku_idstringNo801866836_10006075010
item_idstringNo801866836
variationstringNo
item_namestringNo
whs_regionstringYesCNNum 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

NameTypeRequiredSampleDescription
request_idstringThe identifier for an API request for error tracking.
errorstringIndicate error type if hit error. Empty if no error happened.
messagestringIndicate error details if hit error. Empty if no error happened.
responseobjectDetail informations you are querying.
response.item_listobject[]
response.item_list.warehouse_item_idstring900625438Warehouse 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_namestring跨境商品测试00002 - 1666171590
response.item_list.item_imagestringhttp://mms.img.susercontent.com/08b3fc410c8eaa7e3f52b06b486a8658
response.item_list.sku_listobject[]
response.item_list.sku_list.mtsku_idstring900625438_10010402373Unique ID for a warehouse SKU "warehouse_item_id"_"warehouse_model_id"
response.item_list.sku_list.model_idstring10010402373Warehouse 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_modeint3210-Null；1-Bundle SKU；2-Parent SKU
response.item_list.sku_list.variationstringYellow,Middle
response.item_list.sku_list.shop_sku_listobject[]
response.item_list.sku_list.shop_sku_list.shop_sku_idstringshop level sku_id shop_sku_id="item_id" _ "model_id"
response.item_list.sku_list.shop_sku_list.shop_item_idstringshop_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_idstringshop_model_id= item level model_id For Global Item, warehouse_item_id=Global Item id For Local Item, shop_item_id=item_id
response.item_list.sku_list.whs_listobject[]
response.item_list.sku_list.whs_list.whs_idstringCNNwarehouse ID
response.item_list.sku_list.whs_list.expiring_qtyint640Stocks that are expiring soon and should be sold as soon as possible.
response.item_list.sku_list.whs_list.expired_qtyint640Stock past expiry date.
response.item_list.sku_list.whs_list.expiry_blocked_qtyint640Stocks that are too near to expiry and cannot be sold any more.
response.item_list.sku_list.whs_list.damaged_qtyint640Stock in damaged condition and cannot be sold.
response.item_list.sku_list.whs_list.normal_qtyint6410Stocks that are normal.
response.item_list.sku_list.whs_list.total_qtyint6410Total stocks on hand.
#

§5 Common parameters

Common parameters

NameTypeRequiredSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature 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": "-",
	"error": "-",
	"message": "-",
	"response": {
		"item_list": [
			{
				"item_id": "900625438",
				"item_name": "跨境商品测试00002 - 1666171590",
				"item_image": "http://mms.img.susercontent.com/08b3fc410c8eaa7e3f52b06b486a8658",
				"sku_list": [
					{
						"mtsku_id": "900625438_10010402373",
						"model_id": "10010402373",
						"fulfill_mapping_mode": 1,
						"variation": "Yellow,Middle",
						"whs_list": [
							{
								"whs_id": "CNN",
								"expiring_qty": 0,
								"expired_qty": 0,
								"expiry_blocked_qty": 0,
								"damaged_qty": 0,
								"normal_qty": 10,
								"total_qty": 10
							}
						]
					}
				]
			}
		]
	}
}
#

§8 Errors

Errors

ErrorDescriptionSolution
error_dataparse data failed
error_datadata not exist
error_paramparameter invalid
error_paramThe information you queried is not found.
error_paramWrong parameters, detail: {msg}.
error_serverSomething wrong. Please try later.
#

§9 Common errors

Common errors

ErrorDescriptionSolution
error_authpartner_id is invalid
error_authThe App is deleted, and you'll be unable to make any API call.
error_authApp 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_paramThere is no partner_id in query.
error_paramInvalid partner_id.
error_paramno timestamp
error_paramInvalid timestamp
error_paramThere is no sign in query.
error_signWrong sign.
invalid_partner_idInvalid partner_id, please have a check.
error_authNo permission to current api.
error_api_call_restrictedThe 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_suspendedThe API is offline. Please call v2 API instead.
error_limitThe 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_limitToo many requests. You have reached the rate limit. Please try again later.
source_ip_undeclaredRequest Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_paramPermission denied. This API is currently offline or the request path is incorrect.
error_paramPartner_id is invalid, should be an integer between 0 and 4294967295.
error_paramno timestamp.
error_paramTimestamp is invalid, should be an integer between 0 and 4294967295.
error_paramTimestamp is expired.
error_partner_key_expiredYour 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_permissionThis app type has no permission to this API.
error_paramThere is no access_token in query.
error_authInvalid access_token.
error_authInvalid partner_id or shopid.
shop_no_linkedPartner and shop has no linked.
shop_bannedThe shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_tokenInvalid access_token, please have a check.
partner_shop_no_linkInvalid partner_id or shop_id, please have a check.
error_ashop_api_permissionThe shop is Affiliate shop has no permission to call this API.
error_kyc_authNo permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_authSystem error, please try again later.
error_paramThere is no shop_id in query.
error_paramshop_id is invalid, should be an integer between 0 and 4294967295.
#

§10 Update log

Update log

DateChange
2025-05-15New API
#