List inventory records

post

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

Returns a paginated list of inventory records.

🔒 Requires: inventory:read scope

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body 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.

include_deleted

boolean

Defaults to false

Whether to include inventory records for deleted products.

product_id

uuid

Optional filter to restrict results to the specified product. 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.

size

int64

≤ 5000

Defaults to 1000

The maximum number of inventory records to return.

sort_direction

string

enum

Defaults to desc

Whether to sort the response by ascending or descending.

Allowed:

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.

Response

Language

Credentials

Bearer

URL

Loading…

Response

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

application/json

200