Get 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.

❗️

Make sure you have the appropriate access control configured. For more information, see access group documentation.

API endpoint

/v1.1/customer/get

Request Query Parameters

ParameterTypeDescription
idintUnique id of the transaction to fetch.
emailstringEmail ID of the customer.
external_idstringExternal ID of the customer.
card_numberlongCard number associated with the customer.
card_external_idstringExternal ID of the card associated with the customer.
numberintUnique transaction number that want to fetch.
store_codestringFetch the transactions of a specific store. Pass the store code.
till_codestringFetch the transactions of a specific TILL. Pass the respective TILL code.
amountlongFilter transactions of a specific amount.
datedateFilter transactions of a specific date. Pass the date in YYYY-MM-DD format.
typestringFilter transactions of a specific type. Values: REGULAR, NOT_INTERESTED, RETURN, NOT_INTERESTED_RETURN, MIXED, NI_MIXED, ALL (to retrieve any transaction type, for mixed or NI mixed, it retrieves both transaction and return details). By default it shows the details of regular transaction.
tendersbooleanPass true to retrieve transaction details.
credit_notesbooleanPass true to retrieve credit notes.
user_idbooleanPass true to retrieve unique ID of the customer in response.
coupon_limitintLimits the number of coupon interactions (issued, redeemed, and expired). For example, setting it to 5 retrieves the five most recent coupon interactions.
coupon_offsetintRetrieves the next set of coupons according to the issuance sequence. For instance, if a customer has received 10 coupons to date, setting this parameter to 6 will return details of the 7th to 10th coupons, ignoring the first 6.
coupon_order_byenumDetermines the basis for ordering the coupon history. Possible values: created_date (default), created_by, valid_till.
coupon_sort_orderenumOrders coupons in ascending or descending order based on the coupon_order_by value. Possible values: asc, desc (default).
next_slab-Returns details of the customer's next loyalty tier, including next slab, next slab serial number, next slab description, trackers value (for tracker-based strategies), and current NPS status.
slab_historybooleanReturns the customer's loyalty tier change history.
registered_store-Returns the store where the customer registered. This is returned by default.
registered_till-Returns the specific store-TILL where the customer registered. This is returned by default.
fraud_details-Returns the customer's fraud details. This is returned by default.
ndnc_status-Returns the NDNC/DND status of the customer’s registered mobile number.
optin_status-Returns the services (SMS/email) the customer has opted in or out of.
expiry_schedule-Returns a summary of the customer's points expiry details, including the number of points set to expire, the program ID, and the date and time of expiry.
expired_points-Returns details of the customer's expired points.
points_summary-Returns the customer's points issuance and redemption history.
promotion_points-Returns the customer's promotional points issuance and redemption history, including the issuing store and expiry dates for each set of issued points. Up to 1000 results can be retrieved (maximum limit).
membership_retention_criteria-Returns the criteria set for membership or tier retention, typically for membership-based loyalty programs.
tier_upgrade_criteria-Returns the tier upgrade criteria configured in the tier_update_criteria object of the response payload. This is supported only for tier upgrade strategies based on Lifetime Points, Lifetime Purchases, or Current Points, but not for tracker-based strategies. It is not available if the customer is in the highest tier.
mlpbooleanRetrieves the customer's loyalty information for each loyalty program, including details on the gaps to upgrade and renew. This is applicable only for brands with multiple loyalty programs (MLP).
gap_to_upgrade_forintPrerequisite: Make sure that you set the mlp=true query parameter to retrieve the details.
This parameter indicates the additional purchases, points, visits, or tracker value required for a customer to upgrade to the next tier. It calculates this based on a specified number of days from the current date. Use the parameter as follows:

- Set it to 0 to determine the gap for the current day.
- Set it to 1 to forecast the next day.
- Set it to 30 for a projection 30 days from the current day.
Negative values are not supported.
gap_to_renew_forintPrerequisite: Make sure that you set the mlp=true query parameter to retrieve the details.
This parameter indicates the additional purchases, visits, points, or tracker value required for a customer to renew their tier after a specified number of days from the current date. Use the parameter as follows:

-Set it to 0 to determine the renewal value for the current day.
-Set it to 1 to forecast the next day.
-Set it to 30 for a projection 30 days from the current day.
Negative values are not supported.
user_group-Retrieves details of the user group associated with the user, if available.
customer_image-Retrieves the customer’s profile image.
transactions-Retrieves the customer's transaction details.
subscriptions-Retrieves the customer's subscription details.
segments-Retrieves details of the customer's segments, if applicable. Segments are logical groupings of customers based on one or more parameters.
member_care_access-For admin users, shows customers that are active within the vicinity of that user.
card_details-Retrieves details of all the customer's cards.
tracker_info-
delayed_accrual-
coupon_active-
basic-
program_idint
coupon_offerintDefault value is 0.
coupon_org_entity_typestring
coupon_org_entity_valuestring
coupon_statusstring
program_summarybooleanIf enabled, retrieve the details of the programs the customer is associated with.

Note: You can retrieve details of a customer using customer ID, email or external_id.

📘

If you attempt to retrieve data of any deleted customer after a successful PII deletion, you will receive the following response:

"message": "Customer is deleted after PII delete request"

Additional Header

ParameterDescription
languageSpecify 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 parameter

ParameterDescription
status.successIndicates the success of the operation
status.codeThe code representing the status of the operation
status.messageThe message describing the status of the operation
status.totalThe total count in the response
status.success_countThe count of successful operations
customer.firstnameThe first name of the customer
customer.lastnameThe last name of the customer
customer.mobileThe mobile number of the customer
customer.emailThe email address of the customer
customer.external_idAn external identifier for the customer
customer.lifetime_pointsThe total lifetime points accumulated by the customer
customer.lifetime_purchasesThe total lifetime purchases made by the customer
customer.loyalty_pointsThe current loyalty points of the customer
customer.current_slabThe current slab of the customer in the loyalty program
customer.registered_onThe date and time when the customer registered
customer.updated_onThe date and time when the customer's information was last updated
customer.typeThe type of customer
customer.sourceThe source through which the customer was acquired
customer.registered_byThe individual who registered the customer
registered_store.codeThe code of the store where the customer was registered
registered_store.nameThe name of the store where the customer was registered
registered_till.codeThe code of the till used to register the customer
registered_till.nameThe name of the till used to register the customer
fraud_details.statusThe fraud status of the customer
extended_fields.field (gender)The gender of the customer
extended_fields.field (city)The city where the customer resides
extended_fields.field (dob)The date of birth of the customer
item_status.successIndicates the success of the customer item operation
item_status.codeThe code representing the status of the customer item operation
item_status.messageThe message describing the status of the customer item operation
programs_listIncludes the list of programs the customer is associated with. This will be available only if program_summary is set to true.
programIncludes the details of the program such as program ID, program name, program description and more.
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!