Skip to main content
GET
List stock levels

Authorizations

Authorization
string
header
required

An app access token from POST /apps/oauth/token, valid 1 hour. An offline token acts as the app; an online token acts as the app on behalf of one dashboard user (the intersection of both permission sets).

Query Parameters

productId
string

Only the stock items of this product (one per variant).

Pattern: ^\d{1,24}$
storeId
string

Only this store's rows. A store outside the installation's stores is 460 STORE_SCOPE_FORBIDDEN.

Pattern: ^\d{1,24}$
fields
string

Return only these top-level fields, separated by commas; the id is always kept. The response schema describes the whole resource. An unknown name is 400 INVALID_FIELDS. Fields: inventoryItemId, variantId, productId, onHand, inTransit, damaged, low, lowStockThreshold, locations, updatedAt, currency, unitCost.

Maximum string length: 1000
limit
integer

Page size, 1 to 100 (default 50). A value outside that range is 400, never clamped.

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

The nextCursor of the previous page, unchanged, with the same filters. Opaque; bound to this list and its filters (400 INVALID_CURSOR otherwise).

Maximum string length: 512

Response

A page of stock levels.

One page, newest first. Pass nextCursor back as cursor for the next one.

data
object[]
required
nextCursor
string | null
required

Null on the last page.