List inventory positions

Returns a paginated list of inventory positions scoped to the caller account. Filter by one or more exact "sku" (repeatable), free-text "q" matching the SKU (case-insensitive substring, mutually exclusive with "sku") and one or more "strategyCode" (repeatable).

get/api/v1/inventory

Query parameters

skustring[]

qstring

strategyCodestring[]

pagenumber

limitnumber

sortBystring

sortOrderstring

Response

Paginated list of inventory positions.

Example response

{
  "meta": {
    "total": 42,
    "pages": 3,
    "current_page": 1,
    "next_page": 2,
    "limit": 20
  }
}

Changes

Changed in 2 of the 9 revisions of this API.10717

Jul 7, 2026a3b4750a505f17See the full diff
- ○
  added the new optional query request parameter limit
  new-optional-request-parameter
- ○
  added the new optional query request parameter page
  new-optional-request-parameter
- ○
  added the new optional query request parameter q
  new-optional-request-parameter
- ○
  added the new optional query request parameter sku
  new-optional-request-parameter
- ○
  added the new optional query request parameter sortBy
  new-optional-request-parameter
- ○
  added the new optional query request parameter sortOrder
  new-optional-request-parameter
- ○
  added the new optional query request parameter strategyCode
  new-optional-request-parameter
- ○
  added the required property data/items/available to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/blocked to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/created_at to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/id to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/on_hand to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/reserved to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/safety_stock to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/sku to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/strategy_code to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/updated_at to the response with the 200 status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 7, 202684194c31ab85107See the full diff
- ▲
  removed the required property data/items/available from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/blocked from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/created_at from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/on_hand from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/reserved from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/safety_stock from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/sku from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/strategy_code from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property data/items/updated_at from the response with the 200 status
  response-required-property-removed
- ●
  deleted the query request parameter limit
  request-parameter-removed
- ●
  deleted the query request parameter page
  request-parameter-removed
- ●
  deleted the query request parameter q
  request-parameter-removed
- ●
  deleted the query request parameter sku
  request-parameter-removed
- ●
  deleted the query request parameter sortBy
  request-parameter-removed
- ●
  deleted the query request parameter sortOrder
  request-parameter-removed
- ●
  deleted the query request parameter strategyCode
  request-parameter-removed
This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history