id
string

Unique event ID, assigned by Voucherify.

Example: evcus_0c150c51730c6b60b1

type
string

Event type.

Available values: customer.confirmed, customer.created, customer.updated, customer.deleted, customer.referred, customer.custom_event, customer.segment.entered, customer.segment.left, customer.sms.sent, customer.sms.recovered, customer.sms.failed, customer.email.sent, customer.email.recovered, customer.email.failed, customer.activecampaign.sent, customer.activecampaign.recovered, customer.activecampaign.failed, customer.braze.sent, customer.braze.recovered, customer.braze.failed, customer.mailchimp.sent, customer.mailchimp.recovered, customer.mailchimp.failed, customer.intercom.sent, customer.intercom.recovered, customer.intercom.failed, customer.shopify.sent, customer.shopify.recovered, customer.shopify.failed, customer.klaviyo.sent, customer.klaviyo.recovered, customer.klaviyo.failed, customer.batch.sent, customer.batch.recovered, customer.batch.failed, customer.rewarded, customer.rewarded.loyalty_points, customer.voucher.gift.balance_added, customer.voucher.loyalty_card.pending_points.activated, customer.voucher.loyalty_card.pending_points.added, customer.voucher.loyalty_card.pending_points.canceled, customer.voucher.loyalty_card.pending_points.updated, customer.voucher.loyalty_card.points_activated, customer.voucher.loyalty_card.points_added, customer.voucher.loyalty_card.points_transferred, customer.voucher.loyalty_card.points_expired, customer.voucher.deleted, customer.publication.succeeded, customer.publication.failed, customer.validation.succeeded, customer.validation.failed, customer.redemption.failed, customer.redemption.succeeded, customer.redemption.rollback.failed, customer.redemption.rollback.succeeded, customer.order.canceled, customer.order.created, customer.order.fulfilled, customer.order.paid, customer.order.processing, customer.order.updated, customer.reward_redemptions.created, customer.reward_redemptions.pending, customer.reward_redemptions.completed, customer.reward_redemptions.rolledback, customer.loyalty.updated, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged, customer.loyalty.tier.expiration.changed, customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.holder.assignment.created, customer.holder.assignment.deleted

data
object

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

created_at
string

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

Example: 2022-08-30T09:14:07.660Z

group_id
string

Unique identifier of the request that caused the event.

Example: v-1f36113948e50fc4ge

channel
string

Determines the channel that initiated the event.

Available values: USER_PORTAL, API, CLIENT_API, INTERNAL

Example: API

user
object

Determines the Voucherify user who triggered the event.

api_key
object

Determines the API key used to initiate the event.

customer

unconfirmed_customer
object

customer

customer

customer

customer

referrer

campaign

voucher

custom_event

redemption

event

event_schema

customer

referral
object, null

Details about the referral.

loyalty
object, null

Details about the loyalty activity.

customer

segment

customer

segment

customer

holder

voucher

campaign

redemption

reward

referral_tier

balance
object, null

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.

custom_event

customer_event
object, null

customer

holder

voucher

campaign

loyalty_tier

earning_rule

balance

order

1. Order Calculated No Customer Data

2. Attributes	Description
   items array	Array of items applied to the order. It can include up to 500 items. Array of Order Item Calculated

event

customer

campaign

voucher

balance

transaction

1. Voucher Transaction Base

2. Attributes	Description
   details object	Contains the detailed information about the transaction. Attributes Description balance See: Voucher Balance order object Contains information about the original order. Attributes Description id string Unique order ID. source_id string The merchant’s order ID if it is different from the Voucherify order ID. It is really useful in case of integration between multiple systems. It can be an order ID from CRM, database or 3rd party service. event object Contains information about the event that triggers the point accrual. Attributes Description id string Unique event ID. type string Type of event. earning_rule object Contains information about the earning rule. Attributes Description id string Unique identifier of an earning rule, assigned by Voucherify. source object Contains the custom earning rule name. Attributes Description banner string Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard. segment object Contains information about the segment. Attributes Description id string name string loyalty_tier object Contains information about the loyalty tier. Attributes Description id string Unique identifier of the loyalty tier, assigned by Voucherify. name string User-defined name of the loyalty tier. redemption object Contains information about the original redemption. Attributes Description id string Unique redemption ID. rollback object Contains information about the redemption rollback. Attributes Description id string Unique redemption rollback ID. custom_event object Contains information about the custom event that triggers the point accrual. Attributes Description id string Unique event ID. type string Type of custom event. event_schema object Contains information about the custom event metadata schema. Attributes Description id string Unique metadata schema ID. name string Type of custom event. reward object Contains information about the pay with points reward. Attributes Description id string Unique reward ID. name string Reward name. source_voucher Contains information on how the balance on the donor loyalty card was affected by the transaction. Simple Voucher destination_voucher Contains information on how the balance on the receiving loyalty card was affected by the transaction. Simple Voucher
   type string	Transaction type concerning gift card credits. Available values: CREDITS_ADDITION

