VOvoucherifyio
Promotions

List Promotion Tiers from Campaign

This method enables you to list promotion tiers from a specified campaign.

get/v1/promotions/{campaignId}/tiers

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v1/promotions/{campaignId}/tiers
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or OAuth 2
      Implicit: https://api.voucherify.io/v1/oauth/token
      Scopes: api, promotions

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"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.