HomeTutorialsAPI ReferenceChangelog
Log In
API Reference

Get Fulfillments Summary

get
https://{domain_prefix}.retail.lightspeed.app/api/2.0/fulfillments

Retrieves a paginated list of fulfillment summary items with optional filtering

🔒 Requires: sales:read and fulfillments:read scopes

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
outlet_id
array of strings

Filter by outlet IDs (can be specified multiple times, e.g. ?outlet_id=1234&outlet_id=5678)

outlet_id
sale_id
array of strings

Filter by sale IDs (can be specified multiple times, e.g. ?sale_id=1234&sale_id=5678)

sale_id
fulfillment_type
array of strings

Filter by fulfillment types (can be specified multiple times, e.g. ?fulfillment_type=PICKUP&fulfillment_type=DISPATCH)

fulfillment_type
Allowed:
fulfillment_state
array of strings

Filter by fulfillment states (can be specified multiple times, e.g. ?fulfillment_state=OPEN&fulfillment_state=STARTED)

fulfillment_state
Allowed:
integer
≥ 1
Defaults to 1

Page number for pagination (1-based)

integer
1 to 100
Defaults to 10

Number of items per page

Responses

400

Bad request

401

Unauthorized

403

Forbidden

Updated 5 months ago

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

Updated 5 months ago

Did this page help you?