Get Customer Loyalty Details

get

https://{host}/v2/customers/lookup/loyaltyDetails

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

programId

int64

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

source

string

enum

required

Source in which the customer details are available.

accountId

string

For sources with multiple accounts (such as MARTJACK, WECHAT), pass the respective account ID. Not applicable for INSTORE source.

identifierName

string

enum

required

Registered identifier name of the customer with respect to the source.

identifierValue

string

required

Pass the respective identifier value. For example if identifierType is mobile, identifierValue is mobile number.

includedAllFleetGroup

boolean

Defaults to false

Pass true to include loyalty details of all groups. By default, it shows the loyalty details associated with the till.

fleetGroupId

int64

Unique ID of the fleet group to get the customer's loyalty details for a specific group.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200