List inventory levels

post

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

Returns a paginated list of inventory levels.

🔒 Requires: inventory:read scope

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

group_variants

boolean

Defaults to false

If filtering by root_product_ids and group_variants is true, one aggregated level will be returned
for each variant family at each outlet.

include_composites

boolean

Defaults to false

Include composite products in the response.

include_inactive

boolean

Defaults to false

Include inactive products in the response.

location_ids

array of uuids

length ≤ 1000

Optional outlet IDs to filter response by.

location_ids

offset

int64

Defaults to 0

How many inventory levels to skip.

product_ids

array of uuids

length ≤ 1000

Optional product IDs to filter response by. Mutually exclusive with root_product_ids. When omitted, returns inventory levels for all products.

product_ids

root_product_ids

array of uuids

length ≤ 1000

Optional root product IDs to filter response by. Mutually exclusive with product_ids. When omitted, returns inventory levels for all products.

root_product_ids

size

int64

≤ 10000

Defaults to 100

How many inventory levels to return.

sort_direction

string

enum

Defaults to desc

Whether to sort the response ascending or descending.

Allowed:

sort_type

string

enum

Defaults to total_count

Which response field to sort by.

Allowed:

supplier_ids

array of uuids

length ≤ 1000

Optional supplier IDs to filter response by.

supplier_ids

to_be_procured_only

boolean

Defaults to false

Only include inventory with a positive quantity to procure.

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