Succeeded

The EVENTS.REDEMPTION.SUCCEEDED event indicates that the redemption process was successful. It confirms that the associated voucher codes and promotional tiers have been effectively applied. A redeemable stack sends one redemption.succeeded webhook for each redeemable, plus one extra webhook for the whole stack.

Example5 redeemables → 6 redemption.succeeded webhooks

This event is used in a webhook configured in Project settings in Voucherify dashboard.

This page documents only the event. If you need more details about the webhook payload data that includes this event, go to Introduction to webhooks page.

Body

application/json

Event data object schema for redemption.succeeded.

customer

Simple Customer · object

Simplified customer data.

Show child attributes

customer.id

string

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

customer.name

string

Customer's first and last name.

customer.email

string

Customer's email address.

customer.source_id

string

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

customer.metadata

object

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

customer.object

enum<string>

The type of the object represented by JSON.

Available options:

customer

order

Simple Order · object

Order information.

Show child attributes

order.object

enum<string>

default:order

required

The type of the object represented by JSON.

Available options:

order

order.id

string

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

order.source_id

string

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

order.status

enum<string>

The order status.

Available options:

CREATED,

PAID,

CANCELED,

FULFILLED

order.customer_id

string | null

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

Example:

"cust_7iUa6ICKyU6gH40dBU25kQU1"

order.referrer_id

string | null

Unique identifier of the referrer assigned by Voucherify.

Example:

"cust_nM4jqPiaXUvQdVSA6vTRUnix"

order.amount

integer

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

order.discount_amount

integer

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

order.applied_discount_amount

integer

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

order.items_discount_amount

integer

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

order.items_applied_discount_amount

integer

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

order.total_discount_amount

integer

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

order.total_applied_discount_amount

integer

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

order.total_amount

integer

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

order.items

Simple Order Item · object[]

Array of items applied to the order. It can include up to 500 items.

Show child attributes

order.items.object

enum<string>

default:order_item

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

Available options:

order_item

order.items.source_id

string

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.

Available options:

product,

sku

order.items.product_id

string

A unique product ID assigned by Voucherify.

order.items.sku_id

string

A unique SKU ID assigned by Voucherify.

order.items.quantity

integer

The quantity of the particular item in the cart.

order.items.discount_quantity

integer

Number of dicounted items.

order.items.amount

integer

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

order.items.discount_amount

integer

The sum of all order-item-level discounts applied to the order.

order.items.applied_discount_amount

integer

The order-level discount applied.

order.items.price

integer

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.

order.items.subtotal_amount

integer

Final order amount after the applied discount.

order.metadata

object

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

campaign

Simple Campaign · object

Simplified campaign data.

Show child attributes

campaign.id

string

Campaign ID.

campaign.name

string

Campaign name.

campaign.campaign_type

string

Type of campaign.

campaign.type

enum<string>

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

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

Available options:

AUTO_UPDATE,

STATIC,

STANDALONE

campaign.is_referral_code

boolean

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

campaign.voucher

Simple Campaign Voucher · object

Simplified campaign voucher data.

Show child attributes

campaign.voucher.type

enum<string>

required

Type of the voucher.

Available options:

DISCOUNT_VOUCHER,

LOYALTY_CARD,

GIFT_VOUCHER

campaign.voucher.redemption

object

required

Defines the redemption limits on vouchers.

Show child attributes

campaign.voucher.redemption.quantity

integer | null

required

How many times a voucher can be redeemed. A null value means unlimited.

campaign.voucher.redemption.redeemed_quantity

integer

required

How many times a voucher has already been redeemed.

Example:

1

campaign.voucher.code_config

Code Config Settings · object

required

Schema containing information about config used for voucher. Defines the code pattern (prefix, suffix, length, charset, etc).

Show child attributes

campaign.voucher.code_config.length

number

required

Number of characters in a generated code (excluding prefix and postfix).

campaign.voucher.code_config.charset

