Inventory Levels

GET /inventory/inventory-levels

Group: Inventory › Inventory Levels · Operation ID: inventoryLevels

Returns a list of inventory levels. Filter by itemId and locationId together to read the stock of one item at one location.

Each row resolves its item and location, so each row includes the identifier, code and name of both. Page size defaults to 25 and caps at 100. A page size above 100 is reduced to 100, not rejected.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
itemId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
itemCode — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
locationId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
locationCode — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, itemCode, locationCode, onHandQuantity, availableQuantity, onHandValue, lastTransactionTimestamp, lastModifiedDate
Selectable: id, itemId, itemCode, itemName, locationId, locationCode, locationName, onHandQuantity, availableQuantity, allocatedQuantity, reservedQuantity, inTransitQuantity, damagedQuantity, qualityHoldQuantity, averageCost, onHandValue, currency, lastTransactionTimestamp, lastModifiedDate

Response

200 Success

Under data, an array of inventoryLevelsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the inventory level.
`itemId`	string	no	The unique identifier for the item this level is for. See id on GET inventory/items/:id.
`itemCode`	string or null	no	The item's short code.
`itemName`	string or null	no	The item's name.
`locationId`	string	no	The unique identifier for the location this level is at. See id on GET inventory/warehouses/:id.
`locationCode`	string or null	no	The location's short code.
`locationName`	string or null	no	The location's name.
`onHandQuantity`	string (decimal) or null	no	The total physical quantity on hand at this location, in the item's stocking unit of measure.
`availableQuantity`	string (decimal) or null	no	The quantity free to allocate: onHandQuantity minus allocatedQuantity and reservedQuantity.
`allocatedQuantity`	string (decimal) or null	no	The quantity allocated to outbound demand.
`reservedQuantity`	string (decimal) or null	no	The quantity reserved.
`inTransitQuantity`	string (decimal) or null	no	The quantity in transit to this location.
`damagedQuantity`	string (decimal) or null	no	The quantity flagged as damaged.
`qualityHoldQuantity`	string (decimal) or null	no	The quantity on quality hold.
`averageCost`	string (decimal) or null	no	The moving-average unit cost, in the currency given by currency.
`onHandValue`	string (decimal) or null	no	The value of the stock on hand, in the currency given by currency.
`currency`	string or null	no	The currency of averageCost and onHandValue. Format ISO 4217, for example 'EUR'. Absent when the level has no valuation yet.
`lastTransactionTimestamp`	string (date-time) or null	no	The date and time a stock movement last touched this level. Format YYYY-MM-DDTHH:mm:ss. Unlike lastModifiedDate, it changes only when stock moves.
`lastModifiedDate`	string (date-time) or null	no	The date and time the inventory-level record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error