v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB

Promotions

List Promotion Tiers

This method enables you to list promotion tiers.

get/v1/promotions/tiers

Query parameters

is_availableboolean

This parameter allows filtering promotions that are only available at the moment. When set to true, it selects only non-expired and active promotions.

limitinteger

Limits the number of objects to be returned. The limit can range between 1 and 100 items.

pageinteger

Which page of results to return. The lowest value is 1.

order'created_at' | '-created_at' | 'updated_at' | '-updated_at'

Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.

Response

Returns a dictionary with a tiers property that contains an array of promotion tiers.

objectstring

The type of the object represented by JSON. This object stores information about promotion tiers in a dictionary.

data_refstring

Identifies the name of the attribute that contains the array of promotion tier objects.

totalinteger

Total number of promotion tiers.

has_moreboolean

As query results are always limited (by the limit parameter), the has_more flag indicates if there are more records for given filter parameters. This lets you know if you can run another request to get more records returned in the results.

Example response

{
  "tiers": [
    {
      "id": "promo_63fYCt81Aw0h7lzyRkrGZh9p",
      "created_at": "2021-12-15T11:34:01.333Z",
      "updated_at": "2022-02-09T09:20:05.603Z",
      "campaign": {
        "start_date": "2022-09-22T00:00:00.000Z",
        "expiration_date": "2022-09-30T00:00:00.000Z",
        "validity_timeframe": {
          "duration": "PT1H",
          "interval": "P2D"
        },
        "validity_hours": {
          "daily": [
            {
              "start_time": "12:00",
              "expiration_time": "14:00"
            }
          ]
        },
        "category_id": "cat_0b688929a2476386a6"
      },
      "start_date": "2022-09-23T00:00:00.000Z",
      "expiration_date": "2022-09-26T00:00:00.000Z",
      "validity_timeframe": {
        "duration": "PT1H",
        "interval": "P2D"
      },
      "validity_hours": {
        "daily": [
          {
            "start_time": "12:00",
            "expiration_time": "14:00"
          }
        ]
      },
      "validation_rule_assignments": {
        "data": [
          {
            "id": "asgm_74F7QZoYbUoljwQO",
            "rule_id": "val_4j7DCRm2IS59",
            "related_object_id": "v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT",
            "created_at": "2022-02-17T08:18:15.085Z"
          }
        ]
      },
      "category_id": "cat_0c9da30e7116ba6bba",
      "categories": [
        {
          "created_at": "2022-07-14T10:45:13.156Z",
          "updated_at": "2022-08-16T10:52:08.094Z"
        }
      ]
    }
  ]
}