Customer Activity Object

Unique event ID, assigned by Voucherify.

evcus_0c150c51730c6b60b1

Event type.

Contains details about the event. The objects that are returned in the data attribute differ based on the context of the event type.

Timestamp representing the date and time when the customer activity occurred in ISO 8601 format.

2022-08-30T09:14:07.660Z

Unique identifier of the request that caused the event.

v-1f36113948e50fc4ge

Details about the referral.

Details about the loyalty activity.

Balance changed by the event. The amount property details a change in a gift card. The points property details a change in a loyalty card.

The number of expired points.

2022-02-25T13:32:08.734Z

Unique identifier of an existing customer. It is assigned by Voucherify.

Customer's first and last name.

Customer's email address.

A unique identifier of the customer. It can be a customer ID or email from a CRM system, database, or a third-party service.

A set of custom key/value pairs that are attached to the customer. It stores all custom attributes assigned to the customer.

The type of the object represented by JSON.

Campaign ID.

Campaign name.

Type of campaign.

Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.

• AUTO_UPDATE: the campaign is dynamic, i.e. vouchers will generate based on set criteria
• STATIC: vouchers need to be manually published
• STANDALONE: campaign for single vouchers

Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.

Indicates whether customers will be able to auto-join the campaign if any earning rule is fulfilled.

If this value is set to true, customers will be able to join the campaign only once. It is always false for standalone voucher campaigns and it cannot be changed in them.

Indicates whether the campaign is active.

The unique category ID that this campaign belongs to.

Unique category name.

Contains details about the category.

A set of custom key/value pairs that you can attach to a campaign. The metadata object stores all custom attributes assigned to the campaign.

Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.

2022-09-20T00:00:00.000Z

Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date.

2022-09-30T00:00:00.000Z

An optional field to keep extra textual information about the campaign such as a campaign description and details.

Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format.

2024-01-01T11:11:11.111Z

Timestamp representing the date and time when the campaign was updated in the ISO 8601 format.

2024-01-01T11:11:11.111Z

The type of the object represented by JSON. This object stores information about the campaign.

A unique identifier that represents the voucher assigned by Voucherify.

Voucher code.

Gift object response.

Defines the loyalty card details.

Type of the voucher.

Campaign name.

Campaign unique ID.

Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.

Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.

cust_eWgXlBBiY6THFRJwX45Iakv4

Unique identifier of the referrer assigned by Voucherify.

cust_nM4jqPiaXUvQdVSA6vTRUnix

Unique identifier of the category that this voucher belongs to.

cat_0b6152ce12414820dc

Contains details about the category.

Shows whether the voucher is on or off. true indicates an active voucher and false indicates an inactive voucher.

Timestamp representing the date and time when the order was created in the ISO 8601 format.

2021-12-22T10:13:06.487Z

Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.

2024-01-01T11:11:11.111Z

Defines the redemption limits on vouchers.

Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.

2021-12-01T00:00:00.000Z

Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.

2021-12-31T00:00:00.000Z

A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher.

The type of the object represented by JSON.

Unique custom event ID.

The object represented is an event.

The event name.

A simple customer object

Referral object.

Loyalty object.

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

Timestamp representing the date and time when the custom event was created. The value is shown in the ISO 8601 format.

2021-12-22T10:13:06.487Z

Unique redemption ID.

r_0bc92f81a6801f9bca

The type of the object represented by the JSON. This object stores information about the redemption.

Timestamp representing the date and time when the redemption was created. The value is shown in the ISO 8601 format.

2021-12-22T10:13:06.487Z

Hashed customer source ID.

The metadata object stores all custom attributes assigned to the redemption.

The source of the channel for the redemption rollback. A USER corresponds to the Voucherify Dashboard and an API corresponds to the API.

Unique channel ID of the user performing the redemption. This is either a user ID from a user using the Voucherify Dashboard or an X-APP-Id of a user using the API.

user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH

If the result is FAILURE, this parameter will provide a generic reason as to why the redemption failed.

customer_rules_violated

If the result is FAILURE, this parameter will provide a more expanded reason as to why the redemption failed.

For gift cards, this is a positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the number of redeemed credits.
For loyalty cards, this is the number of loyalty points used in the transaction.

10000

System generated cause for the redemption being invalid in the context of the provided parameters.

Redemption result.

Redemption status.

