v1

latestOpenAPI 3.0.32026-07-173196215.4 KB

promotions

List promotions

Retrieve promotions

get/v1/promotions

Query parameters

idsstring[]

Retrieve results with id matching specified ids, for example, ids=abc123,def456.

activeAtstring

Retrieve all active promotions falling within the specified active range.

Note: The provided value should be datetime in the RFC3339 format: "2020-10-13T00:00:00Z"

shopIdstring required

In case you are operating multiple shops (for example, for different domain names or different languages), each shop is identified by its specific shopId

pageinteger

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

perPageinteger

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

Response

request successful

Example response

{
  "entities": [
    {
      "id": "651cb0bec0b00af2d4dbf610",
      "name": "Promotion_Name_Example",
      "schedule": {
        "from": "2023-01-26T09:30:15+00:00",
        "to": "2023-01-26T09:30:15+00:00"
      },
      "effect": {
        "type": "automatic_discount",
        "additionalData": {
          "type": "relative",
          "value": 20.5
        }
      },
      "conditions": [
        {
          "level": "global",
          "key": "condition_key",
          "condition": "condition description"
        }
      ],
      "customData": {
        "customLabel": "customValue"
      },
      "tiers": [
        {
          "id": 1,
          "name": "Tier 1",
          "MOV": 30000,
          "effect": {
            "additionalData": {
              "type": "relative",
              "value": 60
            }
          }
        }
      ]
    }
  ]
}