customer

campaign

voucher

balance

order

transaction

pending_points

customer

campaign

voucher

voucher_pending_points_balance

order

pending_points

customer

campaign

voucher

voucher_pending_points_balance

order

pending_points

customer

campaign

voucher

voucher_pending_points_balance

order

pending_points

customer

campaign

voucher

balance

transaction

1. Voucher Transaction Base

2. Attributes	Description
   details object	Contains the detailed information about the transaction. Attributes Description balance See: Voucher Balance order object Contains information about the original order. Attributes Description id string Unique order ID. source_id string The merchant’s order ID if it is different from the Voucherify order ID. It is really useful in case of integration between multiple systems. It can be an order ID from CRM, database or 3rd party service. event object Contains information about the event that triggers the point accrual. Attributes Description id string Unique event ID. type string Type of event. earning_rule object Contains information about the earning rule. Attributes Description id string Unique identifier of an earning rule, assigned by Voucherify. source object Contains the custom earning rule name. Attributes Description banner string Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard. segment object Contains information about the segment. Attributes Description id string name string loyalty_tier object Contains information about the loyalty tier. Attributes Description id string Unique identifier of the loyalty tier, assigned by Voucherify. name string User-defined name of the loyalty tier. redemption object Contains information about the original redemption. Attributes Description id string Unique redemption ID. rollback object Contains information about the redemption rollback. Attributes Description id string Unique redemption rollback ID. custom_event object Contains information about the custom event that triggers the point accrual. Attributes Description id string Unique event ID. type string Type of custom event. holder_loyalty_tier object Loyalty tier of the loyalty card holder at the moment when the transaction occurred. The loyalty tier is the tier in which the holder was before the loyalty point balance changed. Attributes Description id string Unique identifier of the loyalty tier, assigned by Voucherify. name string User-defined name of the loyalty tier. event_schema object Contains information about the custom event metadata schema. Attributes Description id string Unique metadata schema ID. name string Type of custom event. reward object Contains information about the pay with points reward. Attributes Description id string Unique reward ID. name string Reward name. source_voucher Contains information on how the balance on the donor loyalty card was affected by the transaction. Simple Voucher destination_voucher Contains information on how the balance on the receiving loyalty card was affected by the transaction. Simple Voucher
   type string	Transaction type concerning loyalty card points. Available values: POINTS_ACCRUAL

customer

campaign

voucher

source_voucher

destination_voucher

balance

transaction

1. Voucher Transaction Base

2. Attributes	Description
   details object	Contains the detailed information about the transaction. Attributes Description balance See: Voucher Balance order object Contains information about the original order. Attributes Description id string Unique order ID. source_id string The merchant’s order ID if it is different from the Voucherify order ID. It is really useful in case of integration between multiple systems. It can be an order ID from CRM, database or 3rd party service. event object Contains information about the event that triggers the point accrual. Attributes Description id string Unique event ID. type string Type of event. earning_rule object Contains information about the earning rule. Attributes Description id string Unique identifier of an earning rule, assigned by Voucherify. source object Contains the custom earning rule name. Attributes Description banner string Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard. segment object Contains information about the segment. Attributes Description id string name string loyalty_tier object Contains information about the loyalty tier. Attributes Description id string Unique identifier of the loyalty tier, assigned by Voucherify. name string User-defined name of the loyalty tier. redemption object Contains information about the original redemption. Attributes Description id string Unique redemption ID. rollback object Contains information about the redemption rollback. Attributes Description id string Unique redemption rollback ID. custom_event object Contains information about the custom event that triggers the point accrual. Attributes Description id string Unique event ID. type string Type of custom event. event_schema object Contains information about the custom event metadata schema. Attributes Description id string Unique metadata schema ID. name string Type of custom event. holder_loyalty_tier object Loyalty tier of the loyalty card holder at the moment when the transaction occurred. The loyalty tier is the tier in which the holder was before the loyalty point balance changed. Attributes Description id string Unique identifier of the loyalty tier, assigned by Voucherify. name string User-defined name of the loyalty tier. reward object Contains information about the pay with points reward. Attributes Description id string Unique reward ID. name string Reward name. source_voucher Contains information on how the balance on the donor loyalty card was affected by the transaction. Simple Voucher destination_voucher Contains information on how the balance on the receiving loyalty card was affected by the transaction. Simple Voucher
   type string	Transaction type concerning loyalty card points. Available values: POINTS_TRANSFER_IN, POINTS_TRANSFER_OUT

