Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Tier Membership

Add a Customer into a Tier

This API allows a customer's Loyalty Account to be given a Tier Membership.

post/tier/{tierId}/membership

Path parameters

tierIdstring required

The ID of a Tier defined in Air

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

status'ACTIVE' required
expiryDatestring

DateTime in ATOM format.

tierBalancesResetDatestring

DateTime in ATOM format.

accountIdsstring[] required

An array of accountIds with which to link this Tier Membership.

Example request

{
  "expiryDate": "2024-03-11T16:33:00+00:00",
  "tierBalancesResetDate": "2024-03-11T16:33:00+00:00"
}

Response

The Tier Membership entity which defines the current state of a customer's Tier Membership.

tierMembershipIdstring required

The unique ID for this Tier Membership. This will be a numeric string value of variable length.

tierIdstring required

The ID for the Tier Membership to which the customer belongs. This will be a numeric string value of variable length.

status'ACTIVE' required

The status of this Tier Membership.

accountIdsstring[] required
expiryDatestring required

DateTime in ATOM format.

tierBalancesResetDatestring required

DateTime in ATOM format.

dateCreatedstring required

DateTime in ATOM format.

lastUpdatedstring required

DateTime in ATOM format.

Example response

{
  "expiryDate": "2024-03-11T16:33:00+00:00",
  "tierBalancesResetDate": "2024-03-11T16:33:00+00:00",
  "dateCreated": "2024-03-11T16:33:00+00:00",
  "lastUpdated": "2024-03-11T16:33:00+00:00"
}