GET
List stock of an item
Company space For: Stock keeper, Manager · Permission: inventory_stocks.list Conditions
  • Only levels at locations the current company is allowed to use are returned.
  • Only levels that hold at least one lot are returned; with stock_label_ids, only levels holding a lot with one of those labels.
  • stock_label_ids holds at most 50 distinct labels of the current organization.
  • Lot costs are shown only to a caller with the view-costs permission on stock; the supplier is shown only when it belongs to the current company.
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.

Path Parameters

stockable
string
required

Identifier of the sellable item (stockable): the stockable record of a product variant or of a bundle, not the variant or bundle identifier itself.

Query Parameters

per_page
integer

Number of items per page.

Required range: 1 <= x <= 100
cursor
string

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.

asset_id
string

Optional. Identifier of a location (27-character KSUID string); keeps only the stock level held at that location.

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

Optional. Identifiers of stock labels (27-character KSUID strings, at most 50, distinct, from the current organization). Keeps only levels holding a lot with one of these labels and limits the listed groups to those lots.

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: asset_id, level_id, asset_name.

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: stocks, stocks.label.

Response

Resource.

data
StockableStockLevelResource · object[]
required

Items of this page.

meta
object
required

Pagination details.