Glossary - Loyalty
GET Customer
| Parameters | Meaning | Type |
|---|---|---|
firstName * | The given name of a person | string |
lastName * | The family or surname of a person | string |
email * | The unique electronic mail address of a person | string |
phoneNumber * | The contact number of a person, including country and area codes | string |
dateOfBirth | The birth date of a person in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.ssssss±HH:MM) | string |
balance * | The total loyalty points available for a person | integer |
acceptedTCAt * | The date and time when the person accepted the Terms and Conditions, in ISO 8601 format | string |
GET Loyalty Programs
| Parameters | Meaning | Type |
|---|---|---|
programId * | The unique identifier for the loyalty program | string |
title * | The name or designation of the loyalty program | string |
description | A brief overview or details about the loyalty program, outlining its features and benefits | string |
cost * | The number of loyalty points required for a customer to redeem or participate in a particular offer or reward within the loyalty program | integer |
type * | The category or nature of the loyalty program reward, such as a discount, free item, or special offer (e.g., buy one, get one free) | string |
discount * | The fixed amount of price reduction a person can receive through the loyalty program | integer |
applicable * | Indicates whether the loyalty program can be applied or not | boolean |
itemPLU | The unique product identifier (PLU) for the item that can be redeemed for free through the loyalty program | string |
media | Indicates if there is an image or visual associated with the loyalty program for display | object |
url | The web address used to retrieve the image associated with the loyalty program | string |
mediaType | Specifies the type of media or file format associated with the loyalty program | string |
GET Loyalty Tiers
| Parameters | Meaning | Type |
|---|---|---|
name * | The name of the loyalty tier, such as Gold, Silver, or Bronze | string |
description | A brief overview or details about the loyalty tier | string |
media | Indicates if there is an image or visual associated with the loyalty tier | object |
url | The web address used to retrieve the image associated with the loyalty Tier | string |
mediaType | Specifies the type of media or file format associated with the loyalty tier | string |
