Admin APIInventory
Get a variant's stock per location
Totals, the stock at every active location of the store (zero-filled, so
a client can offer any location as a target), incoming purchase-order
units, the reorder settings, and who owns the store's stock. After a
barcode scan, GET /stores/{store_id}/variants/lookup?code= gives the
variant id.
Authorization
bearer_auth AuthorizationBearer <token>
Authorization: Bearer <token>. Either a session access token from POST /auth/login (refresh it with POST /auth/refresh) or a store API token (mobi_st_…). A store API token works only for the store it was issued in, and can do at most what its issuing user can there, narrowed to the scopes it was issued with.
In: header
Path Parameters
store_id*string
Store id
Format
uuidvariant_id*string
Variant id
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08/variants/497f6eca-6276-4993-bfeb-53cbbbba6f08/stock"{
"available": 0,
"barcode": "string",
"buildable": 0,
"incoming": 0,
"limiting_sku": "string",
"name": "string",
"on_hand": 0,
"product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
"product_title": "string",
"reorder_point": 0,
"reorder_quantity": 0,
"reserved": 0,
"sku": "string",
"stock_by_location": [
{
"available": 0,
"is_active": true,
"is_default": true,
"location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
"location_name": "string",
"on_hand": 0,
"reserved": 0
}
],
"stock_owner": "string",
"stock_owner_name": "string",
"uses_components": true,
"variant_id": "8a2d415d-59aa-4132-bef3-011f97c4a0f6"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}