name
string

Custom, unique name for set of validation rules.

Example: Business Validation Rule

rules

bundle_rules

error
object

Contains the error message returned from API when validation / redemption fails to meet requirements of defined rules.

applicable_to
object

type
string

Type of validation rule.

Available values: expression, basic, advanced, complex

context_type
string

Validation rule context type.

Available values: earning_rule.order.paid, earning_rule.custom_event, earning_rule.customer.segment.entered, earning_rule.customer.tier.joined, earning_rule.customer.tier.left, earning_rule.customer.tier.upgraded, earning_rule.customer.tier.downgraded, earning_rule.customer.tier.prolonged, campaign.discount_coupons, campaign.discount_coupons.discount.apply_to_order, campaign.discount_coupons.discount.apply_to_items, campaign.discount_coupons.discount.apply_to_items_proportionally, campaign.discount_coupons.discount.apply_to_items_proportionally_by_quantity, campaign.discount_coupons.discount.apply_to_items_by_quantity, campaign.discount_coupons.discount.fixed.apply_to_items, campaign.discount_coupons.discount.percent.apply_to_items, campaign.gift_vouchers, campaign.gift_vouchers.gift.apply_to_order, campaign.gift_vouchers.gift.apply_to_items, campaign.referral_program, campaign.referral_program.discount.apply_to_order, campaign.referral_program.discount.apply_to_items, campaign.referral_program.discount.apply_to_items_proportionally, campaign.referral_program.discount.apply_to_items_proportionally_by_quantity, campaign.referral_program.discount.apply_to_items_by_quantity, campaign.referral_program.discount.fixed.apply_to_items, campaign.referral_program.discount.percent.apply_to_items, campaign.promotion, campaign.promotion.discount.apply_to_order, campaign.promotion.discount.apply_to_items, campaign.promotion.discount.apply_to_items_proportionally, campaign.promotion.discount.apply_to_items_proportionally_by_quantity, campaign.promotion.discount.apply_to_items_by_quantity, campaign.promotion.discount.fixed.apply_to_items, campaign.promotion.discount.percent.apply_to_items, campaign.loyalty_program, voucher.discount_voucher, voucher.discount_voucher.discount.apply_to_order, voucher.discount_voucher.discount.apply_to_items, voucher.discount_voucher.discount.apply_to_items_proportionally, voucher.discount_voucher.discount.apply_to_items_proportionally_by_quantity, voucher.discount_voucher.discount.apply_to_items_by_quantity, voucher.discount_voucher.discount.fixed.apply_to_items, voucher.discount_voucher.discount.percent.apply_to_items, voucher.gift_voucher, voucher.gift_voucher.gift.apply_to_order, voucher.gift_voucher.gift.apply_to_items, voucher.loyalty_card, distribution.custom_event, distribution.order.paid, distribution.order.created, distribution.order.canceled, distribution.order.updated, reward_assignment.pay_with_points, global

logic
string

Defines the logic between the rules.

Example: (1 and 2) and (3)

[propertyName]
object

Contains the name of the validation rule.

limit
integer, null

Defines how many bundles can be identified in the order and the maximum multiplier of the discount per identified bundle. For example, if the order meets 3 bundles, but limit: 2, the discount will be multiplied by 2.

[propertyName]
object

Contains the name of the bundle rule.

object
string

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

Available values: product, sku, products_collection

id
string

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

source_id
string

The source identifier from your inventory system.

product_id
string

Parent product’s unique ID assigned by Voucherify.

product_source_id
string

Parent product’s source ID from your inventory system.

price
number

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.

price_formula
number

Formula used to dynamically calculate the discounted price of an item.

effect

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

quantity_limit
integer

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

aggregated_quantity_limit
integer

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

amount_limit
integer

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.

aggregated_amount_limit
integer

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)

order_item_indices
array

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.

order_item_units
array

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.

repeat
integer

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

skip_initially
integer

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

target
string

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

Available values: ITEM, UNIT

$is

$is_not

$in

$not_in

$less_than

$less_than_or_equal

$more_than

$more_than_or_equal

$starts_with

$ends_with

$contains

$timeframe

$timeframe_absolute

$timeframe_daily_hours

$dow
array

$count

$count_more

$count_less

$not_differ

$not_intersect

$from

$after

$before

$more_than_ago

$less_than_ago

$is_days_ago

$more_than_future

$less_than_future

$is_days_in_future

logic
string

Defines the logic between the rules.

Example: (1 and 2) and (3)

[propertyName]
object

Contains the name of the validation rule.

logic
string

Defines the logic between the rules.

Example: (1 and 2) and (3)

[propertyName]
object

Contains the name of the validation rule.

logic
string

Defines the logic between the rules.

Example: (1 and 2) and (3)

[propertyName]
object

Contains the name of the validation rule.