v1
latestOpenAPI 3.0.32026-07-173196215.4 KBList campaigns
This endpoint shows all campaigns that are available for the shop. Campaigns are used to allow temporary discounts on products. After the indexing process completes, campaign details become immediately available. However, developers should be cautious. Before displaying a campaign, always validate the 'start_at' and 'end_at' fields. Failure to do so might result in campaigns displaying earlier than intended.
Query parameters
Sort results by specified sort type. When no sort is specified, results will be sorted by campaign id.
Sort results in the specified direction (asc for ascending or desc for descending).
Return results for page (for example, page=2).
Return perPage number of results per page (for example, perPage=25).
Return limit results per page (for example, limit=25). Using this parameter is exclusive with both page and perPage and is meant to be used with offset parameter. It will transform the pagination response.
Skips first offset results. Using this parameter is exclusive with both page and perPage and is meant to be used with limit parameter. It will transform the pagination response.
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"
}
]
}