Unique redemption ID of the parent redemption.

r_0c656311b5878a2031

Unique redemption ID of the parent redemption.

r_0c656311b5878a2031

Unique customer ID of the redeeming customer.

cust_i8t5Tt6eiKG5K79KQlJ0Vs64

Defines the related object.

Unique related object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher.

Unique related parent object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher.

Campaign name

Defines the details of the voucher being redeemed.

Contains details of the promotion tier and the parent campaign.

Unique identifier of the custom event.

Name of the custom event.

Unique segment ID.

seg_DNAOhUtJffvX0f57ajLMFBYR

Segment name.

The type of the object represented by the ID.

Timestamp representing the date and time when the distribution was sent in ISO 8601 format.

2021-12-22T10:13:06.487Z

Timestamp representing the date and time when the distribution was recovered in ISO 8601 format.

2021-12-22T10:13:06.487Z

Timestamp representing the date and time when the distribution failed in ISO 8601 format.

2021-12-22T10:13:06.487Z

Unique reward assignment ID assigned by Voucherify.

Unique loyalty tier ID assigned by Voucherify.

Unique reward ID, assigned by Voucherify.

rew_nIy4gHpQHle2c3pNMwuj7G6j

The type of the object represented by the JSON. This object stores information about the reward.

Reward name.

Timestamp representing the date and time when the reward was created. The value is shown in the ISO 8601 format.

2024-01-01T11:11:11.111Z

Timestamp representing the date and time when the reward was updated. The value is shown in the ISO 8601 format.

2024-01-01T11:11:11.111Z

Defines how the reward is generated.

A set of custom key/value pairs that you can attach to a reward. The metadata object stores all custom attributes assigned to the reward.

Reward type.

Unique referral tier ID.

seg_DNAOhUtJffvX0f57ajLMFBYR

Campaign Id.

Text to be displayed to your customers on your website.

Referral tier parameters

The type of voucher whose balance is being adjusted due to the transaction.

The number of all points or credits accumulated on the card as affected by add or subtract operations.

The type of the object represented by the JSON.

Points added or subtracted in the transaction of a loyalty card.

The available points or credits on the card after the transaction as affected by redemption or rollback.

The type of the operation being performed. The operation type is AUTOMATIC if it is an automatic redemption.

Defines the resource that is being modified with the values that are returned in the balance object.

Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request.

Unique source ID of an existing order that will be linked to the redemption of this request.

The order status.

This is the sum of the order items' amounts. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).

This is the sum of the order items' amounts before any discount or other effect (e.g. add missing units) is applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).

Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).

Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).

Sum of all order-level AND all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).

Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).

This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).

Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
sum(items, i => i.applied_discount_amount)

Sum of all order-level AND all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
total_applied_discount_amount = applied_discount_amount + items_applied_discount_amount

A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.

The type of the object represented by JSON.

Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.

2021-12-22T10:13:06.487Z

Timestamp representing the date and time when the order was last updated in ISO 8601 format.

2021-12-22T10:14:45.316Z

Unique customer ID of the customer making the purchase.

cust_7iUa6ICKyU6gH40dBU25kQU1

Unique referrer ID.

cust_nM4jqPiaXUvQdVSA6vTRUnix

Unique identifier of the order line item.

Unique identifier of the SKU. It is assigned by Voucherify.

Unique identifier of the product. It is assigned by Voucherify.

Used along with the source_id property, can be set to either sku or product.

The merchant's product/SKU ID (if it is different from the Voucherify product/SKU ID). It is useful in the integration between multiple systems. It can be an ID from an eCommerce site, a database, or a third-party service.

The quantity of the particular item in the cart.

Number of dicounted items.

A positive integer in the smallest unit quantity representing the total amount of the order; this is the sum of the order items' quantity.

The total amount of the order item (price * quantity).

Sum of all order-item-level discounts applied to the order.

This field shows the order-level discount applied.

Number of the discounted items applied in the transaction.

Quantity of items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.

Amount for the items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.

A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.

Unit price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example 10000 cents for $100.00.

Final order item amount after the applied item-level discount. If there are no item-level discounts applied, this item is equal to the amount.
subtotal_amount=amount-applied_discount_amount

An object containing details of the related product.

An object containing details of the related SKU.

The type of the object represented by JSON.

