stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 v2.sbs.get_stock_movement
Get Seller Center，Stock Movement page data
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | SBS |
| API type | Shop |
| HTTP method | GET |
| Path | /api/v2/sbs/get_stock_movement |
| Production URL | https://partner.shopeemobile.com/api/v2/sbs/get_stock_movement |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/sbs/get_stock_movement |
| 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 20. |
| start_time | string | Yes | 2025-02-01 | Start date in YYYY-MM-DD format. Only data within the past 1 year can be queried, and the time range must not exceed 90 days. |
| end_time | string | Yes | 2025-02-24 | End date in YYYY-MM-DD format. Only data within the past 1 year can be queried, and the time range must not exceed 90 days. |
| whs_ids | string | No | IDL,IDG | Multiple warehouse_id values should be separated by commas. |
| category_id_l1 | int64 | No | 100002 | L1-level category_id. You need to call the get_category API to retrieve the first-level category_id. |
| sku_id | string | No | 900626944_15359986 | |
| item_id | string | No | 900626944 | |
| item_name | string | No | Product Name Filter | |
| variation | string | No | ||
| whs_region | string | Yes | CN | Warehouse Region. Enum values: 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 | Required | Sample | Description |
|---|---|---|---|---|
| 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. | ||
| request_id | string | The identifier for an API request for error tracking. | ||
| response | object | Detail informations you are querying. | ||
| response.total | int32 | 3 | ||
| response.start_time | string | 2025-02-01 | ||
| response.end_time | string | 2025-02-24 | ||
| response.query_end_time | string | 2025-02-24 | ||
| response.item_list | object[] | Data list of item sku | ||
| response.item_list.warehouse_item_id | string | 900626944 | Warehouse item id; To indicate an unique item in a warehouse one warehouse item id can match with multiple shop_item_id | |
| response.item_list.item_name | string | 跨境商品测试00002 - 1666171567 | 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 | 900626944_15359986 | mtsku id | |
| response.item_list.sku_list.model_id | string | 15359986 | model sku id | |
| response.item_list.sku_list.variation | string | Orange,Large | ||
| response.item_list.sku_list.fulfill_mapping_mode | int32 | 0 | 0-Null；1-Bundle SKU；2-Parent SKU | |
| response.item_list.sku_list.barcode | string | 11fsfsf | ||
| response.item_list.sku_list.whs_list | object[] | Info of whs | ||
| response.item_list.sku_list.whs_list.whs_id | string | CNN | Whs id | |
| response.item_list.sku_list.whs_list.start_on_hand_total | int64 | 50 | Total warehouse inventory at the start time | |
| response.item_list.sku_list.whs_list.inbound_total | int64 | 0 | Inbound quantity to the warehouse during the selected time period. | |
| response.item_list.sku_list.whs_list.outbound_total | int64 | 0 | Outbound quantity from the warehouse during the selected time period | |
| response.item_list.sku_list.whs_list.adjust_total | int64 | 0 | Inventory adjustment quantity in the warehouse during the selected time period | |
| response.item_list.sku_list.whs_list.end_on_hand_total | int64 | 50 | Total warehouse inventory at the end time. | |
| response.item_list.sku_list.start_qty | object | Inventory information at the start time. | ||
| response.item_list.sku_list.start_qty.start_on_hand_total | int64 | 50 | sku number at the start time | |
| response.item_list.sku_list.start_qty.start_sellable | int64 | 47 | Number of sellable SKUs at the start time | |
| response.item_list.sku_list.start_qty.start_reserved | int64 | 3 | Number of reserved SKUs at the start time. | |
| response.item_list.sku_list.start_qty.start_unsellable | int64 | 0 | ||
| response.item_list.sku_list.end_qty | object | |||
| response.item_list.sku_list.end_qty.end_on_hand_total | int64 | 50 | Total inventory at the end time. | |
| response.item_list.sku_list.end_qty.end_sellable | int64 | 47 | ||
| response.item_list.sku_list.end_qty.end_reserved | int64 | 3 | ||
| response.item_list.sku_list.end_qty.end_unsellable | int64 | 0 | ||
| response.item_list.sku_list.inbound_qty | object | Inbound information during the selected time period | ||
| response.item_list.sku_list.inbound_qty.inbound_total | int64 | 0 | Total inbound quantity during the selected time period | |
| response.item_list.sku_list.inbound_qty.inbound_my | int64 | 0 | Total merchant procurement quantity during the selected time period. | |
| response.item_list.sku_list.inbound_qty.inbound_returned | int64 | 0 | Total number of SKUs returned by buyers and received into the warehouse during the selected time period. | |
| response.item_list.sku_list.outbound_qty | object | |||
| response.item_list.sku_list.outbound_qty.outbound_total | int64 | 0 | Total outbound quantity during the selected time period. | |
| response.item_list.sku_list.outbound_qty.outbound_sold | int64 | 0 | "Total sold quantity during the selected time period." | |
| response.item_list.sku_list.outbound_qty.outbound_returned | int64 | 0 | Total merchant return quantity during the selected time period. | |
| response.item_list.sku_list.outbound_qty.outbound_disposed | int64 | 0 | Total disposal quantity during the selected time period. | |
| response.item_list.sku_list.adjust_qty | object | "SKU change information during the selected time period." | ||
| response.item_list.sku_list.adjust_qty.adjust_total | int64 | 0 | "Total number of SKU changes during the selected time period." | |
| response.item_list.sku_list.adjust_qty.adjust_lost_found | int64 | 0 | "Total quantity of lost or recovered items during the selected time period." | |
| response.item_list.sku_list.adjust_qty.adjust_trans_whs | int64 | 0 | Total quantity of transfer orders created by the warehouse during the selected time period | |
| 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 | ||
| response.item_list.sku_list.shop_sku_list.shop_model_id | string | shop_model_id= item level model_id |
§5 Common parameters
Common parameters
| Name | Type | Required | 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": "0910ad85-cc2d-416e-ade9-3f9057ff3c99",
"error": "",
"message": "",
"response": {
"total": 1,
"start_time": "2026-02-01",
"end_time": "2026-02-28",
"query_end_time": "2026-02-28",
"item_list": [
{
"warehouse_item_id": "900626850",
"item_name": "跨境商品测试0006 - 1666235229",
"item_image": "http://mms.img.susercontent.com/08b3fc410c8eaa7e3f52b06b486a8658",
"sku_list": [
{
"variation": "White,Small",
"mtsku_id": "900626850_10010403234",
"model_id": "10010403234",
"fulfill_mapping_mode": 0,
"barcode": "900626850_10010403234",
"shop_sku_list": [
{
"shop_sku_id": "900626817_10010403253",
"shop_item_id": "900626817",
"shop_model_id": "10010403253"
}
],
"whs_list": [
{
"start_on_hand_total": 11,
"inbound_total": 0,
"outbound_total": 0,
"adjust_total": 0,
"end_on_hand_total": 11,
"whs_id": "CNN"
}
],
"start_qty": {
"start_on_hand_total": 11,
"start_sellable": 0,
"start_reserved": 11,
"start_unsellable": 0
},
"end_qty": {
"end_on_hand_total": 11,
"end_sellable": 0,
"end_reserved": 11,
"end_unsellable": 0
},
"inbound_qty": {
"inbound_total": 0,
"inbound_my": 0,
"inbound_returned": 0
},
"outbound_qty": {
"outbound_total": 0,
"outbound_sold": 0,
"outbound_returned": 0,
"outbound_disposed": 0
},
"adjust_qty": {
"adjust_total": 0,
"adjust_lost_found": 0,
"adjust_trans_whs": 0
}
},
{
"variation": "Yellow,Small",
"mtsku_id": "900626850_10010403235",
"model_id": "10010403235",
"fulfill_mapping_mode": 0,
"barcode": "900626850_10010403235",
"shop_sku_list": [
{
"shop_sku_id": "900626817_10010403254",
"shop_item_id": "900626817",
"shop_model_id": "10010403254"
}
],
"whs_list": [
{
"start_on_hand_total": 0,
"inbound_total": 0,
"outbound_total": 0,
"adjust_total": 0,
"end_on_hand_total": 0,
"whs_id": "CNN"
}
],
"start_qty": {
"start_on_hand_total": 0,
"start_sellable": 0,
"start_reserved": 0,
"start_unsellable": 0
},
"end_qty": {
"end_on_hand_total": 0,
"end_sellable": 0,
"end_reserved": 0,
"end_unsellable": 0
},
"inbound_qty": {
"inbound_total": 0,
"inbound_my": 0,
"inbound_returned": 0
},
"outbound_qty": {
"outbound_total": 0,
"outbound_sold": 0,
"outbound_returned": 0,
"outbound_disposed": 0
},
"adjust_qty": {
"adjust_total": 0,
"adjust_lost_found": 0,
"adjust_trans_whs": 0
}
},
{
"variation": "Yellow,Middle",
"mtsku_id": "900626850_10010403236",
"model_id": "10010403236",
"fulfill_mapping_mode": 0,
"barcode": "900626850_10010403236",
"shop_sku_list": [
{
"shop_sku_id": "900626817_10010403255",
"shop_item_id": "900626817",
"shop_model_id": "10010403255"
}
],
"whs_list": [
{
"start_on_hand_total": 0,
"inbound_total": 0,
"outbound_total": 0,
"adjust_total": 0,
"end_on_hand_total": 0,
"whs_id": "CNN"
}
],
"start_qty": {
"start_on_hand_total": 0,
"start_sellable": 0,
"start_reserved": 0,
"start_unsellable": 0
},
"end_qty": {
"end_on_hand_total": 0,
"end_sellable": 0,
"end_reserved": 0,
"end_unsellable": 0
},
"inbound_qty": {
"inbound_total": 0,
"inbound_my": 0,
"inbound_returned": 0
},
"outbound_qty": {
"outbound_total": 0,
"outbound_sold": 0,
"outbound_returned": 0,
"outbound_disposed": 0
},
"adjust_qty": {
"adjust_total": 0,
"adjust_lost_found": 0,
"adjust_trans_whs": 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 |