Sign in
Tiers

Create Tier

This method allows the calling application to create a Loyalty Tier.

post/tiers

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.

Request body

typeType required— unresolved $ref
statusStatus required— unresolved $ref
referenceReference — unresolved $ref
detailsDetails required— unresolved $ref

Response

OK.

idId — unresolved $ref
typeType — unresolved $ref
statusStatus — unresolved $ref
referenceReference — unresolved $ref
detailsDetails — unresolved $ref
dateCreatedDateCreated — unresolved $ref
lastUpdatedLastUpdated — unresolved $ref

Example response

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

Changes