v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Customer Tier

Retrieves tier details of a customer for a single program or across all programs of the org.

This is a light API.

get/customers/{userId|/tierDetails

Path parameters

userIdinteger required

Unique ID of the customer whose tier details need to be fetched.

Query parameters

programIdinteger

Unique ID of the loyalty program from which tier details need to retrieve. If not passed, it shows the points balance in the default program.

entityType'CUSTOMER' | 'FLEET'

Pass CUSTOMER to fetch tier details of the individual, FLEET to fetch details of the user group. Default value is CUSTOMER.

fetchDataForAllProgramsboolean

Pass true to fetch tier details from all the available programs of the org.

Headers

X-CAP-API-OAUTH-TOKENstring

Response

200

entityIdinteger

entityTypestring

Example response

{
  "entityId": 374844123,
  "entityType": "CUSTOMER",
  "programTiers": [
    {
      "programId": 1933,
      "currentTierName": "C",
      "currentTierSerialNumber": 3,
      "tierExpiryDate": "2022-05-02 23:59:59",
      "nextTierSerialNumber": -1
    }
  ]
}