Skip to main content
GET
List inventory levels

Authorizations

Authorization
string
header
required

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

Headers

Request-ID
string

Optional client-supplied request identifier. When provided and matching the validation pattern, the value is echoed back in the Request-ID response header. Otherwise the server generates one. Use this to correlate requests between client and server when reporting issues.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9._-]{1,64}$

Path Parameters

teamUuid
string<uuid>
required

Team uuid. All resources are scoped to this team.

Query Parameters

sku
string

Filter inventory levels by SKU.

Minimum string length: 1
bin
string

Filter inventory levels by bin location.

Minimum string length: 1
page
integer
default:1

Page number, starting at 1. Omit it to retrieve the first page.

Required range: x >= 1
per_page
integer
default:50

Number of items per page.

Required range: 1 <= x <= 200

Response

Paginated list of inventory levels.

data
object[]
required

Navigation links for a page-paginated collection. URLs preserve the selected filters and page size. First and last URLs are present even when the collection is empty; unavailable previous and next pages are null.

meta
object
required

Page pagination metadata, including total count and the navigation window.