customer

campaign

voucher

points
integer

The number of expired points.

buckets
array

transaction

1. Voucher Transaction Base

2. Attributes	Description
   details object	Contains the detailed information about the transaction. Attributes Description balance See: Voucher Balance order object Contains information about the original order. Attributes Description id string Unique order ID. source_id string The merchant’s order ID if it is different from the Voucherify order ID. It is really useful in case of integration between multiple systems. It can be an order ID from CRM, database or 3rd party service. event object Contains information about the event that triggers the point accrual. Attributes Description id string Unique event ID. type string Type of event. earning_rule object Contains information about the earning rule. Attributes Description id string Unique identifier of an earning rule, assigned by Voucherify. source object Contains the custom earning rule name. Attributes Description banner string Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard. segment object Contains information about the segment. Attributes Description id string name string loyalty_tier object Contains information about the loyalty tier. Attributes Description id string Unique identifier of the loyalty tier, assigned by Voucherify. name string User-defined name of the loyalty tier. redemption object Contains information about the original redemption. Attributes Description id string Unique redemption ID. rollback object Contains information about the redemption rollback. Attributes Description id string Unique redemption rollback ID. custom_event object Contains information about the custom event that triggers the point accrual. Attributes Description id string Unique event ID. type string Type of custom event. event_schema object Contains information about the custom event metadata schema. Attributes Description id string Unique metadata schema ID. name string Type of custom event. holder_loyalty_tier object Loyalty tier of the loyalty card holder at the moment when the transaction occurred. The loyalty tier is the tier in which the holder was before the loyalty point balance changed. Attributes Description id string Unique identifier of the loyalty tier, assigned by Voucherify. name string User-defined name of the loyalty tier. reward object Contains information about the pay with points reward. Attributes Description id string Unique reward ID. name string Reward name. source_voucher Contains information on how the balance on the donor loyalty card was affected by the transaction. Simple Voucher destination_voucher Contains information on how the balance on the receiving loyalty card was affected by the transaction. Simple Voucher
   type string	Transaction type concerning loyalty card points. Available values: POINTS_EXPIRATION

customer

campaign

voucher

customer

campaign

publication

customer

campaign

publication

customer

validation

customer

validation

customer

campaign

loyalty
object

created_at
string

Example: 2022-02-25T13:32:08.734Z

holder

voucher

campaign

customer

holder

voucher

campaign

customer

id
string

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

name
string

Customer’s first and last name.

email
string

Customer’s email address.

source_id
string

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

metadata
object

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

object
string

The type of the object represented by JSON.

Available values: customer

id
string

Campaign ID.

name
string

Campaign name.

campaign_type
string

Type of campaign.

