API Reference

Search promotions

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

This endpoint can be used to find promotions matching specific criteria.

🔒 Requires: promotions:read scope

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

Scope of the search

Allowed:
string

Part of promotion's name being searched

string

Only show promotions that have a start time after or equal to this

string | null

Only show promotions that have an end time before or equal to this

outlet_id
array of strings

Only show promotions linked to one or many of the outlets specified here

outlet_id
string
enum
Defaults to name

Sort the result by this field

Allowed:
string
enum
Defaults to desc

Sort direction

Allowed:
integer
Defaults to 1

Offset

integer
Defaults to 1000

Number of results per page

Response

Updated 3 months 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 3 months ago