Sign in
campaigns

Get all campaigns

Show all campaigns available for the shop

get/v1/campaigns

Query parameters

sort'id' | 'reduction' | 'start_at' | 'end_at'

Sort results by specified sort type. When no sort is specified, results will be sorted by campaignId.

sortDir'asc' | 'desc'

Sort results in the specified direction (asc for ascending or desc for descending).

pageinteger

Return results for page (for example, page=2).

perPageinteger

Return perPage results per page (for example, perPage=25).

Response

successful operation

Example response

{
  "entities": [
    {
      "id": 20201,
      "name": "Summer_Campaign",
      "description": "10% discount for all summer products",
      "reduction": 10,
      "start_at": "2021-04-13T08:45:00+00:00",
      "end_at": "2021-05-13T08:45:00+00:00"
    }
  ]
}

Changes