Get inventory available
Endpoint: GET /v10/inventory/available
Available properties for filtering: product_id, variant_id, inventory_location_id, type, created_at, updated_at
Available nested resources for including: inventoryLocation, product, variant
This endpoint will fetch a list of all available inventory in the account.
note
This endpoint only supports cursor pagination. Every response includes has_more and next_cursor, and the response never includes totals. Requests using the page parameter return a 422 validation error — walk the list with limit + cursor (or starting_after) instead.
Data of response
| Parameter | Required | Default | Description |
|---|---|---|---|
inventory_available.* | Yes | An array of object inventory available | |
has_more | Yes | Whether more rows exist after the last row of this page | |
next_cursor | Yes | Opaque token pointing at the last row of this page. null when has_more is false |