type
string

Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of generic (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

Available values: AUTO_UPDATE, STATIC, STANDALONE

is_referral_code
boolean

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

voucher

referral_program

auto_join
boolean

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

join_once
boolean

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

active
boolean

Indicates whether the campaign is active.

category_id
string, null

The unique category ID that this campaign belongs to.

category
string

Unique category name.

categories
array

metadata
object

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.

start_date
string

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

Example: 2022-09-20T00:00:00.000Z

expiration_date
string

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

Example: 2022-09-30T00:00:00.000Z

description
string

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

created_at
string

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

Example: 2024-01-01T11:11:11.111Z

updated_at
string

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

Example: 2024-01-01T11:11:11.111Z

object
string

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

Available values: campaign

id
string

A unique identifier that represents the voucher assigned by Voucherify.

code
string

Voucher code.

gift

Gift object response.

discount

loyalty_card
object

Defines the loyalty card details.

type
string

Type of the voucher.

Available values: DISCOUNT_VOUCHER, LOYALTY_CARD, GIFT_VOUCHER

campaign
string

Campaign name.

campaign_id
string

Campaign unique ID.

is_referral_code
boolean

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

holder_id
string

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

Example: cust_eWgXlBBiY6THFRJwX45Iakv4

referrer_id
string

Unique identifier of the referrer assigned by Voucherify.

Example: cust_nM4jqPiaXUvQdVSA6vTRUnix

category_id
string, null

Unique identifier of the category that this voucher belongs to.

Example: cat_0b6152ce12414820dc

categories
array

active
boolean

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

created_at
string

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

Example: 2021-12-22T10:13:06.487Z

updated_at
string

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

Example: 2024-01-01T11:11:11.111Z

redemption
object

Defines the redemption limits on vouchers.

start_date
string

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

Example: 2021-12-01T00:00:00.000Z

expiration_date
string

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

Example: 2021-12-31T00:00:00.000Z

metadata
object

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.

object
string

The type of the object represented by JSON.

Available values: voucher

id
string

Unique custom event ID.

object
string

The object represented is an event.

Available values: event

type
string

The event name.

customer

A simple customer object

referral
object

Referral object.

loyalty
object

Loyalty object.

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

created_at
string

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

Example: 2021-12-22T10:13:06.487Z

id
string

Unique redemption ID.

Example: r_0bc92f81a6801f9bca

object
string

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

created_at
string

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

Example: 2021-12-22T10:13:06.487Z

tracking_id
string

Hashed customer source ID.

metadata
object

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

channel_type
string

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

Available values: USER, API

channel_id
string

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.

Example: user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH

failure_code
string

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

Example: customer_rules_violated

failure_message
string

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

order

1. Order Calculated No Customer Data

2. Attributes	Description
   items array	Array of items applied to the order. It can include up to 500 items. Array of Order Item Calculated

previous_order

1. Order Calculated No Customer Data

2. Attributes	Description
   items array	Array of items applied to the order. It can include up to 500 items. Array of Order Item Calculated

reward

amount
integer

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.

Example: 10000

reason
string

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

result
string

Redemption result.

Available values: SUCCESS, FAILURE

status
string

Redemption status.

Available values: SUCCEEDED, FAILED

related_redemptions
object

parent_redemption_id
string

Unique redemption ID of the parent redemption.

Example: r_0c656311b5878a2031

redemption
string

Unique redemption ID of the parent redemption.

Example: r_0c656311b5878a2031

customer

customer_id
string, null

Unique customer ID of the redeeming customer.

Example: cust_i8t5Tt6eiKG5K79KQlJ0Vs64

related_object_type
string

Defines the related object.

Available values: voucher, promotion_tier

related_object_id
string

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

related_object_parent_id
string

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

campaign_name
string

Campaign name

voucher

1. Voucher
2. Voucher Holder

promotion_tier

Contains details of the promotion tier and the parent campaign.

id
string

Unique identifier of the custom event.

name
string

Name of the custom event.

id
string

Unique segment ID.

Example: seg_DNAOhUtJffvX0f57ajLMFBYR

name
string

Segment name.

object
string

The type of the object represented by the ID.

Available values: segment

customer

distribution
object

sent_at
string

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

Example: 2021-12-22T10:13:06.487Z

customer

distribution
object

recovered_at
string

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

Example: 2021-12-22T10:13:06.487Z

customer

distribution
object

failed_at
string

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

Example: 2021-12-22T10:13:06.487Z

customer

assignment_id
string

Unique reward assignment ID assigned by Voucherify.

voucher

product

sku

loyalty_tier_id
string

Unique loyalty tier ID assigned by Voucherify.

id
string

Unique reward ID, assigned by Voucherify.

Example: rew_nIy4gHpQHle2c3pNMwuj7G6j

object
string

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

Available values: reward

name
string

Reward name.

created_at
string

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

Example: 2024-01-01T11:11:11.111Z

updated_at
string, null

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

Example: 2024-01-01T11:11:11.111Z

parameters
object

Defines how the reward is generated.

metadata
object

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.

type
string

Reward type.

Available values: CAMPAIGN, COIN, MATERIAL

id
string

Unique referral tier ID.

Example: seg_DNAOhUtJffvX0f57ajLMFBYR

campaign_id
string

Campaign Id.

banner
string

Text to be displayed to your customers on your website.

parameters
object

Referral tier parameters

type
string

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

Available values: loyalty_card, gift_voucher

total
integer

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

object
string

The type of the object represented by the JSON.

Available values: balance

amount
integer

Credits added or subtracted on a gift card.

points
integer

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

balance
integer

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

operation_type
string

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

Available values: MANUAL, AUTOMATIC

related_object
object

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

id
string

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

source_id
string, null

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

status
string

The order status.

Available values: CREATED, PAID, CANCELED, FULFILLED

amount
integer

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

initial_amount
integer

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

discount_amount
integer

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

items_discount_amount
integer

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

total_discount_amount
integer

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

total_amount
integer

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

applied_discount_amount
integer

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

items_applied_discount_amount
integer

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)

