docs
  1. Admin Api
  2. Resources
  3. Promotions
  4. List Promotions

List promotions

Get promotions for given filters

Query Parameters

ParameterDetails
filters[id]
Array of strings
string
filters[name]
string
Example:
entity name
filters[companyId]
Array of integers
integer
filters[activeAt]
string
Example:
2021-01-23T11%3A30%3A58%2B00%3A00
filters[shopCountryId]
Array of integers
integer
filters[status]
Array of strings
string
Enum:
active
inactive
archived
filters[effect]
string
Enum:
buy_x_get_y
automatic_discount
combo_deal
filters[audienceId]
Array of strings
string
filters[activationType]
string
Enum:
automatic
code
filters[promotionCodes]
Array of strings
string
filters[itemSetIds]
Array of strings
string
with
Array of strings
string
Enum:
customData
limit
  • Minimum: 1
  • Maximum: 1000
integer
Default:
100
cursor
string

Responses

200
List of promotions.
application/json
Success
Array of object
object
401
Unauthorized
application/json
Error
403
Forbidden
application/json
Error
500
Service unavailable error
application/json
Error
GET/promotions

Request samples

Response samples

200
Promotion:
Content type: application/json
Provide Feedback