v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Loyalty Details

Retrieves the loyalty information of a customer across all loyalty programs of the org . You can also fetch details of a specific loyalty program.

get/customers/{customerId}/loyaltyDetails

Path parameters

customerIdinteger required

Unique ID of the customer to fetch loyalty details.

Query parameters

programIdinteger

Unique ID of the program to get loyalty details of a specific program.

fleetgroupIdstring

Filters results by fleet group identifier and maps internally to userGroup2Id.

includedAllFleetGroupstring

When enabled true, the response will include all fleet groups associated with the user through the userGroup2Id field.

Response

200

Example response

{
  "data": [
    {
      "redeemed": 40.11,
      "lifetimePoints": 1050,
      "loyaltyPoints": 1009.89,
      "cumulativePurchases": 9500,
      "loyaltyId": 86637581,
      "currentSlab": "SILVER",
      "nextSlab": "GOLD",
      "nextSlabSerialNumber": 2,
      "nextSlabDescription": "GOLD",
      "slabSNo": 1,
      "slabExpiryDate": "2120-11-10T23:59:59+05:30",
      "programId": 622,
      "delayedReturnedPoints": 250,
      "totalAvailablePoints": 1009.89,
      "totalReturnedPoints": 250,
      "linkedPartnerPrograms": [
        {
          "partnerProgramId": 5,
          "partnerProgramName": "1stProgram",
          "partnerProgramDescription": "1stProgram",
          "partnerTierNumber": 1,
          "partnerTierName": "1stSlab",
          "partnerTierExpiryDate": "2022-12-29T23:59:59+05:30",
          "partnerMembershipId": "916215776456",
          "partnerProgramType": "EXTERNAL",
          "tierBased": true
        }
      ]
    }
  ]
}