v1
latestOpenAPI 3.0.12026-07-24501176.6 MBGet customer details
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.
Query parameters
Unique user ID of the customer.
Email of the customer
External ID of the customer.
Limits the number of coupon interactions (issued,redeemed and expired). Example: coupon_limit=5 retrieves five recent coupon interactions.
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).
On what basis coupon history need to order.
Orders coupons in ascending or descending order based on the coupon_order_by value
Pass true to fetch unique ID of the customer.
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.
Pass true to return the details of loyalty tier changes of the customer.
Pass true to return the store at which the customer is registered. This is returned by default.
Pass true to return the store-TILL at which the customer is registered. This is returned by default.
Pass true to return the fraud details of a customer. This field is returned by default.
Pass true to return the status of the customer’s registered mobile number on NDNC/DND.
Pass true to return the services (SMS/email) to which the customer has opted in and opted out.
Pass true to return the details of points expiry summary with number of points to expire, program ID, and date and time of expiry.
Pass true to return the details of expired points of the customer.
Pass true to return the history of points issued and redeemed
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).
Pass true to return the criteria set for membership or tier retention (usually for membership based loyalty program).
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.
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).
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.
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.
Pass true to retrieve the details of user group associated to the user (if available).
Pass true to retrieve the customer’s profile image
Pass true to retrieve transactions of the customer.
Pass true to retrieve the subscription details of the customer.
Pass true to retrieve the segment details of the customer if applicable. Segments are logical grouping of customers based on one or more parameters.
Pass true for admin users, it will show customers that are active within the vicinity of that user.
Pass true to retrieve the details of all cards of the customer.
Pass true to retrieve loyalty tracker information of the customer.
Pass true to retrieve the customer's promised points and conversion details.
Pass true to retrieve all active coupons of the customer.
Unique ID of the loyalty program to fetch loyalty details of the customer for that particular program.
Unique ID of the coupon series (offer) to include offer details of the customer.
Code of the store
Till code
Entity type of the coupon series.
Value of the specified coupon entity type.
Get customer coupons of specific status. This is similar to get customer/coupons
Set to true to fetch the active loyalty program details for the customer.
Headers
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.
Response
200
Example response
{
"response": {
"status": {
"success": "true",
"code": 200,
"message": "Success",
"total": "1",
"success_count": "1"
},
"customers": {
"customer": [
{
"firstname": "Rita",
"lastname": "John",
"mobile": "44700900999",
"email": "rita.john@example.com",
"external_id": "XYPZ006",
"lifetime_points": 500,
"loyalty_points": 500,
"current_slab": "Member Tier ",
"registered_on": "2012-09-11 11:11:15",
"updated_on": "2022-02-18 08:22:34",
"type": "LOYALTY",
"source": "instore",
"registered_by": "Hamilton",
"registered_store": {
"code": "webstore",
"name": "Hamilton"
},
"registered_till": {
"code": "Mobile App",
"name": "bukl.ind.solution"
},
"fraud_details": {
"status": "NONE"
},
"extended_fields": {
"field": [
{
"name": "gender",
"value": "Female"
}
]
},
"item_status": {
"success": "true",
"code": "1000",
"message": "Customer successfully retrieved"
}
}
]
}
}
}