Endpoints
Events
- Introduction to Voucherify webhooks
- Project settings webhooks
- Distribution webhooks
- HOOKCreated
- HOOKUpdated
- HOOKDeleted
- HOOKRedemption Succeeded
- HOOKRedemption Rollback Succeeded
- HOOKRewarded
- HOOKRewarded Loyalty Points
- HOOKReward Redemptions Created
- HOOKReward Redemptions Pending
- HOOKReward Redemptions Completed
- HOOKVoucher Loyalty Card Pending Points Activated
- HOOKVoucher Loyalty Card Pending Points Added
- HOOKVoucher Loyalty Card Pending Points Canceled
- HOOKVoucher Loyalty Card Pending Points Updated
- HOOKVoucher Loyalty Card Points Added
- HOOKVoucher Loyalty Card Points Expired
- HOOKVoucher Gift Balance Added
- HOOKSegment Entered
- HOOKSegment Left
- HOOKLoyalty Tier Joined
- HOOKLoyalty Tier Upgraded
- HOOKLoyalty Tier Downgraded
- HOOKLoyalty Tier Prolonged
- HOOKLoyalty Tier Left
- HOOKHolder Assignment Created
- HOOKHolder Assignment Deleted
- HOOKOrder Created
- HOOKOrder Paid
- HOOKOrder Updated
- HOOKOrder Canceled
- HOOKPublication Succeeded
- HOOKCustom Event
- HOOK
EVENTS.CUSTOMER.ORDER.CANCELED event indicates that a customer-related order has been canceled.
When the event is used in an “Order canceled” distribution webhook, the data object always contains the following required objects:
customer,referrer,order,redemption.
- “Notify customers about promotion” sends also the following objects:
campaign,promotion_tier,
- “Send and publish unique codes from campaign” sends also the following objects:
campaign,voucher,publication,
- “Send plain message to customers” sends only the basic objects listed above.
Body
Event data object schema for customer.order.canceled.
Simplified customer data.
Show child attributes
Show child attributes
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.
customer Simplified customer data.
Show child attributes
Show child attributes
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.
customer Order information. Order information.
Show child attributes
Show child attributes
Unique identifier assigned by Voucherify of an existing order that is linked to the redemption of this request.
Unique source ID of an existing order that is linked to the redemption of this request.
Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.
"cust_7iUa6ICKyU6gH40dBU25kQU1"
Unique identifier of the referrer assigned by Voucherify.
"cust_nM4jqPiaXUvQdVSA6vTRUnix"
The type of the object represented by JSON.
order Timestamp representing the date and time when the order was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Timestamp representing the date and time when the order was last updated in the ISO 8601 format.
"024-01-01T11:11:11.111Z"
Order status.
CREATED, PAID, CANCELED, FULFILLED 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.
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.
Sum of all order-level discounts applied to the order.
Sum of all product-specific discounts applied to the order.
Sum of all order-level AND all product-specific discounts applied to the order.
Order amount after undoing all the discounts through the rollback redemption.
This field shows the order-level discount applied.
Sum of all product-specific discounts applied in a particular request.
sum(items, i => i.applied_discount_amount)
Sum of all order-level AND all product-specific discounts applied in a particular request.
total_applied_discount_amount = applied_discount_amount + items_applied_discount_amount
Array of items applied to the order.
Show child attributes
Show child attributes
The type of the object represented by JSON.
order_item 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.
product, sku 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
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.
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.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Timestamp representing the date and time when the redemption was created in ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Unique identifier of the redemption rollback.
"rr_0c63c84eb78ee0a6c0"
Timestamp representing the date and tiem when the redemption rollback was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The source of the incentive.
Unique identifier of the parent redemption.
"r_0ba186c4824e4881e1"
Represent's the campaign ID of the voucher if the redemption was based on a voucher that was part of bulk codes generated within a campaign. In case of a promotion tier, this represents the campaign ID of the promotion tier's parent campaign.
Contains a list of unique IDs of child redemptions, which belong to the stacked incentives.
Lists the rollback redemption IDs of the particular child redemptions.
Customer details with details about loyalty and referral programs.
- Customer With Summary Loyalty Referrals
- Customer ID
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Total number of the redemptions made by the customer.
Total number of the redemptions that failed.
Total number of the redemptions that succeeded.
Total number of the redemptions that were rolled back for the customer.
Total number of the redemption rollbacks that failed.
Total number of the redemption rollbacks that succeeded.
Summary of gift card credits.
Show child attributes
Show child attributes
Total amount of gift card credits redeemed by the customer. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Remaining gift card balance across all gift cards. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Summary of loyalty points.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The total amount spent by the customer. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Total number of orders made by the customer.
Average amount spent on orders. total_amount ÷ total_count. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Amount spent on last order. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Timestamp representing the date and time of the customer's last order in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
Show child attributes
Show child attributes
Remaining point balance in campaign.
Customer's loyalty tier within the campaign.
"ltr_UJ5Q54Q0OvEhua87Qfv2Ki5x"
Number of customers referred by the customer in the campaign.
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Unique identifier of the campaign assigned by Voucherify.
"camp_rRsfatlwN7unSeUIJDCYedal"
Unique referrer ID assigned by Voucherify. This is the customer ID of a customer that is referring this customer.
"cust_sehkNIi8Uq2qQuRqSr7xn4Zi"
Related object id
"r_0b9d4cc4aa164dd073"
Related object type, i.e. redemption.
Timestamp representing the date and time when the customer was referred in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the object represented by JSON.
customer 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 for sending out codes to customers via an SMS channel.
Customer's birthdate; format YYYY-MM-DD.
Customer's address.
Show child attributes
Show child attributes
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.
The ID of an existing customer that will be linked to the redemption in this request.
A unique identifier of the customer who validates a voucher.
Object used to store system metadata information.
Timestamp representing the date and time when the customer was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Timestamp representing the date and time when the customer was updated in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Customer details with details about loyalty and referral programs.
- Referrer With Summary Loyalty Referrals
- Referrer Id
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Total number of the redemptions made by the customer.
Total number of the redemptions that failed.
Total number of the redemptions that succeeded.
Total number of the redemptions that were rolled back for the customer.
Total number of the redemption rollbacks that failed.
Total number of the redemption rollbacks that succeeded.
Summary of gift card credits.
Show child attributes
Show child attributes
Total amount of gift card credits redeemed by the customer. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Remaining gift card balance across all gift cards. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Summary of loyalty points.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The total amount spent by the customer. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Total number of orders made by the customer.
Average amount spent on orders. total_amount ÷ total_count. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Amount spent on last order. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Timestamp representing the date and time of the customer's last order in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
Show child attributes
Show child attributes
Remaining point balance in campaign.
Customer's loyalty tier within the campaign.
"ltr_UJ5Q54Q0OvEhua87Qfv2Ki5x"
Number of customers referred by the customer in the campaign.
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Unique identifier of the campaign assigned by Voucherify.
"camp_rRsfatlwN7unSeUIJDCYedal"
Unique referrer ID assigned by Voucherify. This is the customer ID of a customer that is referring this customer.
"cust_sehkNIi8Uq2qQuRqSr7xn4Zi"
Related object id
"r_0b9d4cc4aa164dd073"
Related object type, i.e. redemption.
Timestamp representing the date and time when the customer was referred in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the object represented by JSON.
customer 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 for sending out codes to customers via an SMS channel.
Customer's birthdate; format YYYY-MM-DD.
Customer's address.
Show child attributes
Show child attributes
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.
The ID of an existing customer that will be linked to the redemption in this request.
A unique identifier of the customer who validates a voucher.
Object used to store system metadata information.
Timestamp representing the date and time when the customer was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Timestamp representing the date and time when the customer was updated in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Redemption data used for internal communication
Show child attributes
Show child attributes
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 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.
USER, 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 an expanded reason as to why the redemption failed.
Order information. Order information.
Show child attributes
Show child attributes
Unique identifier assigned by Voucherify of an existing order that is linked to the redemption of this request.
Unique source ID of an existing order that is linked to the redemption of this request.
Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.
"cust_7iUa6ICKyU6gH40dBU25kQU1"
Unique identifier of the referrer assigned by Voucherify.
"cust_nM4jqPiaXUvQdVSA6vTRUnix"
The type of the object represented by JSON.
order Timestamp representing the date and time when the order was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Timestamp representing the date and time when the order was last updated in the ISO 8601 format.
"024-01-01T11:11:11.111Z"
Order status.
CREATED, PAID, CANCELED, FULFILLED 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.
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.
Sum of all order-level discounts applied to the order.
Sum of all product-specific discounts applied to the order.
Sum of all order-level AND all product-specific discounts applied to the order.
Order amount after undoing all the discounts through the rollback redemption.
This field shows the order-level discount applied.
Sum of all product-specific discounts applied in a particular request.
sum(items, i => i.applied_discount_amount)
Sum of all order-level AND all product-specific discounts applied in a particular request.
total_applied_discount_amount = applied_discount_amount + items_applied_discount_amount
Array of items applied to the order.
Show child attributes
Show child attributes
The type of the object represented by JSON.
order_item 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.
product, sku 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
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.
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.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Timestamp representing the date and time when the redemption was created in ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Unique identifier of the redemption rollback.
"rr_0c63c84eb78ee0a6c0"
Timestamp representing the date and tiem when the redemption rollback was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The source of the incentive.
Unique identifier of the parent redemption.
"r_0ba186c4824e4881e1"
Represent's the campaign ID of the voucher if the redemption was based on a voucher that was part of bulk codes generated within a campaign. In case of a promotion tier, this represents the campaign ID of the promotion tier's parent campaign.
Contains a list of unique IDs of child redemptions, which belong to the stacked incentives.
Lists the rollback redemption IDs of the particular child redemptions.
Customer details with details about loyalty and referral programs.
- Customer With Summary Loyalty Referrals
- Customer ID
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Total number of the redemptions made by the customer.
Total number of the redemptions that failed.
Total number of the redemptions that succeeded.
Total number of the redemptions that were rolled back for the customer.
Total number of the redemption rollbacks that failed.
Total number of the redemption rollbacks that succeeded.
Summary of gift card credits.
Show child attributes
Show child attributes
Total amount of gift card credits redeemed by the customer. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Remaining gift card balance across all gift cards. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Summary of loyalty points.
Show child attributes
Show child attributes
Total number of the loyalty points redeemed by the customer.
Sum of the remaining available point balance across all loyalty cards.
Show child attributes
Show child attributes
The total amount spent by the customer. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Total number of orders made by the customer.
Average amount spent on orders. total_amount ÷ total_count. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Amount spent on last order. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Timestamp representing the date and time of the customer's last order in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
Show child attributes
Show child attributes
Remaining point balance in campaign.
Customer's loyalty tier within the campaign.
"ltr_UJ5Q54Q0OvEhua87Qfv2Ki5x"
Number of customers referred by the customer in the campaign.
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Unique identifier of the campaign assigned by Voucherify.
"camp_rRsfatlwN7unSeUIJDCYedal"
Unique referrer ID assigned by Voucherify. This is the customer ID of a customer that is referring this customer.
"cust_sehkNIi8Uq2qQuRqSr7xn4Zi"
Related object id
"r_0b9d4cc4aa164dd073"
Related object type, i.e. redemption.
Timestamp representing the date and time when the customer was referred in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the object represented by JSON.
customer 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 for sending out codes to customers via an SMS channel.
Customer's birthdate; format YYYY-MM-DD.
Customer's address.
Show child attributes
Show child attributes
City
State
First line of address.
Second line of address.
Country.
Postal code.
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.
The ID of an existing customer that will be linked to the redemption in this request.
A unique identifier of the customer who validates a voucher.
Object used to store system metadata information.
Timestamp representing the date and time when the customer was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Timestamp representing the date and time when the customer was updated in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Customer details with details about loyalty and referral programs.
- Referrer With Summary Loyalty Referrals
- Referrer Id
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Total number of the redemptions made by the customer.
Total number of the redemptions that failed.
Total number of the redemptions that succeeded.
Total number of the redemptions that were rolled back for the customer.
Total number of the redemption rollbacks that failed.
Total number of the redemption rollbacks that succeeded.
Summary of gift card credits.
Show child attributes
Show child attributes
Total amount of gift card credits redeemed by the customer. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Remaining gift card balance across all gift cards. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Summary of loyalty points.
Show child attributes
Show child attributes
Total number of the loyalty points redeemed by the customer.
Sum of the remaining available point balance across all loyalty cards.
Show child attributes
Show child attributes
The total amount spent by the customer. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Total number of orders made by the customer.
Average amount spent on orders. total_amount ÷ total_count. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Amount spent on last order. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Timestamp representing the date and time of the customer's last order in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
Show child attributes
Show child attributes
Remaining point balance in campaign.
Customer's loyalty tier within the campaign.
"ltr_UJ5Q54Q0OvEhua87Qfv2Ki5x"
Number of customers referred by the customer in the campaign.
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Unique identifier of the campaign assigned by Voucherify.
"camp_rRsfatlwN7unSeUIJDCYedal"
Unique referrer ID assigned by Voucherify. This is the customer ID of a customer that is referring this customer.
"cust_sehkNIi8Uq2qQuRqSr7xn4Zi"
Related object id
"r_0b9d4cc4aa164dd073"
Related object type, i.e. redemption.
Timestamp representing the date and time when the customer was referred in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the object represented by JSON.
customer 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 for sending out codes to customers via an SMS channel.
Customer's birthdate; format YYYY-MM-DD.
Customer's address.
Show child attributes
Show child attributes
City
State
First line of address.
Second line of address.
Country.
Postal code.
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.
The ID of an existing customer that will be linked to the redemption in this request.
A unique identifier of the customer who validates a voucher.
Object used to store system metadata information.
Timestamp representing the date and time when the customer was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Timestamp representing the date and time when the customer was updated in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Order information. Order information.
Show child attributes
Show child attributes
Unique identifier assigned by Voucherify of an existing order that is linked to the redemption of this request.
Unique source ID of an existing order that is linked to the redemption of this request.
Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.
"cust_7iUa6ICKyU6gH40dBU25kQU1"
Unique identifier of the referrer assigned by Voucherify.
"cust_nM4jqPiaXUvQdVSA6vTRUnix"
The type of the object represented by JSON.
order Timestamp representing the date and time when the order was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Timestamp representing the date and time when the order was last updated in the ISO 8601 format.
"024-01-01T11:11:11.111Z"
Order status.
CREATED, PAID, CANCELED, FULFILLED 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.
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.
Sum of all order-level discounts applied to the order.
Sum of all product-specific discounts applied to the order.
Sum of all order-level AND all product-specific discounts applied to the order.
Order amount after undoing all the discounts through the rollback redemption.
This field shows the order-level discount applied.
Sum of all product-specific discounts applied in a particular request.
sum(items, i => i.applied_discount_amount)
Sum of all order-level AND all product-specific discounts applied in a particular request.
total_applied_discount_amount = applied_discount_amount + items_applied_discount_amount
Array of items applied to the order.
Show child attributes
Show child attributes
The type of the object represented by JSON.
order_item 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.
product, sku 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
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.
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.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Timestamp representing the date and time when the redemption was created in ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Unique identifier of the redemption rollback.
"rr_0c63c84eb78ee0a6c0"
Timestamp representing the date and tiem when the redemption rollback was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The source of the incentive.
Unique identifier of the parent redemption.
"r_0ba186c4824e4881e1"
Represent's the campaign ID of the voucher if the redemption was based on a voucher that was part of bulk codes generated within a campaign. In case of a promotion tier, this represents the campaign ID of the promotion tier's parent campaign.
Contains a list of unique IDs of child redemptions, which belong to the stacked incentives.
Lists the rollback redemption IDs of the particular child redemptions.
Customer details with details about loyalty and referral programs.
- Customer With Summary Loyalty Referrals
- Customer ID
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Total number of the redemptions made by the customer.
Total number of the redemptions that failed.
Total number of the redemptions that succeeded.
Total number of the redemptions that were rolled back for the customer.
Total number of the redemption rollbacks that failed.
Total number of the redemption rollbacks that succeeded.
Summary of gift card credits.
Show child attributes
Show child attributes
Total amount of gift card credits redeemed by the customer. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Remaining gift card balance across all gift cards. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Summary of loyalty points.
Show child attributes
Show child attributes
Total number of the loyalty points redeemed by the customer.
Sum of the remaining available point balance across all loyalty cards.
Show child attributes
Show child attributes
The total amount spent by the customer. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Total number of orders made by the customer.
Average amount spent on orders. total_amount ÷ total_count. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Amount spent on last order. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Timestamp representing the date and time of the customer's last order in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
Show child attributes
Show child attributes
Remaining point balance in campaign.
Customer's loyalty tier within the campaign.
"ltr_UJ5Q54Q0OvEhua87Qfv2Ki5x"
Number of customers referred by the customer in the campaign.
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Unique identifier of the campaign assigned by Voucherify.
"camp_rRsfatlwN7unSeUIJDCYedal"
Unique referrer ID assigned by Voucherify. This is the customer ID of a customer that is referring this customer.
"cust_sehkNIi8Uq2qQuRqSr7xn4Zi"
Related object id
"r_0b9d4cc4aa164dd073"
Related object type, i.e. redemption.
Timestamp representing the date and time when the customer was referred in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the object represented by JSON.
customer 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 for sending out codes to customers via an SMS channel.
Customer's birthdate; format YYYY-MM-DD.
Customer's address.
Show child attributes
Show child attributes
City
State
First line of address.
Second line of address.
Country.
Postal code.
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.
The ID of an existing customer that will be linked to the redemption in this request.
A unique identifier of the customer who validates a voucher.
Object used to store system metadata information.
Timestamp representing the date and time when the customer was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Timestamp representing the date and time when the customer was updated in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Customer details with details about loyalty and referral programs.
- Referrer With Summary Loyalty Referrals
- Referrer Id
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Total number of the redemptions made by the customer.
Total number of the redemptions that failed.
Total number of the redemptions that succeeded.
Total number of the redemptions that were rolled back for the customer.
Total number of the redemption rollbacks that failed.
Total number of the redemption rollbacks that succeeded.
Summary of gift card credits.
Show child attributes
Show child attributes
Total amount of gift card credits redeemed by the customer. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Remaining gift card balance across all gift cards. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Summary of loyalty points.
Show child attributes
Show child attributes
Total number of the loyalty points redeemed by the customer.
Sum of the remaining available point balance across all loyalty cards.
Show child attributes
Show child attributes
The total amount spent by the customer. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Total number of orders made by the customer.
Average amount spent on orders. total_amount ÷ total_count. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Amount spent on last order. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Timestamp representing the date and time of the customer's last order in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
Show child attributes
Show child attributes
Remaining point balance in campaign.
Customer's loyalty tier within the campaign.
"ltr_UJ5Q54Q0OvEhua87Qfv2Ki5x"
Number of customers referred by the customer in the campaign.
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Unique identifier of the campaign assigned by Voucherify.
"camp_rRsfatlwN7unSeUIJDCYedal"
Unique referrer ID assigned by Voucherify. This is the customer ID of a customer that is referring this customer.
"cust_sehkNIi8Uq2qQuRqSr7xn4Zi"
Related object id
"r_0b9d4cc4aa164dd073"
Related object type, i.e. redemption.
Timestamp representing the date and time when the customer was referred in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the object represented by JSON.
customer 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 for sending out codes to customers via an SMS channel.
Customer's birthdate; format YYYY-MM-DD.
Customer's address.
Show child attributes
Show child attributes
City
State
First line of address.
Second line of address.
Country.
Postal code.
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.
The ID of an existing customer that will be linked to the redemption in this request.
A unique identifier of the customer who validates a voucher.
Object used to store system metadata information.
Timestamp representing the date and time when the customer was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Timestamp representing the date and time when the customer was updated in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Show child attributes
Show child attributes
Simplified customer data.
Show child attributes
Show child attributes
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.
customer Unique reward assignment ID assigned by Voucherify.
Defines the voucher reward.
Show child attributes
Show child attributes
Assigned by the Voucherify API, identifies the voucher.
"v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV"
A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.
"WVPblOYX"
A unique campaign name, identifies the voucher's parent campaign.
"Gift Card Campaign"
Assigned by the Voucherify API, identifies the voucher's parent campaign.
"camp_FNYR4jhqZBM9xTptxDGgeNBV"
Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint.
Unique category ID assigned by Voucherify.
"cat_0bb343dee3cdb5ec0c"
Contains details about the category.
Show child attributes
Show child attributes
Unique category ID assigned by Voucherify.
Category name.
Category hierarchy.
Timestamp representing the date and time when the category was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the object represented by the JSON. This object stores information about the category.
category Timestamp representing the date and time when the category was updated in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the stacking rule eligibility.
JOINT, EXCLUSIVE Defines the type of the voucher.
GIFT_VOUCHER, DISCOUNT_VOUCHER, LOYALTY_CARD Contains information about discount.
- Discount
- Discount
- Discount
- Discount
- Discount
Show child attributes
Show child attributes
Defines the type of the voucher.
AMOUNT Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.
Maximum discount amount per order.
Defines how the discount is applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS, APPLY_TO_ITEMS_PROPORTIONALLY, APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY, APPLY_TO_ITEMS_BY_QUANTITY Flag indicating whether the discount was calculated using a formula.
Object representing gift parameters. Child attributes are present only if type is GIFT_VOUCHER. Defaults to null.
Show child attributes
Show child attributes
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.
10000
Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.
500
Defines how the credits are applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS Object representing loyalty card parameters. Child attributes are present only if type is LOYALTY_CARD. Defaults to null.
Show child attributes
Show child attributes
Total number of points added to the loyalty card over its lifespan.
7000
Points available for reward redemption. This is calculated as follows: balance = points - expired_points - subtracted_points - redemption.redeemed_points.
6970
The next closest date when the next set of points are due to expire.
"2023-05-30"
The amount of points that are set to expire next.
Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.
Shows the total number of expired points over the lifetime of the loyalty card.
Shows the total number of subtracted points over the lifetime of the loyalty card.
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"
Set recurrent time periods when the voucher is valid. For example, valid for 1 hour every other day. start_date required when including the validity_timeframe.
Show child attributes
Show child attributes
Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a voucher with an interval of P2D will be active every other day.
"P2D"
Defines the amount of time the voucher will be active in ISO 8601 format. For example, a voucher with a duration of PT1H will be valid for a duration of one hour.
"PT1H"
Integer array corresponding to the particular days of the week in which the voucher is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
0, 1, 2, 3, 4, 5, 6 Allows to create Happy Hours scenario.
Show child attributes
Show child attributes
Defines the reccuring period/s of time when the happy hour promotion will be active.
Show child attributes
Show child attributes
Defines the starting hour for the happy hours promotion in HH:mm format. Happy hours are inactive before this time.
"12:00"
Integer array corresponding to the particular days of the week in which the campaign is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
Defines the ending hour for the happy hours promotion in HH:mm format. Happy hours are inactive after this time.
"14:00"
A flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the start_date and expiration_date.
trueindicates an active voucherfalseindicates an inactive voucher
An optional field to keep any extra textual information about the code such as a code description and details.
The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format.
Stores links to images of QR and barcode that correspond to an encrypted voucher code.
Show child attributes
Show child attributes
Stores Quick Response (QR) representation of encrypted code.
Show child attributes
Show child attributes
Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.
Timestamp representing the date and time when the voucher was created in ISO 8601 format.
"2021-12-22T10:13:06.487Z"
Timestamp representing the date and time when the voucher was last updated in ISO 8601 format.
"2021-12-22T10:14:45.316Z"
Unique customer ID of voucher owner.
"cust_eWgXlBBiY6THFRJwX45Iakv4"
List of Validation Rules Assignments
Show child attributes
Show child attributes
The type of the object represented by JSON. This object stores information about validation rules assignments.
list Identifies the name of the attribute that contains the array of validation rules assignments.
data Contains array of validation rules assignments.
Show child attributes
Show child attributes
The unique identifier for an assignment.
The unique identifier for a rule.
The unique identifier for a related object.
The type of a related object.
campaign, voucher, earning_rule The type of the object represented by JSON.
validation_rules_assignment The validation status of the assignment.
VALID, PARTIALLY_VALID, INVALID The list of omitted rules.
Timestamp representing the date and time when the object was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Timestamp representing the date and time when the object was last updated in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Total number of validation rules assignments.
x >= 0Unique identifier of the referrer assigned by Voucherify.
"cust_nM4jqPiaXUvQdVSA6vTRUnix"
The type of the object represented by JSON. Default is voucher.
This object stores a summary of publish events: an events counter and an endpoint which can be called to return details of each event. A publication is required for loyalty cards and referral codes. This object gets updated whenever a voucher has been published. Publication means assigning a code to a particular customer.
Show child attributes
Show child attributes
The type of the object represented is by default list. To get this list, you need to make a call to the endpoint returned in the url attribute.
Publication events counter.
0
The endpoint where this list of publications can be accessed using a GET method. /v1/vouchers/{voucher_code}/publications
"/v1/vouchers/WVPblOYX/publications?page=1&limit=10"
Stores a summary of redemptions that have been applied to the voucher.
Show child attributes
Show child attributes
How many times a voucher can be redeemed. A null value means unlimited.
How many times a voucher has already been redeemed.
1
Total amount redeemed. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 balance is written as 10000.
100000
Total loyalty points redeemed.
100000
The type of the object represented is by default list. To get this list, you need to make a call to the endpoint returned in the url attribute.
The endpoint where this list of redemptions can be accessed using a GET method. /v1/vouchers/{voucher_code}/redemptions
"/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"
Defines the product reward.
Show child attributes
Show child attributes
Unique product ID assigned by Voucherify.
"prod_0b1da8105693710357"
Unique product source ID.
"productSourceID16"
Unique user-defined product name.
"T-shirt"
Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as $100.00 being expressed as 10000.
A list of product attributes whose values you can customize for given SKUs: ["color","size","ranking"]. Each child SKU can have a unique value for a given attribute.
The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format.
The type of the object represented by JSON. This object stores information about the product.
product The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image.
"https://images.com/original.jpg"
Timestamp representing the date and time when the product was created in the ISO 8601 format.
"2022-05-23T06:52:55.008Z"
Timestamp representing the date and time when the product was updated in the ISO 8601 format.
"2022-05-23T09:24:07.405Z"
Contains information about child SKUs.
Show child attributes
Show child attributes
The type of the object represented by JSON. This object stores information about SKUs.
Identifies the name of the JSON property that contains the array of SKUs.
A dictionary that contains an array of SKUs.
Show child attributes
Show child attributes
A unique identifier that represents the SKU and is assigned by Voucherify.
"sku_0b1621b319d248b79f"
A unique SKU identifier from your inventory system.
"sku_source_id_4"
The parent product's unique ID.
"prod_0b15f6b9f650c16990"
Unique user-defined SKU name.
"Large Pink Shirt"
Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as $100.00 being expressed as 10000.
The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family.
The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image.
The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format.
Timestamp representing the date and time when the SKU was created in the ISO 8601 format.
"2022-05-17T10:36:30.187Z"
Timestamp representing the date and time when the SKU was updated in the ISO 8601 format.
"2022-05-17T10:55:09.137Z"
The type of the object represented by JSON. This object stores information about the SKU.
sku SKU price currency.
"USD"
Total number of SKUs in the product.
Defines the SKU reward.
Show child attributes
Show child attributes
A unique identifier that represents the SKU and is assigned by Voucherify.
"sku_0b1621b319d248b79f"
A unique SKU identifier from your inventory system.
"sku_source_id_4"
The parent product's unique ID.
"prod_0b15f6b9f650c16990"
Unique user-defined SKU name.
"Large Pink Shirt"
Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as $100.00 being expressed as 10000.
The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family.
The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image.
The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format.
Timestamp representing the date and time when the SKU was created in the ISO 8601 format.
"2022-05-17T10:36:30.187Z"
Timestamp representing the date and time when the SKU was updated in the ISO 8601 format.
"2022-05-17T10:55:09.137Z"
The type of the object represented by JSON. This object stores information about the SKU.
sku SKU price currency.
"USD"
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
reward 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"
Defines how the reward is generated. These are parameters representing a Campaign reward. These can be in the form of discount coupons, gift card credits, or loyalty point credits.
- Campaign
- Pay with Points
- Material
Show child attributes
Show child attributes
Objects stores information about the campaign related to the reward.
- Discount Coupons
- Gift Vouchers
- Points on loyalty card
Show child attributes
Show child attributes
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.
CAMPAIGN, COIN, MATERIAL 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
System generated cause for the redemption being invalid in the context of the provided parameters.
Redemption result.
SUCCESS, FAILURE Redemption status.
SUCCEEDED, FAILED Show child attributes
Show child attributes
Show child attributes
Show child attributes
Unique rollback redemption ID.
"rr_0bc92f81a6801f9bca"
Timestamp representing the date and time when the object was created in the ISO 8601 format.
"2021-12-22T10:13:06.487Z"
Show child attributes
Show child attributes
Unique redemption ID of the parent redemption.
"r_0c656311b5878a2031"
Unique redemption ID of the parent redemption.
"r_0c656311b5878a2031"
Simplified customer data.
Show child attributes
Show child attributes
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.
customer Unique customer ID of the redeeming customer.
"cust_i8t5Tt6eiKG5K79KQlJ0Vs64"
Defines the related object.
voucher, promotion_tier 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.
Show child attributes
Show child attributes
Assigned by the Voucherify API, identifies the voucher.
"v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV"
A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.
"WVPblOYX"
A unique campaign name, identifies the voucher's parent campaign.
"Gift Card Campaign"
Assigned by the Voucherify API, identifies the voucher's parent campaign.
"camp_FNYR4jhqZBM9xTptxDGgeNBV"
Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint.
Unique category ID assigned by Voucherify.
"cat_0bb343dee3cdb5ec0c"
Contains details about the category.
Show child attributes
Show child attributes
Unique category ID assigned by Voucherify.
Category name.
Category hierarchy.
Timestamp representing the date and time when the category was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the object represented by the JSON. This object stores information about the category.
category Timestamp representing the date and time when the category was updated in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the stacking rule eligibility.
JOINT, EXCLUSIVE Defines the type of the voucher.
GIFT_VOUCHER, DISCOUNT_VOUCHER, LOYALTY_CARD Contains information about discount.
- Discount
- Discount
- Discount
- Discount
- Discount
Show child attributes
Show child attributes
Defines the type of the voucher.
AMOUNT Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.
Maximum discount amount per order.
Defines how the discount is applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS, APPLY_TO_ITEMS_PROPORTIONALLY, APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY, APPLY_TO_ITEMS_BY_QUANTITY Flag indicating whether the discount was calculated using a formula.
Object representing gift parameters. Child attributes are present only if type is GIFT_VOUCHER. Defaults to null.
Show child attributes
Show child attributes
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.
10000
Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.
500
Defines how the credits are applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS Object representing loyalty card parameters. Child attributes are present only if type is LOYALTY_CARD. Defaults to null.
Show child attributes
Show child attributes
Total number of points added to the loyalty card over its lifespan.
7000
Points available for reward redemption. This is calculated as follows: balance = points - expired_points - subtracted_points - redemption.redeemed_points.
6970
The next closest date when the next set of points are due to expire.
"2023-05-30"
The amount of points that are set to expire next.
Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.
Shows the total number of expired points over the lifetime of the loyalty card.
Shows the total number of subtracted points over the lifetime of the loyalty card.
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"
Set recurrent time periods when the voucher is valid. For example, valid for 1 hour every other day. start_date required when including the validity_timeframe.
Show child attributes
Show child attributes
Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a voucher with an interval of P2D will be active every other day.
"P2D"
Defines the amount of time the voucher will be active in ISO 8601 format. For example, a voucher with a duration of PT1H will be valid for a duration of one hour.
"PT1H"
Integer array corresponding to the particular days of the week in which the voucher is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
0, 1, 2, 3, 4, 5, 6 Allows to create Happy Hours scenario.
Show child attributes
Show child attributes
Defines the reccuring period/s of time when the happy hour promotion will be active.
Show child attributes
Show child attributes
Defines the starting hour for the happy hours promotion in HH:mm format. Happy hours are inactive before this time.
"12:00"
Integer array corresponding to the particular days of the week in which the campaign is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
Defines the ending hour for the happy hours promotion in HH:mm format. Happy hours are inactive after this time.
"14:00"
A flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the start_date and expiration_date.
trueindicates an active voucherfalseindicates an inactive voucher
An optional field to keep any extra textual information about the code such as a code description and details.
The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format.
Stores links to images of QR and barcode that correspond to an encrypted voucher code.
Show child attributes
Show child attributes
Stores Quick Response (QR) representation of encrypted code.
Show child attributes
Show child attributes
Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.
Timestamp representing the date and time when the voucher was created in ISO 8601 format.
"2021-12-22T10:13:06.487Z"
Timestamp representing the date and time when the voucher was last updated in ISO 8601 format.
"2021-12-22T10:14:45.316Z"
Unique customer ID of voucher owner.
"cust_eWgXlBBiY6THFRJwX45Iakv4"
List of Validation Rules Assignments
Show child attributes
Show child attributes
The type of the object represented by JSON. This object stores information about validation rules assignments.
list Identifies the name of the attribute that contains the array of validation rules assignments.
data Contains array of validation rules assignments.
Show child attributes
Show child attributes
The unique identifier for an assignment.
The unique identifier for a rule.
The unique identifier for a related object.
The type of a related object.
campaign, voucher, earning_rule The type of the object represented by JSON.
validation_rules_assignment The validation status of the assignment.
VALID, PARTIALLY_VALID, INVALID The list of omitted rules.
Timestamp representing the date and time when the object was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Timestamp representing the date and time when the object was last updated in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Total number of validation rules assignments.
x >= 0Unique identifier of the referrer assigned by Voucherify.
"cust_nM4jqPiaXUvQdVSA6vTRUnix"
The type of the object represented by JSON. Default is voucher.
This object stores a summary of publish events: an events counter and an endpoint which can be called to return details of each event. A publication is required for loyalty cards and referral codes. This object gets updated whenever a voucher has been published. Publication means assigning a code to a particular customer.
Show child attributes
Show child attributes
The type of the object represented is by default list. To get this list, you need to make a call to the endpoint returned in the url attribute.
Publication events counter.
0
The endpoint where this list of publications can be accessed using a GET method. /v1/vouchers/{voucher_code}/publications
"/v1/vouchers/WVPblOYX/publications?page=1&limit=10"
Stores a summary of redemptions that have been applied to the voucher.
Show child attributes
Show child attributes
How many times a voucher can be redeemed. A null value means unlimited.
How many times a voucher has already been redeemed.
1
Total amount redeemed. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 balance is written as 10000.
100000
Total loyalty points redeemed.
100000
The type of the object represented is by default list. To get this list, you need to make a call to the endpoint returned in the url attribute.
The endpoint where this list of redemptions can be accessed using a GET method. /v1/vouchers/{voucher_code}/redemptions
"/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"
Contains details of the promotion tier and the parent campaign.
Show child attributes
Show child attributes
Unique promotion tier ID.
"promo_63fYCt81Aw0h7lzyRkrGZh9p"
Timestamp representing the date and time when the promotion tier was created in the ISO 8601 format.
"2021-12-15T11:34:01.333Z"
Timestamp representing the date and time when the promotion tier was updated 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.
Show child attributes
Show child attributes
Contains information about discount.
- Discount
- Discount
- Discount
- Discount
- Discount
Show child attributes
Show child attributes
Defines the type of the voucher.
AMOUNT Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.
Maximum discount amount per order.
Defines how the discount is applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS, APPLY_TO_ITEMS_PROPORTIONALLY, APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY, APPLY_TO_ITEMS_BY_QUANTITY Flag indicating whether the discount was calculated using a formula.
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.
Show child attributes
Show child attributes
Unique campaign ID.
Activation timestamp defines when the campaign starts to be active in the ISO 8601 format. Campaign is inactive before this date.
"2022-09-22T00:00:00.000Z"
Expiration timestamp defines when the campaign expires in the ISO 8601 format. Campaign is inactive after this date.
"2022-09-30T00:00:00.000Z"
Recurrent time periods when the campaign is valid. For example, valid for 1 hour every other day.
Show child attributes
Show child attributes
Defines the intervening time between two time points in the ISO 8601 format, expressed as a duration. For example, a campaign with an interval of P2D will be active every other day.
Defines the amount of time the campaign will be active in the ISO 8601 format. For example, a campaign with a duration of P1D will be valid for a duration of one day.
Integer array corresponding to the particular days of the week in which the campaign is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
0, 1, 2, 3, 4, 5, 6 Allows to create Happy Hours scenario.
Show child attributes
Show child attributes
Defines the reccuring period/s of time when the happy hour promotion will be active.
Show child attributes
Show child attributes
Defines the starting hour for the happy hours promotion in HH:mm format. Happy hours are inactive before this time.
"12:00"
Integer array corresponding to the particular days of the week in which the campaign is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
Defines the ending hour for the happy hours promotion in HH:mm format. Happy hours are inactive after this time.
"14:00"
A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the start_date and expiration_date using the Disable Campaign endpoint.
trueindicates an active campaignfalseindicates an inactive campaign
Unique category ID that this campaign belongs to.
"cat_0b688929a2476386a6"
The type of the object represented by the campaign object. This object stores information about the 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.
trueindicates an active promotion tierfalseindicates an inactive promotion tier
Activation timestamp defines when the promotion tier starts to be active in the 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 the ISO 8601 format. Promotion tier is inactive after this date.
"2022-09-26T00:00:00.000Z"
Set recurrent time periods when the promotion tier is valid. For example, valid for 1 hour every other day. start_date required when including the validity_timeframe.
Show child attributes
Show child attributes
Defines the intervening time between two time points in the ISO 8601 format, expressed as a duration. For example, a promotion tier with an interval of P2D will be active every other day.
Defines the amount of time the promotion tier will be active in the ISO 8601 format. For example, a promotion tier with a duration of P1D will be valid for a duration of one day.
Integer array corresponding to the particular days of the week in which the promotion tier is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
0, 1, 2, 3, 4, 5, 6 Allows to create Happy Hours scenario.
Show child attributes
Show child attributes
Defines the reccuring period/s of time when the happy hour promotion will be active.
Show child attributes
Show child attributes
Defines the starting hour for the happy hours promotion in HH:mm format. Happy hours are inactive before this time.
"12:00"
Integer array corresponding to the particular days of the week in which the campaign is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
Defines the ending hour for the happy hours promotion in HH:mm format. Happy hours are inactive after this time.
"14:00"
Contains statistics about promotion tier redemptions and orders.
Show child attributes
Show child attributes
The type of the object represented by JSON. This object stores information about the promotion tier.
Validation Rule Assignments List
Show child attributes
Show child attributes
The type of the object represented by JSON. This object stores information about validation rule assignments.
Identifies the name of the JSON property that contains the array of validation rule assignments.
A dictionary that contains an array of validation rule assignments.
Show child attributes
Show child attributes
Validation rule assignment ID.
"asgm_74F7QZoYbUoljwQO"
Validation rule ID.
"val_4j7DCRm2IS59"
The resource ID to which the validation rule was assigned.
"v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT"
The type of resource to which the validation rule was assigned.
voucher, campaign, earning_rule, reward_assignment, promotion_tier, distribution Timestamp representing the date and time when the validation rule assignment was created in the ISO 8601 format.
"2022-02-17T08:18:15.085Z"
The type of the object represented by the ID.
validation_rules_assignment Total number of validation rule assignments.
Promotion tier category ID.
"cat_0c9da30e7116ba6bba"
Show child attributes
Show child attributes
Unique category ID assigned by Voucherify.
Category name.
Category hierarchy.
Timestamp representing the date and time when the category was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the object represented by the JSON. This object stores information about the category.
category Timestamp representing the date and time when the category was updated in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the stacking rule eligibility.
JOINT, EXCLUSIVE Details about the campaign related to the distribution with a promotion or send voucher purpose.
Show child attributes
Show child attributes
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 criteriaSTATIC: vouchers need to be manually publishedSTANDALONE: campaign for single vouchers
AUTO_UPDATE, STATIC, STANDALONE Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.
Simplified campaign voucher data.
Show child attributes
Show child attributes
Type of the voucher.
DISCOUNT_VOUCHER, LOYALTY_CARD, GIFT_VOUCHER Defines the redemption limits on vouchers.
Schema containing information about config used for voucher. Defines the code pattern (prefix, suffix, length, charset, etc).
Show child attributes
Show child attributes
Number of characters in a generated code (excluding prefix and postfix).
Characters that can appear in the code.
A text appended before the code.
A text appended after the code.
A pattern for codes where hashes (#) will be replaced with random characters. Overrides length.
The initial count.
Defines the voucher discount type and details. It will not be returned at all or it will return a null for LOYALTY_CARD.
- Discount
- Discount
- Discount
- Discount
- Discount
Show child attributes
Show child attributes
Defines the type of the voucher.
AMOUNT Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.
Maximum discount amount per order.
Defines how the discount is applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS, APPLY_TO_ITEMS_PROPORTIONALLY, APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY, APPLY_TO_ITEMS_BY_QUANTITY Flag indicating whether the discount was calculated using a formula.
Defines the voucher gift details. It will not be returned at all or it will return a null for LOYALTY_CARD.
Show child attributes
Show child attributes
Total gift card income over the lifetime of the card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.
Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.
Defines how the credits are applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS Defines the voucher loyalty card details. It will not be returned at all or it will return a null for DISCOUNT_VOUCHER or GIFT_CARD.
Show child attributes
Show child attributes
The initial number of points to assign to the loyalty card. This is the current loyalty card score i.e. the number of loyalty points on the card.
Defines the loyalty point expiration rule. This expiration rule applies when there are no expiration_rules defined for an earning rule.
Show child attributes
Show child attributes
Type of period. Can be set for MONTH or FIXED_DAY_OF_YEAR. MONTH requires the period_value field. FIXED_DAY_OF_YEAR requires the fixed_month and fixed_day fields.
FIXED_DAY_OF_YEAR, MONTH Value of the period. Required for the period_type: MONTH.
Type of rounding of the expiration period. Optional for the period_type: MONTH.
END_OF_MONTH, END_OF_QUARTER, END_OF_HALF_YEAR, END_OF_YEAR, PARTICULAR_MONTH Value of rounding of the expiration period. Required for the rounding_type.
Determines the month when the points expire; 1 is January, 2 is February, and so on. Required for the period_type: FIXED_DAY_OF_YEAR.
1 <= x <= 12Determines the day of the month when the points expire. Required for the period_type: FIXED_DAY_OF_YEAR.
1 <= x <= 31Defines the referee reward and the way a referral is triggered. Context: REFERRAL_PROGRAM.
Show child attributes
Show child attributes
Defines how a referral is triggered.
redemption, custom_event Defines the referee reward.
Show child attributes
Show child attributes
Details of the resource from which the reward originates.
Show child attributes
Show child attributes
Unique identifier of the reward source.
"camp_kdxp3vf1clQ9CFs1jpqv3tZe"
Name of the reward source.
Type of resource represented by the source of the reward.
CAMPAIGN Type of reward.
DISCOUNT_VOUCHER, LOYALTY_CARD, GIFT_VOUCHER Define the number of points to add to a loyalty card or credits to the balance on a gift card. In case of the gift card, the value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.
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. It is always true for loyalty campaigns.
Indicates whether the campaign is active.
The unique category ID that this campaign belongs to.
Unique category name.
Contains details about the category.
Show child attributes
Show child attributes
Unique category ID assigned by Voucherify.
Category name.
Category hierarchy.
Timestamp representing the date and time when the category was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the object represented by the JSON. This object stores information about the category.
category Timestamp representing the date and time when the category was updated in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the stacking rule eligibility.
JOINT, EXCLUSIVE 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.
campaign Details about the voucher related to the distribution with a send voucher purpose.
Show child attributes
Show child attributes
Voucher code.
Type of the voucher.
DISCOUNT_VOUCHER, LOYALTY_CARD, GIFT_VOUCHER Timestamp representing the date and time when the order was created in the ISO 8601 format.
"2021-12-22T10:13:06.487Z"
The type of the object represented by JSON.
voucher A unique identifier that represents the voucher assigned by Voucherify.
Gift object response.
Show child attributes
Show child attributes
Total gift card income over the lifetime of the card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.
Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.
Defines how the credits are applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS Contains information about discount.
- Discount
- Discount
- Discount
- Discount
- Discount
Show child attributes
Show child attributes
Defines the type of the voucher.
AMOUNT Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.
Maximum discount amount per order.
Defines how the discount is applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS, APPLY_TO_ITEMS_PROPORTIONALLY, APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY, APPLY_TO_ITEMS_BY_QUANTITY Flag indicating whether the discount was calculated using a formula.
Defines the loyalty card details. Simplified loyalty card data.
Show child attributes
Show child attributes
Total number of points added to the loyalty card over its lifespan.
Points available for reward redemption. This is calculated as follows: balance = points - expired_points - subtracted_points - redemption.redeemed_points.
The next closest date when the next set of points are due to expire.
The amount of points that are set to expire next.
Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.
Shows the total number of expired points over the lifetime of the loyalty card.
Shows the total number of subtracted points over the lifetime of the loyalty card.
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.
Show child attributes
Show child attributes
Unique category ID assigned by Voucherify.
Category name.
Category hierarchy.
Timestamp representing the date and time when the category was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the object represented by the JSON. This object stores information about the category.
category Timestamp representing the date and time when the category was updated in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the stacking rule eligibility.
JOINT, EXCLUSIVE 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. The value is shown in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
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.
Details about the publication related to the distribution with a send voucher purpose.
Show child attributes
Show child attributes
Unique identifier of the publication assigned by Voucherify.
"pub_BbjAXnmm8e0SIm3zG8qvvFCP0KuLywtp"
The type of the object represented by the JSON. This object stores information about the publication.
publication Timestamp representing the date and time when the publication was created in the ISO 8601 format.
"2022-09-23T09:57:00.434Z"
Unique identifier of the customer receiving the publication.
"cust_eWgXlBBiY6THFRJwX45Iakv4"
The metadata object stores all custom attributes assigned to the publication.
How the publication was originated.
Unique identifier of the merchant's publication if it is different from the Voucherify publication ID.
Customer details with details about loyalty and referral programs.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Total number of the redemptions made by the customer.
Total number of the redemptions that failed.
Total number of the redemptions that succeeded.
Total number of the redemptions that were rolled back for the customer.
Total number of the redemption rollbacks that failed.
Total number of the redemption rollbacks that succeeded.
Summary of gift card credits.
Show child attributes
Show child attributes
Total amount of gift card credits redeemed by the customer. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Remaining gift card balance across all gift cards. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Summary of loyalty points.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The total amount spent by the customer. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Total number of orders made by the customer.
Average amount spent on orders. total_amount ÷ total_count. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Amount spent on last order. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.
Timestamp representing the date and time of the customer's last order in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
Show child attributes
Show child attributes
Remaining point balance in campaign.
Customer's loyalty tier within the campaign.
"ltr_UJ5Q54Q0OvEhua87Qfv2Ki5x"
Number of customers referred by the customer in the campaign.
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Unique identifier of the campaign assigned by Voucherify.
"camp_rRsfatlwN7unSeUIJDCYedal"
Unique referrer ID assigned by Voucherify. This is the customer ID of a customer that is referring this customer.
"cust_sehkNIi8Uq2qQuRqSr7xn4Zi"
Related object id
"r_0b9d4cc4aa164dd073"
Related object type, i.e. redemption.
Timestamp representing the date and time when the customer was referred in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the object represented by JSON.
customer 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 for sending out codes to customers via an SMS channel.
Customer's birthdate; format YYYY-MM-DD.
Customer's address.
Show child attributes
Show child attributes
City
State
First line of address.
Second line of address.
Country.
Postal code.
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.
The ID of an existing customer that will be linked to the redemption in this request.
A unique identifier of the customer who validates a voucher.
Object used to store system metadata information.
Timestamp representing the date and time when the customer was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Timestamp representing the date and time when the customer was updated in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Contains the unique internal voucher ID that was assigned by Voucherify.
Customer's source_id.
Status of the publication attempt.
SUCCESS Details about the promotion tier related to the distribution with a promotion purpose.
Show child attributes
Show child attributes
Unique promotion tier ID.
"promo_63fYCt81Aw0h7lzyRkrGZh9p"
Name of the promotion tier.
Text to be displayed to your customers on your website.
A set of custom key/value pairs that you can attach to a promotion tier. The metadata object stores all custom attributes assigned to the promotion tier.
Response
Webhook accepted
Was this page helpful?