A set of custom key/value pairs that you can attach to an item object. It can be useful for storing additional information about the item in a structured format. It can be used to define business validation rules or discount formulas.

Unique identifier assigned by Voucherify that will be linked to the this event.

evcus_0e3070fef399b70b00

Type of the triggering event.

customer.order.paid

Type of the event.

ID of the entity that initiated the event.

cust_ADqZIwGvWFvugWXVbrHwXRHO

Timestamp representing the date and time when the event was created in the ISO 8601 format.

2024-01-01T11:11:11.111Z

Unique identifier of the request that triggered the event.

v-1f36113948e50fc4ge

Unique transaction ID.

The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null.

Unique voucher ID.

Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes.

The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null.

Reason why the transaction occurred. In case of a redemption, this value is null.

The related transaction ID on the receiving card.

Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format.

Unique identifier of the loyalty points bucket.

Unique identifier of the parent loyalty card.

Unique identifier of the parent campaign.

Defines the number of points stored in this loyalty point bucket.

Loyalty point point bucket status.

Date when the number of points defined in the bucket object are due to expire.

Timestamp representing the date and time when the loyalty point bucket object was created in ISO 8601 format.

Timestamp representing the date and time when the loyalty point bucket object was updated in ISO 8601 format.

The type of the object represented by JSON. This object stores information about the loyalty point bucket.

Unique validation id.

Unique session id.

The validation status

Timestamp representing the date and time when the validation was created. The value is shown in the ISO 8601 format.

2021-12-22T10:13:06.487Z

Unique customer ID of the customer making the purchase.

cust_7iUa6ICKyU6gH40dBU25kQU1

Lists validation results of each redeemable.

Lists validation results of each redeemable.

Lists validation results of each redeemable.

Unique redemption ID.

r_0bc92f81a6801f9bca

Unique customer ID of the redeeming customer.

cust_i8t5Tt6eiKG5K79KQlJ0Vs64

Hashed customer source ID.

Timestamp representing the date and time when the redemption was created. The value is shown in the ISO 8601 format.

2021-12-22T10:13:06.487Z

For gift cards, this is a positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the number of redeemed credits.
For loyalty cards, this is the number of loyalty points used in the transaction.
In the case of redemption rollback, the numbers are expressed as negative integers.

10000

Redemption result.

Defines the details of the voucher being redeemed.

Unique redemption ID of the parent redemption.

r_0c656311b5878a2031

The type of the object represented by the JSON. This object stores information about the redemption.

Unique identifier of the redeemable holder.

rh_0e7b8db4700106a852

Timestamp representing the date and time when the redeemable was assigned. The value is shown in the ISO 8601 format.

2024-03-22T17:48:25.910Z

Identifier of the redeemable item.

v_GXVguPhq2khgFxH7GrRXWA91gDr1LiA1

Type of the redeemable.

voucher

Unique identifier of the campaign as assigned by Voucherify.

camp_weer1c3p5ZgktqfW56RfoNaG

Defines the type of the campaign.

REFERRAL_PROGRAM

Defines the type of the voucher.

DISCOUNT_VOUCHER

Unique identifier of the publication.

Unique identifier of the customer.

cust_p1ufreYbVbwZ1x70nFkH9rF9

Role of the holder.

REFERRER

The type of the object represented by JSON.

Customer's loyalty points.

Total number of customers referred by the customer.

Contains campaigns with details about point balances and how many customers were referred by the customer.

Total number of times this customer received a referral, i.e. was referred by another customer.

Contains an array of campaigns that served as the source of a referral for the customer.

Customer Referrals Campaigns Item

Customer's first and last name.

An arbitrary string that you can attach to a customer object.

Customer's email address.

Customer's phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel.

Deprecated. Customer's birthdate; format YYYY-MM-DD.

Customer's birthdate; format YYYY-MM-DD.

Customer's address.

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.

Type of the voucher.

Defines the voucher discount type and details.

Defines the voucher gift details.

Defines the voucher loyalty card details.

Defines the redemption limits on vouchers.

Define how a referral is triggered.

Contains details about the custom event.

Defines the referee reward.

Unique category ID assigned by Voucherify.

Category name.

Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.

The type of the object represented by the JSON. This object stores information about the category.

Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format.

2022-07-14T10:45:13.156Z

Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format.

2022-08-16T10:52:08.094Z

Total gift card income over the lifetime of the card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.

Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.

