Skip to main content
GET
List inventory levels

Authorizations

Authorization
string
header
required

Bearer token authentication

Query Parameters

variant_ids
string

Comma-separated variant_ids. Required if warehouse_ids empty

warehouse_ids
string

Comma-separated warehouse_ids. Required if variant_ids empty

published_to
string

Comma-separated values. Canonical values: storefront, mobile_app, portal_shop, share_tab. Legacy aliases are also accepted: retail, rep, portal, share.

product_tags
string

Product tags

available_greater_than
string

Inventory level available greater than

available_less_than
string

Inventory level available less than

unavailable_greater_than
string

Inventory level unavailable greater than

unavailable_less_than
string

Inventory level unavailable less than

committed_greater_than
string

Inventory level committed greater than

committed_less_than
string

Inventory level committed less than

on_hand_greater_than
string

Inventory level on hand greater than

on_hand_less_than
string

Inventory level on hand less than

Search text

Response

string | number | boolean | null | any[] | object

Success

Any valid JSON value for provider, integration, theme, metadata, or other dynamic payloads whose keys are not fixed by the API contract.