total_applied_discount_amount
integer

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

metadata
object

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.

object
string

The type of the object represented by JSON.

Available values: order

created_at
string

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

Example: 2021-12-22T10:13:06.487Z

updated_at
string, null

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

Example: 2021-12-22T10:14:45.316Z

customer_id
string, null

Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.

Example: cust_7iUa6ICKyU6gH40dBU25kQU1

referrer_id
string, null

Unique referrer ID.

Example: cust_nM4jqPiaXUvQdVSA6vTRUnix

customer

referrer

redemptions
object

id
string

Unique identifier of the order line item.

sku_id
string

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

product_id
string

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

related_object
string

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

Available values: product, sku

source_id
string

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.

quantity
integer

The quantity of the particular item in the cart.

discount_quantity
integer

Number of dicounted items.

initial_quantity
integer

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

amount
integer

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

discount_amount
integer

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

applied_discount_amount
integer

This field shows the order-level discount applied.

applied_discount_quantity
integer

Number of the discounted items applied in the transaction.

applied_quantity
integer

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.

applied_quantity_amount
integer

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.

initial_amount
integer

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.

price
integer

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

subtotal_amount
integer

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

product
object

An object containing details of the related product.

sku
object

An object containing details of the related SKU.

object
string

The type of the object represented by JSON.

Available values: order_item

metadata
object

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.

id
string

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

Example: evcus_0e3070fef399b70b00

type
string

Type of the triggering event.

Example: customer.order.paid

category
string

Type of the event.

Available values: EFFECT, ACTION

entity_id
string

ID of the entity that initiated the event.

Example: cust_ADqZIwGvWFvugWXVbrHwXRHO

created_at
string

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

Example: 2024-01-01T11:11:11.111Z

group_id
string

Unique identifier of the request that triggered the event.

Example: v-1f36113948e50fc4ge

id
string

Unique transaction ID.

source_id
string, null

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.

voucher_id
string

Unique voucher ID.

campaign_id
string

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

source
string, null

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
string, null

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

related_transaction_id
string, null

The related transaction ID on the receiving card.

created_at
string

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

id
string

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

source_id
string

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

status
string

The order status.

Available values: CREATED, PAID, CANCELED, FULFILLED

customer_id
string, null

Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.

Example: cust_7iUa6ICKyU6gH40dBU25kQU1

referrer_id
string, null

Unique identifier of the referrer assigned by Voucherify.

Example: cust_nM4jqPiaXUvQdVSA6vTRUnix

amount
integer

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.

discount_amount
integer

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

applied_discount_amount
integer

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

items_discount_amount
integer

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

items_applied_discount_amount
integer

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)

total_discount_amount
integer

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

total_applied_discount_amount
integer

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

total_amount
integer

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

items
array

metadata
object

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.

object
string

The type of the object represented by JSON.

Available values: order

id
string

Unique identifier of the pending point entry, assigned by Voucherify.

Example: lopp_0ffd593d5ad207ba6b

voucher_id
string

Unique identifier of the loyalty card, assigned by Voucherify.

Example: v_abCdEfghI1JKLMNPqRS2Tu3vWXyza4bc

campaign_id
string

Unique campaign identifier, assigned by Voucherify.

Example: camp_weer1c3p5ZgktqfW56RfoNaG

customer_id
string

Unique customer identifier, assigned by Voucherify.

Example: cust_IdgAFZxYwwHctOk9ppZMu319

order_id
string

Unique order identifier, assigned by Voucherify.

