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

v2.sbs.get_stock_aging

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_stock_aging

Get Seller Center Stock Aging page data

#

§2 Overview

Overview

FieldValue
ModuleSBS
API typeShop
HTTP methodGET
Path/api/v2/sbs/get_stock_aging
Production URLhttps://partner.shopeemobile.com/api/v2/sbs/get_stock_aging
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/sbs/get_stock_aging
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 100.
search_typeint32No21-Product Name；2-SKU ID；3-Variations；4-Item ID
keywordstringNobound with search_type
whs_idsstringNoIDL,IDGsplit by comma
aging_storage_tagint32No00-false；1-true
excess_storage_tagint32No00-false；1-true
category_idint64No100002L1-level product category ID. You need to call the get_category API to obtain the first-level category_id
whs_regionstringYesCNBR、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
errorstringIndicate error type if hit error. Empty if no error happened.
messagestringIndicate error details if hit error. Empty if no error happened.
request_idstringThe identifier for an API request for error tracking.
responseobjectDetail informations you are querying.
response.item_listobject[]Data list of item sku
response.item_list.warehouse_item_idstring900626943Warehouse 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 - 1666171546item name
response.item_list.item_imagestringhttp://mms.img.susercontent.com/08b3fc410c8eaa7e3f52b06b486a8658item image
response.item_list.sku_listobject[]Data list of mtsku
response.item_list.sku_list.mtsku_idstring900626943_15359982mtsku id
response.item_list.sku_list.model_idstring15359982Warehouse 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.model_namestringOrange,Largemodel name
response.item_list.sku_list.barcodestring1231
response.item_list.sku_list.whs_listobject[]Info of whs
response.item_list.sku_list.whs_list.whs_idstringCNNWhs id
response.item_list.sku_list.whs_list.qty_of_stock_age_oneint6400-30Days
response.item_list.sku_list.whs_list.qty_of_stock_age_twoint64031-60Days
response.item_list.sku_list.whs_list.qty_of_stock_age_threeint64061-90Days
response.item_list.sku_list.whs_list.qty_of_stock_age_fourint64091-120Days
response.item_list.sku_list.whs_list.qty_of_stock_age_fiveint640121-180Days
response.item_list.sku_list.whs_list.qty_of_stock_age_sixint640>180Days
response.item_list.sku_list.whs_list.excess_stockint640expired stock
response.item_list.sku_list.whs_list.aging_storage_tagint320
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
#

§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

{
	"error": "-",
	"message": "-",
	"request_id": "-",
	"response": {
		"item_list": [
			{
				"item_id": "900626943",
				"item_name": "跨境商品测试00002 - 1666171546",
				"item_image": "http://mms.img.susercontent.com/08b3fc410c8eaa7e3f52b06b486a8658",
				"sku_list": [
					{
						"mtsku_id": "900626943_15359982",
						"model_id": "15359982",
						"fulfill_mapping_mode": 1,
						"model_name": "Orange,Large",
						"barcode": "1231",
						"whs_list": [
							{
								"whs_id": "CNN",
								"qty_of_stock_age_one": 0,
								"qty_of_stock_age_two": 0,
								"qty_of_stock_age_three": 0,
								"qty_of_stock_age_four": 0,
								"qty_of_stock_age_five": 0,
								"qty_of_stock_age_six": 0,
								"excess_stock": 0,
								"aging_storage_tag": 0
							}
						]
					}
				]
			}
		]
	}
}
#

§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
#