Validation Object

Unique identifier of the validation, assigned by Voucherify.

valid_101740aa2869354c6d

The result of the validation. It takes all of the redeemables into account and returns a false if at least one redeemable is inapplicable. Returns true if all redeemables are applicable.

Lists validation results of each redeemable. If redeemables_application_mode="PARTIAL" all redeemables here will be "APPLICABLE"

Lists validation results of each skipped redeemable.

Lists validation results of each inapplicable redeemable.

Hashed customer source ID.

track_VAVo1/z+G2GI2LPw==

Indicates whether the redeemable can be applied or not applied based on the validation rules.

Redeemable ID, i.e. the voucher code.

Redeemable's object type.

Specifies the redeemable's end effect on the order. This object is unique to each type of redeemable.

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

Campaign name. Displayed only if the options.expand is passed with a redeemable value in the validation request body.

Unique campaign ID assigned by Voucherify. Displayed only if the options.expand is passed with a redeemable value in the validation request body.

camp_pqZjuhG6Mgtp4GD0zD7b8hA3

Name of the promotion tier. Displayed only if the options.expand is passed with a redeemable value in the validation request body.

Indicates whether the redeemable can be applied or not applied based on the validation rules.

Redeemable ID, i.e. the voucher code.

Redeemable's object type.

Includes the error object with details about the reason why the redeemable is inapplicable

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

Campaign name. Displayed only if the options.expand is passed with a redeemable value in the validation request body.

Unique campaign ID assigned by Voucherify. Displayed only if the options.expand is passed with a redeemable value in the validation request body.

camp_pqZjuhG6Mgtp4GD0zD7b8hA3

Name of the promotion tier. Displayed only if the options.expand is passed with a redeemable value in the validation request body.

Indicates whether the redeemable can be applied or not applied based on the validation rules.

Redeemable ID, i.e. the voucher code.

Redeemable's object type.

Provides details about the reason why the redeemable is skipped.

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

Campaign name. Displayed only if the options.expand is passed with a redeemable value in the validation request body.

Unique campaign ID assigned by Voucherify. Displayed only if the options.expand is passed with a redeemable value in the validation request body.

camp_pqZjuhG6Mgtp4GD0zD7b8hA3

Name of the promotion tier. Displayed only if the options.expand is passed with a redeemable value in the validation request body.

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

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.

Defines how many redeemables can be sent in one request. Note: more redeemables means more processing time.

Defines how many redeemables can be applied in one request. The number must be less than or equal to redeemables_limit. For example, a user can select 30 discounts but only 5 will be applied to the order and the remaining will be SKIPPED according to the redeemables_sorting_rule.

Defines how many redeemables with the same category can be applied in one request. The number must be less than or equal to applicable_redeemables_limit. The ones above the limit will be SKIPPED according to the redeemables_sorting_rule.

Lists categories by category IDs (keys) and defines their limits (values) of applicable redeemables that belong to campaigns with that category.

Defines how many redeemables with an assigned exclusive category can be applied in one request. The ones above the limit will be SKIPPED according to the redeemables_sorting_rule.

Defines how many redeemables with an exclusive category per category in stacking rules can be applied in one request. The ones above the limit will be SKIPPED according to the redeemables_sorting_rule.

Lists the IDs of exclusive categories. A redeemable from a campaign with an exclusive category is the only redeemable to be redeemed when applied with redeemables from other campaigns unless these campaigns are exclusive or joint.

Lists the IDs of the joint categories. A campaign with a joint category is always applied regardless of the exclusivity of other campaigns.

Defines the application mode for redeemables.
"ALL" means that all redeemables must be validated for the redemption to be successful.
"PARTIAL" means that only those redeemables that can be validated will be redeemed. The redeemables that fail validaton will be skipped.

Defines redeemables sorting rule. CATEGORY_HIERARCHY means that redeemables are applied oaccording to the category priority. REQUESTED_ORDER means that redeemables are applied in the sequence provided in the request.

Defines redeemables products application mode. STACK means that multiple discounts can be applied to a product. ONCE means that only one discount can be applied to the same product.

Defines redeemables no effect rule. REDEEM_ANYWAY means that the redeemable will be redeemed regardless of any restrictions or conditions in place. SKIP means that the redeemable will be processed only when an applicable effect is calculated.

Lists category IDs. Redeemables with a given category are skipped even if the redeemables_no_effect_rule is set to REDEEM_ANYWAY. Category IDs can't overlap with the IDs in no_effect_redeem_anyway_categories.

Lists category IDs. Redeemables with a given category are redeemed anyway even if the redeemables_no_effect_rule is set to SKIP. Category IDs can't overlap with the IDs in no_effect_skip_categories.

Defines the rollback mode for the order. WITH_ORDER is a default setting. The redemption is rolled back together with the data about the order, including related discount values. WITHOUT_ORDER allows rolling the redemption back without affecting order data, including the applied discount values.

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.

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.

Discount details about the type of discount to be applied for the redeemable.

Stores the amount of gift card credits to be applied.

Stores the amount of loyalty card points to be applied in the redemption.

Discount details about the type of discount to be applied for the redeemable.

Discount details about the type of discount to be applied for the redeemable.

Error's HTTP status code.

Short string describing the kind of error which occurred.

A human-readable message providing a short description of the error.

A human-readable message providing more details about the error.

This ID is useful when troubleshooting and/or finding the root cause of an error response by our support team.

v-0a885062c80375740f

Unique resource ID that can be used in another endpoint to get more details.

rf_0c5d710a87c8a31f86

The resource type.

voucher

Includes additional information about the error.

Determines how many bundles are qualified. If there are missing bundle products, the value is 0. If the bundle is qualified, the value is 1. The maximum number of identified bundles can equal the number set in limit. Also defines the multiplier of the discount for AMOUNT, PERCENT, and UNIT discount types. To inform end-customers that more products can be added to meet additional bundles, compare this parameter with limit.

Determines the maximum number of identified bundles. This also defines the maximum multiplier of the bundle discount.

Determines products from the customer's order items that meet bundle conditions. SKUs meet the conditions for their product that is used in the bundle. Returns only the products and their quantity that meet the bundle.

Determines products, SKUs, or collections from the bundle that are missing in the customer's order items. Determines also the missing quantity. For collections, this means that order items do not include a sufficient number of items that belong to the collection. Not returned when all required bundle items are in the order.

Applicable redeemables limit exceeded

Applicable redeemables limit per category exceeded

Applicable exclusive redeemables limit exceeded

Applicable exclusive redeemables limit per category exceeded

Redeemable cannot be applied due to exclusion rules

Redeemable cannot be applied due to preceding validation failure

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.

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

Formula used to dynamically calculate the discount.

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

Formula used to dynamically calculate the discount.

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.

Formula used to dynamically calculate the discount.

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

Flag indicating whether the discount was calculated using a formula.

Unique category ID assigned by Voucherify.

Category name.

Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.

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

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

2022-07-14T10:45:13.156Z

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

2022-08-16T10:52:08.094Z

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