Example: ord_0ffc0fa65f15d2df17

points
integer

Number of points in the pending state.

activates_at
string

Date when the pending points are activated and added to the customer’s loyalty card.

details

created_at
string

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

updated_at
string

Timestamp representing the date and time when the pending point entry was modified. The value is shown in the ISO 8601 format.

id
string

Unique identifier of the loyalty points bucket.

voucher_id
string

Unique identifier of the parent loyalty card.

campaign_id
string

Unique identifier of the parent campaign.

bucket
object

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

status
string

Loyalty point point bucket status.

expires_at
string

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

created_at
string

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

updated_at
string

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

object
string

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

Available values: loyalty_points_bucket

id
string

Unique validation id.

session_id
string

Unique session id.

status
string

The validation status

Available values: VALID, INVALID

created_at
string

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

Example: 2021-12-22T10:13:06.487Z

customer_id
string

Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.

Example: cust_7iUa6ICKyU6gH40dBU25kQU1

redeemables
array

skipped_redeemables
array

inapplicable_redeemables
array

customer

order

campaign

voucher

holder

promotion_tier

promotion_stack

redemption

id
string

Unique redemption ID.

Example: r_0bc92f81a6801f9bca

customer_id
string, null

Unique customer ID of the redeeming customer.

Example: cust_i8t5Tt6eiKG5K79KQlJ0Vs64

tracking_id
string

Hashed customer source ID.

date
string

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

Example: 2021-12-22T10:13:06.487Z

amount
integer

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.

Example: 10000

order

reward

customer

result
string

Redemption result.

Available values: SUCCESS, FAILURE

status
string, null

Available values: SUCCEEDED, FAILED, ROLLED BACK

voucher

Defines the details of the voucher being redeemed.

promotion_tier

redemption
string

Unique redemption ID of the parent redemption.

Example: r_0c656311b5878a2031

metadata
object

The metadata object stores all custom attributes in the form of key/value pairs assigned to the redemption.

failure_code
string

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

Example: customer_rules_violated

failure_message
string

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

reason
string

The reason for the redemption rollback.

channel
object

Defines the details of the channel through which the redemption was issued.

object
string

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

customer

referrer

order

1. Order Calculated No Customer Data

2. Attributes	Description
   items array	Array of items applied to the order. It can include up to 500 items. Array of Order Item Calculated

redemption

customer

holder

voucher

campaign

reward_redemption
object

reward

reward_assignment

source
string

balance
integer

customer

campaign

id
string

Unique identifier of the redeemable holder.

Example: rh_0e7b8db4700106a852

created_at
string

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

Example: 2024-03-22T17:48:25.910Z

redeemable_id
string

Identifier of the redeemable item.

Example: v_GXVguPhq2khgFxH7GrRXWA91gDr1LiA1

redeemable_object
string

Type of the redeemable.

Available values: voucher

Example: voucher

campaign_id
string

Unique identifier of the campaign as assigned by Voucherify.

Example: camp_weer1c3p5ZgktqfW56RfoNaG

campaign_type
string

Defines the type of the campaign.

Available values: REFERRAL_PROGRAM

Example: REFERRAL_PROGRAM

voucher_type
string

Defines the type of the voucher.

Available values: GIFT_VOUCHER, DISCOUNT_VOUCHER, LOYALTY_CARD

Example: DISCOUNT_VOUCHER

publication_id
string, null

Unique identifier of the publication.

customer_id
string

Unique identifier of the customer.

Example: cust_p1ufreYbVbwZ1x70nFkH9rF9

holder_role
string

Role of the holder.

Available values: OWNER, REFERRER, REFEREE

Example: REFERRER

object
string

The type of the object represented by JSON.

Available values: redeemable_holder

redemptions

orders

points
integer

Customer’s loyalty points minus expired for all loyalty cards which the customer has.

referred_customers
integer

Total number of customers referred by the customer.

campaigns
object

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

total
integer

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

campaigns
array

name
string

Customer’s first and last name.

description
string

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

email
string

Customer’s email address.

phone
string

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

birthday
string

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

birthdate
string

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

address
object, null

Customer’s address.

metadata
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. 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
string

Type of the voucher.

Available values: DISCOUNT_VOUCHER, LOYALTY_CARD, GIFT_VOUCHER

discount

Defines the voucher discount type and details.

gift

Defines the voucher gift details.