API Reference

List inventory records for a single product

get deprecated
https://{domain_prefix}.retail.lightspeed.app/api/2026-01/inventory/

DEPRECATED Please use GET /api/2026-04/inventory/{product_id} instead.

Returns inventory records for a single product at all outlets.

🔒 Requires: inventory:read scope

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The product id

Query Params
int64

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

int64

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

integer
≤ 5000
Defaults to 1000

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

boolean
Defaults to false

Whether to include variant children of product_id in the response.

boolean
Defaults to false

Whether to include inventory records for deleted products.

string
enum
Defaults to asc

Whether to order the results ascending or descending by version.

Allowed:
Response

Updated 2 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?