API Reference

List consignments

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

Return a paginated list of consignments.

🔒 Requires: consignments:read scope

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

The consignment type to search for.

Allowed:
string
enum

The consignment status to search for.

uuid

Filter response by the ID of the outlet associated with the consignments.

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

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

Response

Updated 9 days ago

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 9 days ago