Defines how the credits are applied to the customer's order.

Total points incurred over the lifespan of the loyalty card.

Points available for reward redemption.

The next closest date when the next set of points are due to expire.

The amount of points that are set to expire next.

The unique ID of a customer that is assigned by Voucherify.

cust_CSnYd37MXmrbS19XCrghjBsv

The merchant's customer ID if it is different from the Voucherify customer ID. It is really useful in case of an integration between multiple systems. It can be a customer ID from a CRM system, database or 3rd-party service.

Customer's first and last name.

Customer's email address.

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.

The type of the object represented by the JSON. This object stores information about the customer.

Unique reward assignment ID assigned by Voucherify.

Unique loyalty tier ID assigned by Voucherify.

Unique reward ID.

rew_0bc92f81a6801f9bca

Name of the reward.

Reward Name

The type of the object represented by the JSON

Timestamp representing the date and time when the redemption was created. The value is shown in the ISO 8601 format.

2021-12-22T10:13:06.487Z

Timestamp in ISO 8601 format indicating when the reward was updated.

2022-10-03T12:24:58.008Z

These are parameters representing a material reward.

A set of custom key/value pairs that you can attach to a reward. The metadata object stores all custom attributes assigned to the reward.

Reward type.

Unique promotion tier ID.

promo_63fYCt81Aw0h7lzyRkrGZh9p

Timestamp representing the date and time when the promotion tier was created. The value is shown in the ISO 8601 format.

2021-12-15T11:34:01.333Z

Timestamp representing the date and time when the promotion tier was updated. The value is shown in the ISO 8601 format.

2022-02-09T09:20:05.603Z

Name of the promotion tier.

Text to be displayed to your customers on your website.

Contains details about the discount applied by the promotion tier.

The metadata object stores all custom attributes assigned to the promotion tier. A set of key/value pairs that you can attach to a promotion tier object. It can be useful for storing additional information about the promotion tier in a structured format.

The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer's order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy.

Promotion unique ID.

Contains details about promotion tier's parent campaign.

Promotion tier's parent campaign's unique ID.

A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it's within the active period defined by the start_date and expiration_date.

• true indicates an active promotion tier
• false indicates an inactive promotion tier

Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is inactive before this date.

2022-09-23T00:00:00.000Z

Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is inactive after this date.

2022-09-26T00:00:00.000Z

Contains statistics about promotion tier redemptions and orders.

The type of the object represented by JSON. This object stores information about the promotion tier.

Promotion tier category ID.

cat_0c9da30e7116ba6bba

Unique product ID.

Product source id.

Product name.

Unique sku ID.

Sku source id.

Sku name.

Loyalty Tier name.

Contains a list of earning rule IDs and their points mapping for the given earning rule.

Contains a list of reward IDs and their points mapping for the given reward.

Defines range of loyalty tier in points.

Unique customer ID of the customer making the purchase.

cust_7iUa6ICKyU6gH40dBU25kQU1

Unique campaign ID, assigned by Voucherify.

camp_rRsfatlwN7unSeUIJDCYedal

Unique tier ID, assigned by Voucherify.

Activation timestamp defines when the loyalty tier starts to be active in ISO 8601 format. Loyalty tier is inactive before this date.

Expiration timestamp defines when the loyalty tier expires in ISO 8601 format. Loyalty tier is inactive after this date.

Timestamp representing the date and time when the loyalty tier was created. The value is shown in the ISO 8601 format.

2021-12-22T10:13:06.487Z

Timestamp representing the date and time when the loyalty tier was updated. The value is shown in the ISO 8601 format.

2021-12-22T10:13:06.487Z

Assigned by the Voucherify API, identifies the earning rule object.

Timestamp representing the date and time when the earning rule was created. The value is shown in the ISO 8601 format.

Defines the event which triggers the earning rule to add points to a loyalty card.

Contains details about the custom event.

Contains the ID of a customer segment. Required for the customer.segment.entered option in the event.

Defines the tier associated with the earning rule definition.

Contains the custom earning rule name and parent campaign.

The type of the object represented by JSON. Default is earning_rule.

For internal use by Voucherify.

Start date defines when the earning rule starts to be active. Activation timestamp is presented in the ISO 8601 format. The earning rule is inactive before this date. If you do not define the start date for an earning rule, it will inherit the campaign start date by default.