Endpoints
Events
- Introduction to Voucherify webhooks
- Project settings webhooks
- Distribution webhooks
- HOOKCreated
- HOOKDisabled
- HOOKEnabled
- HOOKUpdated
- HOOKPublished
- HOOKLoyalty Card Transaction Created
- HOOKLoyalty Card Pending Points Activated
- HOOKLoyalty Card Pending Points Added
- HOOKLoyalty Card Pending Points Canceled
- HOOKLoyalty Card Pending Points Updated
- HOOKLoyalty Card Points Added
- HOOKLoyalty Card Points Expired
- HOOKGift Transaction Created
- HOOKGift Balance Added
- HOOKDeleted
- HOOK
EVENTS.VOUCHER.GIFT.TRANSACTION.CREATED event indicates that a transaction has been created for a gift voucher. It provides real-time notification that the gift voucher’s balance has been increased.
The following transaction types trigger the event:
CREDITS_ADDITIONCREDITS_REMOVALCREDITS_REFUNDCREDITS_REDEMPTION
Body
Event data object schema for voucher.gift.transaction.created.
Transaction details of the voucher.
Show child attributes
Show child attributes
Unique identifier of the transaction.
The merchant's product ID (if it is different than Voucherify's product ID).
Unique identifier of the voucher.
Unqiue identifier of the voucher's parent campaign if it is part of campaign that generates bulk codes.
The channel through which the transaction took place, whether through the API, Dashboard, or integrated tool. In case of a redemption, this value is null.
voucherify-web-ui, voucherify-mobile-ui, voucherify-cockpits-ui, bigcommerce-integration, bigcommerce-webhook-handler, bigcommerce.priority-webhook-handler, shopify_public-webhook-handler, shopify_public.priority-webhook-handler, activecampaign-webhook-handler, mparticle-webhook-handler, API, Automation Reason why the transaction occurred. In case of a redemption, this value is null.
Type of transaction.
PENDING_POINTS_ACTIVATION, POINTS_ACCRUAL, POINTS_REDEMPTION, POINTS_REFUND, POINTS_ADDITION, POINTS_REMOVAL, POINTS_EXPIRATION, POINTS_TRANSFER_IN, POINTS_TRANSFER_OUT Contains the detailed information about the transaction.
Show child attributes
Show child attributes
Contains information on how the balance was affected by the transaction.
Show child attributes
Show child attributes
The number of all points or credits accumulated on the card as affected by add or subtract operations.
The type of the object represented by the JSON.
balance The available points or credits on the card after the transaction as affected by redemption or rollback.
Defines the resource that is being modified with the values that are returned in the balance object.
Show child attributes
Show child attributes
The type of voucher whose balance is being adjusted due to the transaction.
loyalty_card, gift_voucher Credits added or subtracted on a gift card.
Points added or subtracted in the transaction of a loyalty card.
The type of the operation being performed. The operation type is AUTOMATIC if it is an automatic redemption.
MANUAL, AUTOMATIC Contains information about the earning rule.
Show child attributes
Show child attributes
Unique identifier of an earning rule, assigned by Voucherify.
Contains information about the loyalty tier that is mapped for the earning rule and used in the transaction.
Loyalty tier of the loyalty card holder at the moment when the transaction occurred. The loyalty tier is the tier in which the holder was before the loyalty point balance changed.
Contains details about the pending point entry.
Show child attributes
Show child attributes
Unique identifier of the pending point entry, assigned by Voucherify.
"lopp_0ffd593d5ad207ba6b"
Unique identifier of the loyalty card, assigned by Voucherify.
"v_abCdEfghI1JKLMNPqRS2Tu3vWXyza4bc"
Unique campaign identifier, assigned by Voucherify.
"camp_weer1c3p5ZgktqfW56RfoNaG"
Unique customer identifier, assigned by Voucherify.
"cust_IdgAFZxYwwHctOk9ppZMu319"
Unique order identifier, assigned by Voucherify.
"ord_0ffc0fa65f15d2df17"
Number of points in the pending state.
Date when the pending points are activated and added to the customer's loyalty card.
Details about how the pending points were earned.
Show child attributes
Show child attributes
Details about the event that created pending points.
Show child attributes
Show child attributes
Unique event identifier, assigned by Voucherify.
Type of the event that triggered the creation of pending points.
customer.order.paid Unique identifier of the request that triggered the event, assigned by Voucherify.
Unique identifier of the entity that triggered the event, assigned by Voucherify. For pending points, it is the customer_id of the customer who paid for the order.
Timestamp representing the date and time when the event occurred. The value is shown in the ISO 8601 format.
Type of the event.
ACTION, EFFECT Contains the source of the object that initiated the event.
Show child attributes
Show child attributes
Determines the channel that initiated the event.
USER_PORTAL, API, CLIENT_API, INTERNAL "API"
Determines the Voucherify user who triggered the event.
Show child attributes
Show child attributes
Unique identifier of the user.
"user_xyzfghSTprSTUVWXYlk6tuvXYst7FGH7"
Determines the API key used to initiate the event.
Show child attributes
Show child attributes
Channel name in the application keys.
Contains the application ID from the Voucherify API key pair.
"1XXXX5XX-0XXX-XXXb-X7XX-XX2XXaXXX6XX"
Contains information about the earning rule.
Show child attributes
Show child attributes
Unique identifier of an earning rule, assigned by Voucherify.
Contains the custom earning rule name.
Show child attributes
Show child attributes
Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard.
Details about the order that caused adding pending points.
The loyalty tier that is mapped for the earning rule and used in the pending point transaction.
Loyalty tier of the loyalty card holder at the moment when the transaction occurred. The loyalty tier is the tier in which the holder was at the moment pending points were created.
Timestamp representing the date and time when the pending point entry was created. The value is shown in the ISO 8601 format.
Timestamp representing the date and time when the pending point entry was modified. The value is shown in the ISO 8601 format.
Contains information on how the balance on the donor loyalty card was affected by the transaction.
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"
Defines the redemption limits on vouchers.
Show child attributes
Show child attributes
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.
Contains information on how the balance on the receiving loyalty card was affected by the transaction.
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"
Defines the redemption limits on vouchers.
Show child attributes
Show child attributes
Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.
"2021-12-01T00:00:00.000Z"
Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.
"2021-12-31T00:00:00.000Z"
A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher.
The related identifier of the transaction on the receiving card.
Timestamp representing the date and time when the transaction was created in ISO 8601 format.
Object representing a voucher.
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.
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"
Simplified campaign data.
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 redeemable holder.
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 Voucher balance data for gift vouchers
Show child attributes
Show child attributes
The incremental amount added (positive integer) or subtracted (negative integer) to the current balance on the gift voucher. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.
Total income incurred over the lifespan of the gift voucher.
The balance after adding or subtracting a specified amount. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.
The type of voucher being modified.
gift_voucher MANUAL The type of the object represented by JSON. Default is balance.
balance Defines the resource that is being modified with the values that are returned in the balance object.
Order information.
Show child attributes
Show child attributes
The type of the object represented by JSON.
order Unique identifier of an existing order that will be linked to the redemption of this request.
Unique source identifier of an existing order that will be linked to the redemption of this request.
The order status.
CREATED, PAID, CANCELED, FULFILLED 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"
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. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
sum(items, i => i.applied_discount_amount)
Sum of all order-level AND all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
Sum of all order-level AND all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
total_applied_discount_amount = applied_discount_amount + items_applied_discount_amount
Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
Array of items applied to the order. It can include up to 500 items.
Show child attributes
Show child attributes
The type of the object represented by JSON. This object stores information about the order_item.
order_item The merchant’s product/SKU ID (if it is different from the Voucherify product/SKU ID).
Used along with the source_id property. It can be set to either SKU or product.
product, sku A unique product ID assigned by Voucherify.
A unique SKU ID assigned by Voucherify.
The quantity of the particular item in the cart.
Number of dicounted items.
The total amount of the order item (price * quantity).
The sum of all order-item-level discounts applied to the order.
The order-level discount applied.
Unit price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.
Final order amount after the applied discount.
A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
Simplified redemption data.
Show child attributes
Show child attributes
Unique redemption ID.
"r_0bc92f81a6801f9bca"
Timestamp representing the date and time when the redemption was created in the ISO 8601 format.
"2021-12-22T10:13:06.487Z"
SUCCEEDED, FAILED, ROLLED BACK The metadata object stores all custom attributes in the form of key/value pairs assigned to the redemption.
The type of the object represented by the JSON. This object stores information about the redemption.
Unique customer ID of the redeeming customer.
"cust_i8t5Tt6eiKG5K79KQlJ0Vs64"
Hashed customer source ID.
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
Order information.
Show child attributes
Show child attributes
The type of the object represented by JSON.
order Unique identifier of an existing order that will be linked to the redemption of this request.
Unique source identifier of an existing order that will be linked to the redemption of this request.
The order status.
CREATED, PAID, CANCELED, FULFILLED 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"
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. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
sum(items, i => i.applied_discount_amount)
Sum of all order-level AND all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
Sum of all order-level AND all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
total_applied_discount_amount = applied_discount_amount + items_applied_discount_amount
Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
Array of items applied to the order. It can include up to 500 items.
Show child attributes
Show child attributes
The type of the object represented by JSON. This object stores information about the order_item.
order_item The merchant’s product/SKU ID (if it is different from the Voucherify product/SKU ID).
Used along with the source_id property. It can be set to either SKU or product.
product, sku A unique product ID assigned by Voucherify.
A unique SKU ID assigned by Voucherify.
The quantity of the particular item in the cart.
Number of dicounted items.
The total amount of the order item (price * quantity).
The sum of all order-item-level discounts applied to the order.
The order-level discount applied.
Unit price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.
Final order amount after the applied discount.
A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
Simplified redemption reward result data
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
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"
Defines the redemption limits on vouchers.
Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.
"2021-12-01T00:00:00.000Z"
Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.
"2021-12-31T00:00:00.000Z"
A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher.
Unique loyalty tier ID assigned by Voucherify.
Unique reward ID, assigned by Voucherify.
"rew_nIy4gHpQHle2c3pNMwuj7G6j"
The type of the object represented by the JSON. This object stores information about the reward.
reward Reward name.
Timestamp representing the date and time when the reward was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Timestamp representing the date and time when the reward was updated. The value is shown in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Defines how the reward is generated. 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 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 Redemption result.
SUCCESS, FAILURE Defines the details of the voucher being redeemed.
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"
Defines the redemption limits on vouchers.
Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.
"2021-12-01T00:00:00.000Z"
Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.
"2021-12-31T00:00:00.000Z"
A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher.
Simplified promotion tier data.
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.
Unique redemption ID of the parent redemption.
"r_0c656311b5878a2031"
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.
The reason for the redemption rollback.
Defines the details of the channel through which the redemption was issued.
Show child attributes
Show child attributes
Unique channel ID of the user performing the redemption. This is either a user ID from a user using the Voucherify Dashboard, an X-APP-Id of a user using the API, or the reward assignment ID for automatic reward redemption.
The source of the channel for the redemption:
USER - the redemption was made in the Voucherify Dashboard by a user,
API - redemption was made through the API,
`AUTO_REDEEM - the redemption was made for a reward and it was made automatically.
API, AUTO_REDEEM, USER Details about the redemption rollback. Shown only for a redemption rollback.
Show child attributes
Show child attributes
Unique redemption ID.
"r_0bc92f81a6801f9bca"
Timestamp representing the date and time when the redemption was created in the ISO 8601 format.
"2021-12-22T10:13:06.487Z"
SUCCEEDED, FAILED, ROLLED BACK The metadata object stores all custom attributes in the form of key/value pairs assigned to the redemption.
The type of the object represented by the JSON. This object stores information about the redemption.
Unique customer ID of the redeeming customer.
"cust_i8t5Tt6eiKG5K79KQlJ0Vs64"
Hashed customer source ID.
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
Order information.
Show child attributes
Show child attributes
The type of the object represented by JSON.
order Unique identifier of an existing order that will be linked to the redemption of this request.
Unique source identifier of an existing order that will be linked to the redemption of this request.
The order status.
CREATED, PAID, CANCELED, FULFILLED 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"
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. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
sum(items, i => i.applied_discount_amount)
Sum of all order-level AND all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
Sum of all order-level AND all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
total_applied_discount_amount = applied_discount_amount + items_applied_discount_amount
Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
Array of items applied to the order. It can include up to 500 items.
Show child attributes
Show child attributes
The type of the object represented by JSON. This object stores information about the order_item.
order_item The merchant’s product/SKU ID (if it is different from the Voucherify product/SKU ID).
Used along with the source_id property. It can be set to either SKU or product.
product, sku A unique product ID assigned by Voucherify.
A unique SKU ID assigned by Voucherify.
The quantity of the particular item in the cart.
Number of dicounted items.
The total amount of the order item (price * quantity).
The sum of all order-item-level discounts applied to the order.
The order-level discount applied.
Unit price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.
Final order amount after the applied discount.
A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
Simplified redemption reward result data
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
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"
Defines the redemption limits on vouchers.
Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.
"2021-12-01T00:00:00.000Z"
Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.
"2021-12-31T00:00:00.000Z"
A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher.
Unique loyalty tier ID assigned by Voucherify.
Unique reward ID, assigned by Voucherify.
"rew_nIy4gHpQHle2c3pNMwuj7G6j"
The type of the object represented by the JSON. This object stores information about the reward.
reward Reward name.
Timestamp representing the date and time when the reward was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Timestamp representing the date and time when the reward was updated. The value is shown in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Defines how the reward is generated. 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 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 Redemption result.
SUCCESS, FAILURE Defines the details of the voucher being redeemed.
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"
Defines the redemption limits on vouchers.
Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.
"2021-12-01T00:00:00.000Z"
Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.
"2021-12-31T00:00:00.000Z"
A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher.
Simplified promotion tier data.
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.
Unique redemption ID of the parent redemption.
"r_0c656311b5878a2031"
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.
The reason for the redemption rollback.
Defines the details of the channel through which the redemption was issued.
Show child attributes
Show child attributes
Unique channel ID of the user performing the redemption. This is either a user ID from a user using the Voucherify Dashboard, an X-APP-Id of a user using the API, or the reward assignment ID for automatic reward redemption.
The source of the channel for the redemption:
USER - the redemption was made in the Voucherify Dashboard by a user,
API - redemption was made through the API,
`AUTO_REDEEM - the redemption was made for a reward and it was made automatically.
API, AUTO_REDEEM, USER Response
Webhook accepted
Was this page helpful?