List inventory records for a single product

get

https://{domain_prefix}.retail.lightspeed.app/api/2026-07/inventory/{product_id}

Returns inventory records for a single product at all outlets.

🔒 Requires: inventory:read scope

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

product_id

string

required

The product to fetch inventory levels for. When combined with variants: true, it's treated as a root product
ID and matches all variants of that product; otherwise it matches the exact product.

Query Params

after

int64

The lower limit for the version numbers to be included in the response.

before

int64

The upper limit for the version numbers to be included in the response.

page_size

integer

≤ 5000

Defaults to 1000

The maximum number of items to be returned in the response.

variants

boolean

Defaults to false

When true (and product_id is set), matches all variant products sharing the same root_product_id, rather
than just the exact product.

include_deleted

boolean

Defaults to false

Whether to include inventory records for deleted products.

order_direction

string

enum

Defaults to asc

Whether to order the results ascending or descending by version.

Allowed:

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200