Validation Object

Indicates whether the voucher is valid within the context of the parameters provided in the request body.

Voucher code.

Contains list of items that qualify in the scope of the discount. These are definitions of included products, SKUs, and product collections. These can be discounted.

Contains list of items that do not qualify in the scope of the discount. These are definitions of excluded products, SKUs, and product collections. These CANNOT be discounted.

Voucher's parent campaign name.

Voucher's parent campaign's unique ID.

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.

Gift object response

Contains the cost of reward in points.

Contains information about the reward that is being validated.

Schema model for session lock object. The session object contains information about the session key that was used to establish a session between multiple parallel validation and redemption requests.

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

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

Hashed order source ID.

Indicates whether the voucher is valid within the context of the parameters provided in the request body.

Voucher code.

Detailed failure cause for the invalid voucher if the reason has a translation defined in the Dashboard → Project Settings → Error Messages.

Hashed customer source ID.

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

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.

Contains array of items to which the discount can apply.

Total number of objects defining included products, SKUs, or product collections.

The type of the object represented by JSON.

The type of the object represented by JSON.

Contains array of items to which the discount cannot apply.

Total number of objects defining included products, SKUs, or product collections.

The type of the object represented by JSON.

The type of the object represented by JSON.

Total gift card income over the lifetime of the card. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

Total amount of subtracted credits over the gift card lifetime.

Available funds. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00. balance = amount - subtracted_amount - redemption.redeemed_amount.

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

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

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

The order status.

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

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

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

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

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

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

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

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

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

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

The type of the object represented by JSON.

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

2021-12-22T10:13:06.487Z

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

2021-12-22T10:14:45.316Z

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

cust_7iUa6ICKyU6gH40dBU25kQU1

Unique referrer ID.

cust_nM4jqPiaXUvQdVSA6vTRUnix

Unique identifier of the order line item.

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

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

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

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

The quantity of the particular item in the cart.

Number of dicounted items.

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

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

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

This field shows the order-level discount applied.

Number of the discounted items applied in the transaction.

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

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

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

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

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

An object containing details of the related product.

An object containing details of the related SKU.

The type of the object represented by JSON.

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

The session unique ID assigned by Voucherify or your own unique session ID. Sending an existing ID will result in overwriting an existing session. If no session key is provided, then a new ID will be generated.

This parameter is required to establish a new session.

Value for the period of time that the session is active. Units for this parameter are defined by the session.ttl_unit parameter.

Defines the type of unit in which the session time is counted.

This object stores information about the resource to which the discount is applicable.

Unique product collection, product, or SKU identifier assigned by Voucherify.

The source identifier from your inventory system.

Parent product's unique ID assigned by Voucherify.

Parent product's source ID from your inventory system.

New fixed price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 price is written as 1000. In case of the fixed price being calculated by the formula, i.e. the price_formula parameter is present in the fixed price definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed price.

Formula used to calculate the discounted price of an item.

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

The maximum number of units allowed to be discounted per order line item.

The maximum number of units allowed to be discounted combined across all matched order line items.

Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600.

Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects:

• APPLY_TO_ITEMS (each item subtotal is discounted equally)
• APPLY_TO_ITEMS_BY_QUANTITY (each unit of matched products has the same discount value)

Lists which order lines are (not) covered by the discount. The order in the array is determined by the sequence of applied discounts, while the numbers correspond to the order lines sent in the order object in the request. The first order line is assigned 0, the second order line is assigned 1, and so on.

Lists which units within order lines are covered by the discount. The order line items are listed according to sequence of applied discounts while the index corresponds to the order line sent in the order object in the request.

Determines the recurrence of the discount, e.g. "repeat": 3 means that the discount is applied to every third item.

Determines how many items are skipped before the discount is applied.

Determines to which kinds of objects the discount is applicable. ITEM includes products and SKUs. UNIT means particular units within an order line.

Defines the type of the voucher.

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.

Flag indicating whether the discount was calculated using a formula.

Discount type.

Number of units to be granted a full value discount.

Formula used to calculate the number of units.

Defines how the unit is added to the customer's order.

The product deemed as free, chosen from product inventory (e.g. time, items).

Contains information about the product.

Flag indicating whether the discount was calculated using a formula.

Discount type.

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

Defines the type of the voucher.

The percent discount that the customer will receive.

Upper limit allowed to be applied as a discount. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600.

Maximum discount amount per order.

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

Flag indicating whether the discount was calculated using a formula.

Defines the type of the voucher.

Sets a fixed value for an order total or the item price. The value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. If the fixed amount is calculated by the formula, i.e. the fixed_amount_formula parameter is present in the fixed amount definition, this value becomes the fallback value. As a result, if the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed value.

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

Flag indicating whether the discount was calculated using a formula.

A unique identifier of an existing customer.

The type of the object represented by JSON.

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

2022-09-02T17:06:56.649Z

Unique ID of the redemption rollback.

rr_0c63c84eb78ee0a6c0

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

2023-01-31T14:18:37.150Z

The source of the incentive.

Unique ID of the parent redemption.

r_0ba186c4824e4881e1

Represent's the campaign ID of the voucher if the redemption was based on a voucher that was part of bulk codes generated within a campaign. In case of a promotion tier, this represents the campaign ID of the promotion tier's parent campaign.

Contains a list of unique IDs of child redemptions, which belong to the stacked incentives.

Lists the rollback redemption IDs of the particular child redemptions.

Unique product ID, assigned by Voucherify.

Product's source ID.

Product name.

Unique SKU ID, assigned by Voucherify.

Product variant's source ID.

Sku name

Number of units to be granted a full value discount.

Formula used to calculate the number of units.

Defines how the unit is added to the customer's order.

The product deemed as free, chosen from product inventory (e.g. time, items).

Contains information about the product.

Contains information about the sku.