/
v3.0.11Get access

getLoyaltyGroupsv2

Retrieve the list of loyalty program groups with their levels

Request parameters:

Name
DescriptionTypeValuesDefault
language
The language of datastringSupported Languages-
useWebp
Whether to return WebP versions of imagesbooleantrue / falsefalse

Parameters marked with must be included in the request

Call example:

getLoyaltyGroups()

Response examples:

{
  data: [{
    id: 5400,
    alias: 'Crystal',
    levelColor: '#000000',
    src: '/storage/medias/romania-certification-18754351/loyalty_point_18754351_ec1db59728428658ca83843c5de38e46.png',
    title: 'Crystal',
    description: '',
    items: [{
      id: 55057,
      alias: '1',
      order: 1,
      minPoint: 0,
      maxPoint: 1,
      title: 'Crystal 1'
    }]
  }],
  status: 'loaded',
  message: '',
  hasError: false,
  isLoading: false
}

Response parameters:

NameDescriptionTypeValues
data
List of loyalty groupsarray-
└─ name
Name of the loyalty groupstring-
└─ alias
Unique alias/slug for the loyalty groupstring-
└─ title
Display title of the loyalty groupstring-
└─ src
Image path of the loyalty groupstring-
└─ levelColor
Color associated with the group's levelsstring-
└─ items
List of levels belonging to the loyalty grouparray-
└─ id
Unique identifier of the levelnumber-
└─ order
Order of the level within the loyalty programnumber-
└─ title
Title of the levelstring-
└─ minPoint
Minimum loyalty points required for the levelnumber-
└─ maxPoint
Maximum loyalty points for the levelnumber-