GET
List inventory levels

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Query Parameters

variant_id
string

One variant's stock across every location.

location_id
string

Everything held at one location.

updated_after
string<date-time>

Levels touched at or after this RFC3339 instant. THIS IS THE LIST WHERE IT MATTERS MOST: a level's created_at is written once, when a variant first stocks at a location, and never again, while its quantity is rewritten by every sale, restock, reservation and transfer. Without this the default ordering is frozen while the data churns, and reconciling stock means re-walking the whole catalogue on a schedule and still being slightly behind. Supplying it CHANGES THE ORDER of this endpoint: the default walk descends created_at, and this one climbs updated_at, which is the only ordering in which a keyset walk over a column this volatile cannot skip a row. A level that moves mid-walk is handed to you again, so the walk is AT LEAST ONCE: apply each row you receive and a repeat costs nothing, while a miss means selling stock that is already gone. The bound is INCLUSIVE, and that matters here more than anywhere: a bulk restock or a transfer commit writes many levels in ONE statement, so they share a single timestamp, and an exclusive bound would drop every one your last page did not reach. A cursor belongs to ONE ordering and is refused by the other.

limit
integer
default:20

Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it.

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

The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page.

Response

Success

data
object[]
page
object