Glossary - Loyalty

Please note that all the fields marked with ( * ) will always be present in the response payload.

GET Customer

ParametersMeaningType
firstName * The given name of a personstring
lastName * The family or surname of a personstring
email * The unique electronic mail address of a personstring
phoneNumber * The contact number of a person, including country and area codesstring
dateOfBirthThe 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 personinteger
acceptedTCAt * The date and time when the person accepted the Terms and Conditions, in ISO 8601 formatstring

GET Loyalty Programs

ParametersMeaningType
programId * The unique identifier for the loyalty programstring
title * The name or designation of the loyalty programstring
descriptionA brief overview or details about the loyalty program, outlining its features and benefitsstring
cost * The number of loyalty points required for a customer to redeem or participate in a particular offer or reward within the loyalty programinteger
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 programinteger
applicable * Indicates whether the loyalty program can be applied or notboolean
itemPLUThe unique product identifier (PLU) for the item that can be redeemed for free through the loyalty programstring
mediaIndicates if there is an image or visual associated with the loyalty program for displayobject
urlThe web address used to retrieve the image associated with the loyalty programstring
mediaTypeSpecifies the type of media or file format associated with the loyalty programstring

GET Loyalty Tiers

ParametersMeaningType
name * The name of the loyalty tier, such as Gold, Silver, or Bronzestring
descriptionA brief overview or details about the loyalty tierstring
mediaIndicates if there is an image or visual associated with the loyalty tierobject
urlThe web address used to retrieve the image associated with the loyalty Tierstring
mediaTypeSpecifies the type of media or file format associated with the loyalty tierstring