Customer With Summary Loyalty Referrals
All of:-
Customer Response Data
Attributes Description id stringThe ID of an existing customer that will be linked to redemption in this request. source_id stringA unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored. summary Customer Summary loyalty Customer Loyalty referrals Customer Referrals system_metadata objectObject used to store system metadata information. created_at stringTimestamp representing the date and time when the customer was created. The value is shown in the ISO 8601 format.Example:2022-08-30T06:32:07.380Z updated_at stringTimestamp representing the date and time when the customer was updated. The value is shown in the ISO 8601 format.Example:2022-08-31T06:32:07.380Z assets objectContains information about the customer’s cockpit.Attributes Descriptioncockpit_urlstring Customer’s cockpit URL address. object stringThe type of the object represented by JSON.Available values: customer - Customer Base
Customer Summary
| Attributes | Description |
|---|---|
| redemptions | See: Customer Summary Redemptions |
| orders | See: Customer Summary Orders |
Customer Loyalty
| Attributes | Description |
|---|---|
pointsinteger | Customer’s loyalty points minus expired for all loyalty cards which the customer has. |
referred_customersinteger | Total number of customers referred by the customer. |
campaignsobject | Contains campaigns with details about point balances and how many customers were referred by the customer.Attributes Description[propertyName]object Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign. Attributes Descriptionpointsinteger Remaining point balance in campaign. loyalty_tierstring Customer’s loyalty tier within the campaign. Example: ltr_UJ5Q54Q0OvEhua87Qfv2Ki5x referred_customersinteger Number of customers referred by the customer in campaign. |
Customer Referrals
| Attributes | Description |
|---|---|
totalinteger | Total number of times this customer received a referral, i.e. was referred by another customer. |
campaignsarray | Contains an array of campaigns that served as the source of a referral for the customer.Array of:### Customer Referrals Campaigns ItemAttributes Descriptioncampaign_idstring Unique campaign ID, assigned by Voucherify. Example: camp_rRsfatlwN7unSeUIJDCYedal referrer_idstring Unique referrer ID, assigned by Voucherify. This is the customer ID of a customer that is referring this customer. Example: cust_sehkNIi8Uq2qQuRqSr7xn4Zi related_object_idstring Related object id Example: r_0b9d4cc4aa164dd073 related_object_typestring Related object type, i.e. redemption. datestring Timestamp representing the date and time when the customer was referred in ISO 8601 format. Example: 2022-08-30T10:19:39.196Z |
Customer Base
| Attributes | Description |
|---|---|
namestring | Customer’s first and last name. |
descriptionstring | An arbitrary string that you can attach to a customer object. |
emailstring | Customer’s email address. |
phonestring | Customer’s phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel. |
birthdaystring | Deprecated. |
birthdatestring | Customer’s birthdate; format YYYY-MM-DD. |
addressobject, null | Customer’s address.Attributes Descriptioncitystring City statestring State line_1string First line of address. line_2string Second line of address. countrystring Country. postal_codestring Postal code. |
metadataobject | A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments. |
Customer Summary Redemptions
| Attributes | Description |
|---|---|
total_redeemedinteger | Total number of redemptions made by the customer. |
total_failedinteger | Total number of redemptions that failed. |
total_succeededinteger | Total number of redemptions that succeeded. |
total_rolled_backinteger | Total number of redemptions that were rolled back for the customer. |
total_rollback_failedinteger | Total number of redemption rollbacks that failed. |
total_rollback_succeededinteger | Total number of redemption rollbacks that succeeded. |
giftobject | Summary of gift card credits.Attributes Descriptionredeemed_amountinteger Total amount of gift card credits redeemed by customer. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for 100.00.


amount\_to\_gointeger 

Remaining gift card balance across all gift cards. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for 100.00. |
loyalty_cardobject | Summary of loyalty points.Attributes Descriptionredeemed_pointsinteger Total number of loyalty points redeemed by the customer. points_to_gointeger Sum of remaining available point balance across all loyalty cards. |
Customer Summary Orders
| Attributes | Description |
|---|---|
total_amountinteger | The total amount spent by the customer. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00. |
total_countinteger | Total number of orders made by the customer. |
average_amountinteger | Average amount spent on orders. total_amount ÷ total_count. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00. |
last_order_amountinteger | Amount spent on last order. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00. |
last_order_datestring | Timestamp representing the date and time of the customer’s last order in ISO 8601 format.Example:2022-08-30T11:51:08.029Z |