v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Promotions

List promotions

This endpoint lists all promotions for a retailer.

There are optional query parameters that allow filtering promotions. They can't be combined:

  • end_time_from - only show promotions that have end_time after or equal to this time
  • end_time_to - only show promotions that have end_time before this time

For example. the time format for end_time_from and end_time_to are: 2047-06-21T13:00:00

🔒 Requires: promotions:read scope

get/promotions

Query parameters

end_time_tostring

Upper limit for the promotion end date as UTC timestamp. Format: 2020-08-08T12:00:00Z.

end_time_fromstring

Lower limit for the promotion end date as UTC timestamp. Format: 2020-08-08T12:00:00Z.

page_sizeinteger

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

Response