v1

latestOpenAPI 3.0.32026-07-243003151.2 MB

Tiers

Search for Tiers

This method allows the calling application to search Loyalty Tiers using query parameters.

get/tiers

Query parameters

idstring Int64

EES AIR Loyalty Tier ID.

status'ACTIVE'

This is a status of a Loyalty Tier.

type'STANDARD'

This is the type of a Loyalty Tier.

referencestring

This is the reference of a Loyalty Tier.

schemeIdstring Int64

EES AIR Scheme ID.

promotionTierIdstring Int64

This is the promotion Loyalty Tier ID.

demotionTierIdstring Int64

This is the demotion Loyalty Tier ID.

offsetinteger

Example:51

Offset allows you to skip a number of items before returning data.

limitinteger

The number of items to return.

orderBy'id,ASC' | 'id,DESC'

Requested result set sorting order.

Headers

X-EES-AUTH-CLIENT-IDstring string required

Client ID, This will be provided by EES and is unique to the company calling the API.

X-EES-AUTH-HASHstring string required

Request Security Hash, calculated using SHA-256 function from concatenated full Request URI Path with Query String(s), Payload and Client Secret

Accept-Encoding'' | 'gzip' | 'deflate' | 'gzip,deflate'

This request HTTP header advertises which content encoding (usually a compression algorithm) the calling application is able to understand. The server selects one of the proposals, use it and informs the client of its choice with the Content-Encoding response header. Currently supported gzip and deflate, if request header not present no compression will be used.

X-EES-TRANSACTION-IDstring string

Unique Reference for the API transaction within the calling company.

X-EES-RETRYstring string

This flag denotes the number of attempts that have been made for this request.

Response

OK.

offsetinteger

The number of Loyalty Tiers skipped when returning the data.

limitinteger

The number of Loyalty Tiers limited in the results, up to a maximum of 100.

totalinteger

The total number of LoyaltyTiers matching your search.

Example response

{
  "limit": 50,
  "total": 1,
  "orderBy": [
    {
      "name": "id",
      "order": "ASC"
    }
  ],
  "results": [
    {
      "id": "1001",
      "type": "STANDARD",
      "status": "ACTIVE",
      "details": {
        "name": "Tier 1",
        "schemeId": "1234",
        "isDefault": false
      },
      "settings": {
        "schemeOverrides": {
          "earnRates": {
            "TestUnitSafeName": {
              "default": {
                "description": null,
                "name": null,
                "product": null,
                "rates": [
                  {
                    "amount": 2,
                    "bonus": null,
                    "ceiling": null,
                    "floor": null,
                    "offset": 0,
                    "step": 1
                  }
                ],
                "reference": null,
                "roundPoints": {
                  "active": false,
                  "toMultipleOf": 1
                },
                "type": "STANDARD"
              }
            }
          },
          "redemptionRates": {
            "TestUnitSafeName": [
              {
                "bonus": 0,
                "ceiling": 5000,
                "floor": 1,
                "pointsBack": 0,
                "rate": 10,
                "step": 2
              }
            ]
          },
          "expiryPoints": {
            "enabled": true,
            "rule": {
              "periodCount": 31,
              "periodType": "DAY",
              "rounding": "ABSOLUTE",
              "type": "CUTOFFDATE"
            }
          }
        },
        "promotion": {
          "promotionTierId": "110",
          "ruleSets": [
            {
              "rules": [
                {
                  "amount": 100,
                  "balanceType": "POINTS"
                }
              ]
            }
          ]
        },
        "demotion": {
          "demotionTierId": "101",
          "balanceResetPeriod": {
            "periodOffset": {
              "periodType": "MONTH",
              "periods": 3
            },
            "roundingRule": "endOfMonth"
          },
          "membershipExpiryPeriod": {
            "periodOffset": {
              "periodType": "MONTH",
              "periods": 6
            },
            "roundingRule": "endOfQuarter"
          },
          "reevaluateTierOnBalanceDebit": {
            "enabled": true
          }
        }
      }
    }
  ]
}