Promotions
Search promotions
This endpoint can be used to find promotions matching specific criteria.
🔒 Requires: promotions:read scope
get/promotions/search
Query parameters
scope'current_upcoming' | 'past' | 'all'
Scope of the search
namestring
Example:choco
Part of promotion's name being searched
start_timestring
Example:2022-08-29T9:57:52
Only show promotions that have a start time after or equal to this
end_timestring nullable
Example:2023-08-29T9:57:52
Only show promotions that have an end time before or equal to this
outlet_idstring[]
Only show promotions linked to one or many of the outlets specified here
[ "06326976-9d65-11ed-fa40-1347e4b4ae6d" ]
order_by'name' | 'start_date' | 'end_date'
Sort the result by this field
direction'asc' | 'desc'
Sort direction
offsetinteger
Offset
page_sizeinteger
Number of results per page