Get customer details

get

https://{host}/v1.1/customer/get

Retrieve details of a specific loyalty customer such as loyalty information, subscription status, 10 recent transactions, active coupons, recent store interactions, custom fields, extended fields, and customer’s unique id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

Unique user ID of the customer.

string

Email of the customer

external_id

string

External ID of the customer.

coupon_limit

int32

Limits the number of coupon interactions (issued,redeemed and expired). Example: coupon_limit=5 retrieves five recent coupon interactions.

coupon_offset

int32

Retrieves next set of coupons according to issual sequence. For example, if 10 coupons are issued to a customer till date, then coupon_offset=6, returns the 7th, 8th, 9th, and 10th coupon (ignoring the first 6 coupons).

coupon_order_by

string

enum

On what basis coupon history need to order.

Allowed:

coupon_sort_order

string

enum

Orders coupons in ascending or descending order based on the coupon_order_by value

Allowed:

user_id

boolean

Pass true to fetch unique ID of the customer.

next_slab

boolean

Pass true to get the details of the next loyalty tier of the customer such as next_slab, next_slab_serial_number, next_slab_description, trackers value (for tracker based strategy), and current_nps_status.

slab_history

boolean

Pass true to return the details of loyalty tier changes of the customer.

registered_store

boolean

Pass true to return the store at which the customer is registered. This is returned by default.

registered_till

boolean

Pass true to return the store-TILL at which the customer is registered. This is returned by default.

fraud_details

boolean

Pass true to return the fraud details of a customer. This field is returned by default.

ndnc_status

boolean

Pass true to return the status of the customer’s registered mobile number on NDNC/DND.

optin_status

boolean

Pass true to return the services (SMS/email) to which the customer has opted in and opted out.

expiry_schedule

boolean

Pass true to return the details of points expiry summary with number of points to expire, program ID, and date and time of expiry.

expired_points

boolean

Pass true to return the details of expired points of the customer.

points_summary

boolean

Pass true to return the history of points issued and redeemed

promotion_points

boolean

Pass true to return the history of promotional points issued and redeemed. It also shows the store that issued the points and expiry date for each set of points issued. You can get up to 1000 results (maximum limit).

membership_retention_criteria

boolean

Pass true to return the criteria set for membership or tier retention (usually for membership based loyalty program).

tier_upgrade_criteria

boolean

Pass true to return the tier upgrade criteria configured in tier_update_criteria object of response payload. This is supported only if the tier upgrade strategy is based on Lifetime Points, Lifetime Purchases, or Current Points, but not on tracker based strategy. Also, you will not see upgrade criteria if the customer is in the highest tier.

mlp

boolean

Pass true to return loyalty information of the customer for each loyalty program including the gap to upgrade and gap to renew details. Different program details are applicable only for brands with multiple loyalty programs (MLP).

gap_to_upgrade_for

int32

See the gap after a specific number of days from the current day. Gap is the value of the tier upgrade parameter (purchases/points/tracker) yet to allocate to upgrade the customer’s current tier. Pass 0 to get the gap as of the current day, 1 to get the gap as of the next day, 30 to get the gap as of the 30th day from the current day. The gap might change with days for tracker value based tier upgrade strategy. No negative values are supported.

gap_to_renew_for

int32

See the gap after a specific number of days from the current day. The required value of purchases/visits/points/tracker to renew the tier (as per the configuration in tier downgrade strategy). Pass 0 to get the renewal value as of the current day, 1 to get renewal value as of the next day, 30 to get the renewal value as of the 30th day from the current day. No negative value is supported.

user_group

boolean

Pass true to retrieve the details of user group associated to the user (if available).

customer_image

boolean

Pass true to retrieve the customer’s profile image

transactions

boolean

Pass true to retrieve transactions of the customer.

subscriptions

boolean

Pass true to retrieve the subscription details of the customer.

segments

boolean

Pass true to retrieve the segment details of the customer if applicable. Segments are logical grouping of customers based on one or more parameters.

member_care_access

boolean

Pass true for admin users, it will show customers that are active within the vicinity of that user.

card_details

boolean

Pass true to retrieve the details of all cards of the customer.

tracker_info

boolean

Pass true to retrieve loyalty tracker information of the customer.

delayed_accrual

boolean

Pass true to retrieve the customer's promised points and conversion details.

coupon_active

boolean

Pass true to retrieve all active coupons of the customer.

program_id

int32

Unique ID of the loyalty program to fetch loyalty details of the customer for that particular program.

coupon_offer

int32

Defaults to 0

Unique ID of the coupon series (offer) to include offer details of the customer.

store_code

string

Code of the store

till_code

string

Till code

coupon_org_entity_type

string

enum

Entity type of the coupon series.

Allowed:

coupon_org_entity_value

string

Value of the specified coupon entity type.

coupon_status

string

enum

Get customer coupons of specific status. This is similar to get customer/coupons

Allowed:

program_summary

boolean

Set to true to fetch the active loyalty program details for the customer.

Headers

language

string

Specify the ISO language code to get transaction level extended field details in your preferred language (other than English). For example, zh for Chinese, id for Indonesian, ar for Arabic.

Responses

200200

500500