GET
List stock levels
Company space For: Stock keeper, Manager · Permission: inventory_levels.list, inventory_stocks.list (only when filtering by label) Conditions
  • stockable_ids is required and holds 1 to 100 distinct 27-character identifiers of items.
  • Only levels held at locations the current company is allowed to use are returned; levels at other locations are silently left out.
  • When stock_label_ids is sent, the caller must also hold the inventory stocks list permission, and every label must exist in the current organization (at most 50 labels).
  • The stocks include is rendered only for a caller who may list inventory stocks, and lot costs additionally need the view-costs permission on stock.
Part of Check stock levels and label lots.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

cursor
string | null

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

per_page
integer | null

Number of items per page.

Required range: 1 <= x <= 100
stockable_ids[]
string[]
required

Required. Identifiers (27-character KSUID strings) of the items whose stock levels are wanted: 1 to 100 distinct values, each an item of the current organization.

Required string length: 27
stock_label_ids[]
string[]
required

Optional. Identifiers of stock labels (27-character KSUID strings, at most 50, distinct, all from the current organization). Keeps only levels that hold at least one lot carrying one of these labels, and limits the lots rendered under stocks to those lots. Needs the inventory stocks list permission.

Required string length: 27
response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, stockable_id, available_quantity, unit_code, organization_id, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: inventoryItem, inventoryItem.stockable, inventoryItem.inventoryLevels, asset, asset.locationGroup, stocks, stocks.vendor, stocks.label.

Response

Resource.

data
InventoryLevelResource · object[]
required

Items of this page.

meta
object
required

Pagination details.