string

required

Characters that can appear in the code.

campaign.voucher.code_config.prefix

string

required

A text appended before the code.

campaign.voucher.code_config.postfix

string

required

A text appended after the code.

campaign.voucher.code_config.pattern

string

required

A pattern for codes where hashes (#) will be replaced with random characters. Overrides length.

campaign.voucher.code_config.initial_count

integer

The initial count.

campaign.voucher.discount

Discount · object

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

campaign.voucher.discount.type

enum<string>

default:AMOUNT

required

Defines the type of the voucher.

Available options:

AMOUNT

campaign.voucher.discount.amount_off

number

required

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.

campaign.voucher.discount.amount_off_formula

string

campaign.voucher.discount.aggregated_amount_limit

integer

Maximum discount amount per order.

campaign.voucher.discount.effect

enum<string>

Defines how the discount is applied to the customer's order.

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS,

APPLY_TO_ITEMS_PROPORTIONALLY,

APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY,

APPLY_TO_ITEMS_BY_QUANTITY

campaign.voucher.discount.is_dynamic

boolean

Flag indicating whether the discount was calculated using a formula.

campaign.voucher.gift

Gift · object

Defines the voucher gift details. It will not be returned at all or it will return a null for LOYALTY_CARD.

Show child attributes

campaign.voucher.gift.amount

number

required

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.

campaign.voucher.gift.balance

number

required

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

campaign.voucher.gift.effect

enum<string>

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

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS

campaign.voucher.loyalty_card

Campaign Loyalty Card · object

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

campaign.voucher.loyalty_card.points

integer

required

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.

campaign.voucher.loyalty_card.expiration_rules

object

Defines the loyalty point expiration rule. This expiration rule applies when there are no expiration_rules defined for an earning rule.

Show child attributes

campaign.voucher.loyalty_card.expiration_rules.period_type

enum<string>

required

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.

Available options:

FIXED_DAY_OF_YEAR,

MONTH

campaign.voucher.loyalty_card.expiration_rules.period_value

integer

Value of the period. Required for the period_type: MONTH.

campaign.voucher.loyalty_card.expiration_rules.rounding_type

enum<string>

Type of rounding of the expiration period. Optional for the period_type: MONTH.

Available options:

END_OF_MONTH,

END_OF_QUARTER,

END_OF_HALF_YEAR,

END_OF_YEAR,

PARTICULAR_MONTH

campaign.voucher.loyalty_card.expiration_rules.rounding_value

integer

Value of rounding of the expiration period. Required for the rounding_type.

campaign.voucher.loyalty_card.expiration_rules.fixed_month

integer

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.

Required range: 1 <= x <= 12

campaign.voucher.loyalty_card.expiration_rules.fixed_day

integer

Determines the day of the month when the points expire. Required for the period_type: FIXED_DAY_OF_YEAR.

Required range: 1 <= x <= 31

campaign.referral_program

Referral Program · object

Defines the referee reward and the way a referral is triggered. Context: REFERRAL_PROGRAM.

Show child attributes

campaign.referral_program.conversion_event_type

enum<string>

Defines how a referral is triggered.

Available options:

redemption,

custom_event

campaign.referral_program.custom_event

object

Contains details about the custom event.

Show child attributes

campaign.referral_program.custom_event.id

string

Unique custom event ID.

Example:

"ms_Ll9enAm2BCN0M1s4VxWobLFM"

campaign.referral_program.custom_event.name

string

Custom event name.

campaign.referral_program.referee_reward

object

Defines the referee reward.

Show child attributes

Details of the resource from which the reward originates.

Show child attributes

Unique identifier of the reward source.

Example:

"camp_kdxp3vf1clQ9CFs1jpqv3tZe"

Name of the reward source.

Type of resource represented by the source of the reward.

Available options:

CAMPAIGN

campaign.referral_program.referee_reward.type

enum<string>

Type of reward.

Available options:

DISCOUNT_VOUCHER,

LOYALTY_CARD,

GIFT_VOUCHER

campaign.referral_program.referee_reward.amount

string

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.

campaign.auto_join

boolean

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

campaign.join_once

boolean

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

campaign.active

boolean

Indicates whether the campaign is active.

campaign.category_id

string | null

The unique category ID that this campaign belongs to.

campaign.category

string

Unique category name.

campaign.categories

Category · object[]

Contains details about the category.

Show child attributes

campaign.categories.id

string

required

Unique category ID assigned by Voucherify.

campaign.categories.name

string

required

Category name.

campaign.categories.hierarchy

integer

required

Category hierarchy.

campaign.categories.created_at

string<date-time>

required

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

Example:

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

campaign.categories.object

enum<string>

default:category

required

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

Available options:

category

campaign.categories.updated_at

string<date-time>

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

Example:

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

campaign.categories.stacking_rules_type

enum<string>

The type of the stacking rule eligibility.

Available options:

JOINT,

EXCLUSIVE

campaign.metadata

object

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

campaign.start_date

string<date-time>

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

Example:

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

campaign.expiration_date

string<date-time>

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

Example:

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

campaign.description

string

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

campaign.created_at

string<date-time>

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

Example:

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

campaign.updated_at

string<date-time>

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

Example:

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

campaign.object

enum<string>

default:campaign

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

Available options:

campaign

voucher

Simple Voucher · object

Simplified voucher data.

Show child attributes

voucher.code

string

required

Voucher code.

voucher.type

enum<string>

required

Type of the voucher.

Available options:

DISCOUNT_VOUCHER,

LOYALTY_CARD,

GIFT_VOUCHER

voucher.created_at

string<date-time>

required

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

Example:

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

voucher.object

enum<string>

default:voucher

required

The type of the object represented by JSON.

Available options:

voucher

voucher.id

string

A unique identifier that represents the voucher assigned by Voucherify.

voucher.gift

Gift · object

Gift object response.

Show child attributes

voucher.gift.amount

number

required

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.

voucher.gift.balance

number

required

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

voucher.gift.effect

enum<string>

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

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS

voucher.discount

Discount · object

Contains information about discount.

Discount
Discount
Discount
Discount
Discount

Show child attributes

voucher.discount.type

enum<string>

default:AMOUNT

required

Defines the type of the voucher.

Available options:

AMOUNT

voucher.discount.amount_off

number

required

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.

voucher.discount.amount_off_formula

string

voucher.discount.aggregated_amount_limit

integer

Maximum discount amount per order.

voucher.discount.effect

enum<string>

Defines how the discount is applied to the customer's order.

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS,

APPLY_TO_ITEMS_PROPORTIONALLY,

APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY,

APPLY_TO_ITEMS_BY_QUANTITY

voucher.discount.is_dynamic

boolean

Flag indicating whether the discount was calculated using a formula.

voucher.loyalty_card

Simple Loyalty Card · object

Defines the loyalty card details. Simplified loyalty card data.

Show child attributes

voucher.loyalty_card.points

integer

required

Total number of points added to the loyalty card over its lifespan.

voucher.loyalty_card.balance

integer

Points available for reward redemption. This is calculated as follows: balance = points - expired_points - subtracted_points - redemption.redeemed_points.

voucher.loyalty_card.next_expiration_date

string

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

voucher.loyalty_card.next_expiration_points

integer

The amount of points that are set to expire next.

voucher.loyalty_card.pending_points

integer

Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.

voucher.loyalty_card.expired_points

integer

Shows the total number of expired points over the lifetime of the loyalty card.

voucher.loyalty_card.subtracted_points

integer

Shows the total number of subtracted points over the lifetime of the loyalty card.

voucher.campaign

string

Campaign name.

voucher.campaign_id

string

Campaign unique ID.

voucher.is_referral_code

boolean

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

voucher.holder_id

string

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

Example:

"cust_eWgXlBBiY6THFRJwX45Iakv4"

voucher.referrer_id

string

Unique identifier of the referrer assigned by Voucherify.

Example:

"cust_nM4jqPiaXUvQdVSA6vTRUnix"

voucher.category_id

string | null

Unique identifier of the category that this voucher belongs to.

Example:

"cat_0b6152ce12414820dc"

voucher.categories

Category · object[]

Contains details about the category.

Show child attributes

voucher.categories.id

string

required

Unique category ID assigned by Voucherify.

voucher.categories.name

string

required

Category name.

voucher.categories.hierarchy

integer

required

Category hierarchy.

voucher.categories.created_at

string<date-time>

required

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

Example:

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

voucher.categories.object

enum<string>

default:category

required

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

Available options:

category

voucher.categories.updated_at

string<date-time>

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

Example:

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

voucher.categories.stacking_rules_type

enum<string>

The type of the stacking rule eligibility.

Available options:

JOINT,

EXCLUSIVE

voucher.active

boolean

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

voucher.updated_at

string<date-time>

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

Example:

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

voucher.redemption

object

Defines the redemption limits on vouchers.

Show child attributes

voucher.redemption.quantity

integer | null

required

How many times a voucher can be redeemed. A null value means unlimited.

voucher.redemption.redeemed_quantity

integer

required

How many times a voucher has already been redeemed.

Example:

1

voucher.start_date

string<date-time>

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

Example:

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

voucher.expiration_date

string<date-time>

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

Example:

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

voucher.metadata

object

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

holder

Simple Customer · object

Details about the redeemable holder.

Show child attributes

holder.id

string

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

holder.name

string

Customer's first and last name.

holder.email

string

Customer's email address.

holder.source_id

string

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

holder.metadata

object

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

holder.object

enum<string>

The type of the object represented by JSON.

Available options:

customer

promotion_tier

Simple Promotion Tier · object

Simplified promotion tier data.

Show child attributes

promotion_tier.id

string

Unique promotion tier ID.

Example:

"promo_63fYCt81Aw0h7lzyRkrGZh9p"

promotion_tier.name

string

Name of the promotion tier.

promotion_tier.banner

string | null

Text to be displayed to your customers on your website.

promotion_tier.campaign

Simple Promotion Tier Campaign · object

Simplified promotion tier campaign data.

Show child attributes

promotion_tier.campaign.id

string

Unique identifier of the campaign.

promotion_tier.metadata

object

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.

promotion_stack

Simple Promotion Stack · object

Simplified promotion stack data.

Show child attributes

promotion_stack.id

string

Unique identifier of the promotion stack.

promotion_stack.name

string

Name of the promotion stack.

promotion_stack.category_id

string

Unique identifier of the category of the promotion stack.

promotion_stack.campaign

object

Represents simplified promotion stack campaign data.

Show child attributes

promotion_stack.campaign.id

string

Unique identifier of the campaign.

promotion_stack.tiers

object

Contains the tier configuration.

Show child attributes

promotion_stack.tiers.ids

string[]

required

Contains the list of tiers in a pre-defined sequence.

Minimum array length: 1

promotion_stack.tiers.hierarchy_mode

enum<string>

default:MANUAL

Available options:

MANUAL

redemption

Simple Redemption · object

Simplified redemption data.

Show child attributes

redemption.id

string

required

Unique redemption ID.

Example:

"r_0bc92f81a6801f9bca"

redemption.date

string<date-time>

required

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

Example:

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

redemption.status

enum<string> | null

required

Available options:

SUCCEEDED,

FAILED,

ROLLED BACK

redemption.metadata

object

required

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

redemption.object

string

default:redemption

required

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

redemption.customer_id

string | null

Unique customer ID of the redeeming customer.

Example:

"cust_i8t5Tt6eiKG5K79KQlJ0Vs64"

redemption.tracking_id

string

Hashed customer source ID.

redemption.amount

integer

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

Example:

10000

redemption.order

Simple Order · object

Order information.

Show child attributes

redemption.order.object

enum<string>

default:order

required

The type of the object represented by JSON.

Available options:

order

redemption.order.id

string

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

redemption.order.source_id

string

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

redemption.order.status

enum<string>

The order status.

Available options:

CREATED,

PAID,

CANCELED,

FULFILLED

redemption.order.customer_id

string | null

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

Example:

"cust_7iUa6ICKyU6gH40dBU25kQU1"

redemption.order.referrer_id

string | null

Unique identifier of the referrer assigned by Voucherify.

Example:

"cust_nM4jqPiaXUvQdVSA6vTRUnix"

redemption.order.amount

integer

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

redemption.order.discount_amount

integer

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

redemption.order.applied_discount_amount

integer

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

redemption.order.items_discount_amount

integer

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

redemption.order.items_applied_discount_amount

integer

redemption.order.total_discount_amount

integer

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

redemption.order.total_applied_discount_amount

integer

redemption.order.total_amount

integer

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

redemption.order.items

Simple Order Item · object[]

Array of items applied to the order. It can include up to 500 items.

Show child attributes

redemption.order.items.object

enum<string>

default:order_item

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

Available options:

order_item

redemption.order.items.source_id

string

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.

Available options:

product,

sku

redemption.order.items.product_id

string

A unique product ID assigned by Voucherify.

redemption.order.items.sku_id

string

A unique SKU ID assigned by Voucherify.

redemption.order.items.quantity

integer

The quantity of the particular item in the cart.

redemption.order.items.discount_quantity

integer

Number of dicounted items.

redemption.order.items.amount

integer

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

redemption.order.items.discount_amount

integer

The sum of all order-item-level discounts applied to the order.

redemption.order.items.applied_discount_amount

integer

The order-level discount applied.

redemption.order.items.price

integer

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.

redemption.order.items.subtotal_amount

integer

Final order amount after the applied discount.

redemption.order.metadata

object

redemption.reward

Simple Redemption Reward Result · object

Simplified redemption reward result data

Show child attributes

redemption.reward.customer

Simple Customer · object

Simplified customer data.

Show child attributes

redemption.reward.customer.id

string

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

redemption.reward.customer.name

string

Customer's first and last name.

redemption.reward.customer.email

string

Customer's email address.

redemption.reward.customer.source_id

string

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

redemption.reward.customer.metadata

object

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

redemption.reward.customer.object

enum<string>

The type of the object represented by JSON.

Available options:

customer

redemption.reward.assignment_id

string

Unique reward assignment ID assigned by Voucherify.

redemption.reward.voucher

Simple Voucher · object

Defines the voucher reward.

Show child attributes

redemption.reward.voucher.code

string

required

Voucher code.

redemption.reward.voucher.type

enum<string>

required

Type of the voucher.

Available options:

DISCOUNT_VOUCHER,

LOYALTY_CARD,

GIFT_VOUCHER

redemption.reward.voucher.created_at

string<date-time>

required

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

Example:

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

redemption.reward.voucher.object

enum<string>

default:voucher

required

The type of the object represented by JSON.

Available options:

voucher

redemption.reward.voucher.id

string

A unique identifier that represents the voucher assigned by Voucherify.

redemption.reward.voucher.gift

Gift · object

Gift object response.

Show child attributes

redemption.reward.voucher.gift.amount

number

required

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.

redemption.reward.voucher.gift.balance

number

required

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

redemption.reward.voucher.gift.effect

enum<string>

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

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS

redemption.reward.voucher.discount

Discount · object

Contains information about discount.

Discount
Discount
Discount
Discount
Discount

Show child attributes

redemption.reward.voucher.discount.type

enum<string>

default:AMOUNT

required

Defines the type of the voucher.

Available options:

AMOUNT

redemption.reward.voucher.discount.amount_off

number

required

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.

redemption.reward.voucher.discount.amount_off_formula

string

redemption.reward.voucher.discount.aggregated_amount_limit

integer

Maximum discount amount per order.

redemption.reward.voucher.discount.effect

enum<string>

Defines how the discount is applied to the customer's order.

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS,

APPLY_TO_ITEMS_PROPORTIONALLY,

APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY,

APPLY_TO_ITEMS_BY_QUANTITY

redemption.reward.voucher.discount.is_dynamic

boolean

Flag indicating whether the discount was calculated using a formula.

redemption.reward.voucher.loyalty_card

Simple Loyalty Card · object

Defines the loyalty card details. Simplified loyalty card data.

Show child attributes

redemption.reward.voucher.loyalty_card.points

integer

required

Total number of points added to the loyalty card over its lifespan.

redemption.reward.voucher.loyalty_card.balance

integer

Points available for reward redemption. This is calculated as follows: balance = points - expired_points - subtracted_points - redemption.redeemed_points.

redemption.reward.voucher.loyalty_card.next_expiration_date

string

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

redemption.reward.voucher.loyalty_card.next_expiration_points

integer

The amount of points that are set to expire next.

redemption.reward.voucher.loyalty_card.pending_points

integer

Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.

redemption.reward.voucher.loyalty_card.expired_points

integer

Shows the total number of expired points over the lifetime of the loyalty card.

redemption.reward.voucher.loyalty_card.subtracted_points

integer

Shows the total number of subtracted points over the lifetime of the loyalty card.

redemption.reward.voucher.campaign

string

Campaign name.

redemption.reward.voucher.campaign_id

string

Campaign unique ID.

redemption.reward.voucher.is_referral_code

boolean

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

redemption.reward.voucher.holder_id

string

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

Example:

"cust_eWgXlBBiY6THFRJwX45Iakv4"

redemption.reward.voucher.referrer_id

string

Unique identifier of the referrer assigned by Voucherify.

Example:

"cust_nM4jqPiaXUvQdVSA6vTRUnix"

redemption.reward.voucher.category_id

string | null

Unique identifier of the category that this voucher belongs to.

Example:

"cat_0b6152ce12414820dc"

redemption.reward.voucher.categories

Category · object[]

Contains details about the category.

Show child attributes

redemption.reward.voucher.categories.id

string

required

Unique category ID assigned by Voucherify.

redemption.reward.voucher.categories.name

string

required

Category name.

redemption.reward.voucher.categories.hierarchy

integer

required

Category hierarchy.

redemption.reward.voucher.categories.created_at

string<date-time>

required

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

Example:

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

redemption.reward.voucher.categories.object

enum<string>

default:category

required

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

Available options:

category

redemption.reward.voucher.categories.updated_at

string<date-time>

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

Example:

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

redemption.reward.voucher.categories.stacking_rules_type

enum<string>

The type of the stacking rule eligibility.

Available options:

JOINT,

EXCLUSIVE

redemption.reward.voucher.active

boolean

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

redemption.reward.voucher.updated_at

string<date-time>

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

Example:

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

redemption.reward.voucher.redemption

object

Defines the redemption limits on vouchers.

Show child attributes

redemption.reward.voucher.redemption.quantity

integer | null

required

How many times a voucher can be redeemed. A null value means unlimited.

redemption.reward.voucher.redemption.redeemed_quantity

integer

required

How many times a voucher has already been redeemed.

Example:

1

redemption.reward.voucher.start_date

string<date-time>

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

Example:

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

redemption.reward.voucher.expiration_date

string<date-time>

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

Example:

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

redemption.reward.voucher.metadata

object

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

redemption.reward.product

Simple Product · object

Defines the product reward.

Show child attributes

redemption.reward.product.id

string

Unique product ID.

redemption.reward.product.source_id

string

Product source ID.

redemption.reward.product.name

string

Product name.

redemption.reward.sku

Simple SKU · object

Defines the SKU reward.

Show child attributes

redemption.reward.sku.id

string

Unique SKU ID.

redemption.reward.sku.source_id

string

SKU source id.

redemption.reward.sku.sku

string

SKU name.

redemption.reward.loyalty_tier_id

string

Unique loyalty tier ID assigned by Voucherify.

redemption.reward.id

string

Unique reward ID, assigned by Voucherify.

Example:

"rew_nIy4gHpQHle2c3pNMwuj7G6j"

redemption.reward.object

enum<string>

default:reward

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

Available options:

reward

redemption.reward.name

string

Reward name.

redemption.reward.created_at

string<date-time>

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

Example:

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

redemption.reward.updated_at

string<date-time> | null

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

Example:

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

redemption.reward.parameters

Campaign · object

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

redemption.reward.parameters.campaign

Discount Coupons · object

Objects stores information about the campaign related to the reward.

Discount Coupons
Gift Vouchers
Points on loyalty card

Show child attributes

redemption.reward.parameters.campaign.id

string

required

Unique identifier of the campaign assigned by Voucherify.

Example:

"camp_13BbZ0kQsNinhqsX3wUts2UP"

redemption.reward.parameters.campaign.type

enum<string>

default:DISCOUNT_COUPONS

required

Campaign type.

Available options:

DISCOUNT_COUPONS

redemption.reward.metadata

object

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

redemption.reward.type

enum<string>

Reward type.

Available options:

CAMPAIGN,

COIN,

MATERIAL

redemption.customer

Simple Customer · object

Simplified customer data.

Show child attributes

redemption.customer.id

string

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

redemption.customer.name

string

Customer's first and last name.

redemption.customer.email

string

Customer's email address.

redemption.customer.source_id

string

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

redemption.customer.metadata

object

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

redemption.customer.object

enum<string>

The type of the object represented by JSON.

Available options:

customer

redemption.result

enum<string>

Redemption result.

Available options:

SUCCESS,

FAILURE

redemption.voucher

Simple Voucher · object

Defines the details of the voucher being redeemed.

Show child attributes

redemption.voucher.code

string

required

Voucher code.

redemption.voucher.type

enum<string>

required

Type of the voucher.

Available options:

DISCOUNT_VOUCHER,

LOYALTY_CARD,

GIFT_VOUCHER

redemption.voucher.created_at

string<date-time>

required

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

Example:

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

redemption.voucher.object

enum<string>

default:voucher

required

The type of the object represented by JSON.

Available options:

voucher

redemption.voucher.id

string

A unique identifier that represents the voucher assigned by Voucherify.

redemption.voucher.gift

Gift · object

Gift object response.

Show child attributes

redemption.voucher.gift.amount

number

required

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.

redemption.voucher.gift.balance

number

required

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

redemption.voucher.gift.effect

enum<string>

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

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS

redemption.voucher.discount

Discount · object

Contains information about discount.

Discount
Discount
Discount
Discount
Discount

Show child attributes

redemption.voucher.discount.type

enum<string>

default:AMOUNT

required

Defines the type of the voucher.

Available options:

AMOUNT

redemption.voucher.discount.amount_off

number

required

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.

redemption.voucher.discount.amount_off_formula

string

redemption.voucher.discount.aggregated_amount_limit

integer

Maximum discount amount per order.

redemption.voucher.discount.effect

enum<string>

Defines how the discount is applied to the customer's order.

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS,

APPLY_TO_ITEMS_PROPORTIONALLY,

APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY,

APPLY_TO_ITEMS_BY_QUANTITY

redemption.voucher.discount.is_dynamic

boolean

Flag indicating whether the discount was calculated using a formula.

redemption.voucher.loyalty_card

Simple Loyalty Card · object

Defines the loyalty card details. Simplified loyalty card data.

Show child attributes

redemption.voucher.loyalty_card.points

integer

required

Total number of points added to the loyalty card over its lifespan.

redemption.voucher.loyalty_card.balance

integer

Points available for reward redemption. This is calculated as follows: balance = points - expired_points - subtracted_points - redemption.redeemed_points.

redemption.voucher.loyalty_card.next_expiration_date

string

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

redemption.voucher.loyalty_card.next_expiration_points

integer

The amount of points that are set to expire next.

redemption.voucher.loyalty_card.pending_points

integer

Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.

redemption.voucher.loyalty_card.expired_points

integer

Shows the total number of expired points over the lifetime of the loyalty card.

redemption.voucher.loyalty_card.subtracted_points

integer

Shows the total number of subtracted points over the lifetime of the loyalty card.

redemption.voucher.campaign

string

Campaign name.

redemption.voucher.campaign_id

string

Campaign unique ID.

redemption.voucher.is_referral_code

boolean

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

redemption.voucher.holder_id

string

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

Example:

"cust_eWgXlBBiY6THFRJwX45Iakv4"

redemption.voucher.referrer_id

string

Unique identifier of the referrer assigned by Voucherify.

Example:

"cust_nM4jqPiaXUvQdVSA6vTRUnix"

redemption.voucher.category_id

string | null

Unique identifier of the category that this voucher belongs to.

Example:

"cat_0b6152ce12414820dc"

redemption.voucher.categories

Category · object[]

Contains details about the category.

Show child attributes

redemption.voucher.categories.id

string

required

Unique category ID assigned by Voucherify.

redemption.voucher.categories.name

string

required

Category name.

redemption.voucher.categories.hierarchy

integer

required

Category hierarchy.

redemption.voucher.categories.created_at

string<date-time>

required

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

Example:

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

redemption.voucher.categories.object

enum<string>

default:category

required

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

Available options:

category

redemption.voucher.categories.updated_at

string<date-time>

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

Example:

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

redemption.voucher.categories.stacking_rules_type

enum<string>

The type of the stacking rule eligibility.

Available options:

JOINT,

EXCLUSIVE

redemption.voucher.active

boolean

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

redemption.voucher.updated_at

string<date-time>

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

Example:

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

redemption.voucher.redemption

object

Defines the redemption limits on vouchers.

Show child attributes

redemption.voucher.redemption.quantity

integer | null

required

How many times a voucher can be redeemed. A null value means unlimited.

redemption.voucher.redemption.redeemed_quantity

integer

required

How many times a voucher has already been redeemed.

Example:

1

redemption.voucher.start_date

string<date-time>

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

Example:

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

redemption.voucher.expiration_date

string<date-time>

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

Example:

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

redemption.voucher.metadata

object

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

redemption.promotion_tier

Simple Promotion Tier · object

Simplified promotion tier data.

Show child attributes

redemption.promotion_tier.id

string

Unique promotion tier ID.

Example:

"promo_63fYCt81Aw0h7lzyRkrGZh9p"

redemption.promotion_tier.name

string

Name of the promotion tier.

redemption.promotion_tier.banner

string | null

Text to be displayed to your customers on your website.

redemption.promotion_tier.campaign

Simple Promotion Tier Campaign · object

Simplified promotion tier campaign data.

Show child attributes

redemption.promotion_tier.campaign.id

string

Unique identifier of the campaign.

redemption.promotion_tier.metadata

object

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.

redemption.redemption

string

Unique redemption ID of the parent redemption.

Example:

"r_0c656311b5878a2031"

redemption.failure_code

string

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

Example:

"customer_rules_violated"

redemption.failure_message

string

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

redemption.reason

string

The reason for the redemption rollback.

redemption.channel

object

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

Show child attributes

redemption.channel.channel_id

string

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

redemption.channel.channel_type

enum<string>

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.

Available options:

API,

AUTO_REDEEM,

USER

created_at

string<date-time>

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

Example:

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

Response

Webhook accepted

Introduction

Endpoints

Events

Body

Response