Skip to main content

v2.sbs.get_stock_movement

GET /api/v2/sbs/get_stock_movement

Get Seller Center,Stock Movement page data

Endpoint URL

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

Common Request Parameters

NameTypeSampleDescription
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

Request Parameters

NameTypeRequiredSampleDescription
page_noint32False1Specifies 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_sizeint32False10Each 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_timestringTrue2025-02-01Start 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_timestringTrue2025-02-24End 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_idsstringFalseIDL,IDGMultiple warehouse_id values should be separated by commas.
category_id_l1int64False100002L1-level category_id. You need to call the get_category API to retrieve the first-level category_id.
sku_idstringFalse900626944_15359986
item_idstringFalse900626944
item_namestringFalseProduct Name Filter
variationstringFalse
whs_regionstringTrueCNWarehouse 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"

Response Parameters

NameTypeSampleDescription
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.
totalint323
start_timestring2025-02-01
end_timestring2025-02-24
query_end_timestring2025-02-24
item_listobject[]Data list of item sku
warehouse_item_idstring900626944Warehouse item id; To indicate an unique item in a warehouse one warehouse item id can match with multiple shop_item_id
item_namestring跨境商品测试00002 - 1666171567item name
item_imagestringhttp://img.ws.mms.shopee.sg/08b3fc410c8eaa7e3f52b06b486a8658item image
sku_listobject[]Data list of mtsku
mtsku_idstring900626944_15359986mtsku id
model_idstring15359986model sku id
variationstringOrange,Large
fulfill_mapping_modeint3200-Null;1-Bundle SKU;2-Parent SKU
barcodestring11fsfsf
whs_listobject[]Info of whs
whs_idstringCNNWhs id
start_on_hand_totalint6450Total warehouse inventory at the start time
inbound_totalint640Inbound quantity to the warehouse during the selected time period.
outbound_totalint640Outbound quantity from the warehouse during the selected time period
adjust_totalint640Inventory adjustment quantity in the warehouse during the selected time period
end_on_hand_totalint6450Total warehouse inventory at the end time.
start_qtyobjectInventory information at the start time.
start_on_hand_totalint6450sku number at the start time
start_sellableint6447Number of sellable SKUs at the start time
start_reservedint643Number of reserved SKUs at the start time.
start_unsellableint640
end_qtyobject
end_on_hand_totalint6450Total inventory at the end time.
end_sellableint6447
end_reservedint643
end_unsellableint640
inbound_qtyobjectInbound information during the selected time period
inbound_totalint640Total inbound quantity during the selected time period
inbound_myint640Total merchant procurement quantity during the selected time period.
inbound_returnedint640Total number of SKUs returned by buyers and received into the warehouse during the selected time period.
outbound_qtyobject
outbound_totalint640Total outbound quantity during the selected time period.
outbound_soldint640"Total sold quantity during the selected time period."
outbound_returnedint640Total merchant return quantity during the selected time period.
outbound_disposedint640Total disposal quantity during the selected time period.
adjust_qtyobject"SKU change information during the selected time period."
adjust_totalint640"Total number of SKU changes during the selected time period."
adjust_lost_foundint640"Total quantity of lost or recovered items during the selected time period."
adjust_trans_whsint640Total quantity of transfer orders created by the warehouse during the selected time period
shop_sku_listobject[]
shop_sku_idstringshop level sku_id shop_sku_id="item_id" _ "model_id"
shop_item_idstringshop_item_id="item_id" in Product Module
shop_model_idstringshop_model_id= item level model_id

No Request Example Set.