Examine Voucher Qualification

Case	Order-Level Parameter Included	Item-Level Parameter Included	Precedence	Calculation Result	Parameter included in payload accounts for checks against requirements in these validation rules
1	`amount`	`amount`	Order-level	Uses order-level `amount`	- Total order amount
2		`amount`	Item-level	Sums each item-level `amount`	- Total order amount - subtotal of matched items
3		`price` `quantity`	Item-level	Multiplies each item’s (`price` x `quantity`) to get item `amount` and then adds each item’s `amount` to get total order `amount`	- Total order amount - Subtotal of matched items - Unit price of any matching order line - Price of each item/Price of any item
4		`amount` `price` `quantity`	Item-level `amount`	Uses item-level `amount` for total order `amount` calculation, ignores (`price` x `quantity`) calculation	- Total order amount (uses item `amount` if provided or `price` x `quantity` for items without `amount` property; `amount` takes precedence in case all 3 properties are provided for an item) - Subtotal of matched items (uses item `amount`, takes precedence if all 3 properties are provided) - Unit price of any matching order line - Price of each item/Price of any item
5	`amount`	`amount` `price` `quantity`	Order-level	Uses order-level `amount` for total order `amount`	- Total order amount (uses order-level `amount`). - Subtotal of matched items (see case 4 for details). - Unit price of any matching order line - Price of each item/Price of any item

Authorizations

X-App-Id

string

header

required

X-App-Token

string

header

required

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

audienceRulesOnly

boolean

This parameter set to true will ask only for verifying vouchers' validation rules only against conditions applied to audiences' attributes (belonging into segment, customer metadata, customer redemption count). The remaining checks against limits and rules will be omitted during validation.

limit

integer

The number of vouchers to be qualified.

Required range: 1 <= x <= 50

order

enum<string>

Sorts the results using one of the filtering options, where the dash - means sorting in a descending order.

Available options:

created_at,

-created_at,

updated_at,

-updated_at,

code,

-code

Body

application/json

Should contain given customer and context such as an order.

Request body schema for /vouchers/qualification.

customer

Customer Object · object

This object stores customer details. You can send this object in the request body to check against vouchers requiring specific customer validation rules to be satisfied. The qualification runs against rules that are defined through the Create Validation Rules endpoint or via the Dashboard; in the Advanced Rule Builder → Audience → Customer segment or Basic Builder → Customer Activity. Read more.

Show child attributes

customer.id

string

The ID of an existing customer that will be linked to the redemption in this request. This ID was assigned by the Voucherify API.

Example:

"cust_J1CDUdbqn5Exva8ASWk1Fq0j"

customer.source_id

string

A unique customer identifier. This is a tracking identifier of a user that is validating a voucher. The source_id is built based on your internal id (e.g., email, database ID). If you also pass a customer ID, the source ID will be ignored. Otherwise, if you do not pass a customer ID, the source ID you provide must either be a token, like the one returned in the original voucher validation method done by a specific customer, or a string identifying the customer (e.g., email, database ID, CRM ID).

Example:

"firstname.lastname@mycompany.com"

customer.name

string

First and Last Name. You can send the name in the request body to check against vouchers requiring specific name validation rules to be satisfied.

Example:

"FirstName LastName"

customer.email

string

You can send the email in the request body to check against vouchers requiring specific email validation rules to be satisfied.

Example:

"firstname.lastname@mycompany.com"

customer.phone

string

You can send the phone in the request body to check against vouchers requiring specific phone validation rules to be satisfied.

Required string length: 1 - 30

customer.address

object

A set of key/value pairs which describes the address. You can send the address in the request body to check against vouchers requiring specific address validation rules to be satisfied.

Show child attributes

customer.address.city

string

You can send the city in the request body to check against vouchers requiring specific city validation rules to be satisfied.

Example:

"New York"

customer.address.country

string

You can send the country in the request body to check against vouchers requiring specific country validation rules to be satisfied.

Example:

"United States of America"

customer.address.postal_code

string

You can send the postal code in the request body to check against vouchers requiring specific postal code validation rules to be satisfied.

Example:

"10001"

customer.address.state

string

You can send the state in the request body to check against vouchers requiring specific state validation rules to be satisfied.

Example:

"NY"

customer.metadata

object

A set of key/value pairs that you can send in the request body to check against vouchers requiring customer metadata validation rules to be satisfied. The qualification runs against rules that are defined through the Create Validation Rules endpoint or via the Dashboard; in the Advanced Rule Builder → Audience → Customer metadata satisfy. Read more.

customer.birthdate

string<date>

You can send the birthdate in the request body to check against vouchers requiring specific birthdate validation rules to be satisfied.

Example:

"2022-01-01"

order

object

Tracks purchase transactions. You can send the order in the request body to check against vouchers requiring specific order validation rules to be satisfied. The qualification runs against rules that are defined through the Create Validation Rules endpoint or via the Dashboard; in the Advanced Rule Builder → Order structure/Order volume or Basic Builder → Order. Read more.

Show child attributes

order.id

string

The ID of an existing order in Voucherify's system that will be linked to the redemption of this request. This ID was assigned by the Voucherify API. You can send the order id in the request body to check against vouchers requiring specific order validation rules to be satisfied.

Example:

"ord_gqj1QYW2j2A1E3Ula2YjdPf4"

order.source_id

string

The merchant's order ID if it is different from the Voucherify order ID. It is really useful in case of an integration between multiple systems. It can be an order ID from a CRM system, database or 3rd-party service.

order.amount

integer

Pre-discount order amount represents the total amount of order items' amounts (sum of each item's amount property). You can send the total order amount or the amount of each item individually in the request body to check against vouchers requiring specific total order amount validation rules to be satisfied. The qualification runs against rules that are defined through the Create Validation Rules endpoint or via the Dashboard; in the Advanced Rule Builder → Order volume → Total amount

The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

Required range: x >= 0

Example:

10000

order.items

(Product Item · object | SKU Item · object | Product Item using product_id · object | Product Item using source_id · object)[]

List of Order Items constituting the order. Order items can be defined either by product_id or sku_id. For every item, you must define the quantity.

Schema model for a product item. You can send this object in the request body to check against vouchers requiring specific product validation rules to be satisfied. The qualification runs against rules that are defined through the Create Validation Rules endpoint or via the Dashboard; in the Advanced Rule Builder → Order structure/Order volume or Basic Builder → Order. Read more.

Product Item
SKU Item
Product Item using product_id
Product Item using source_id

Show child attributes

order.items.source_id

string

A unique product identifier from your inventory system. Requires the related_object property to be defined.

The qualification runs against rules that are defined through the Create Validation Rules endpoint or via the Dashboard; in the Advanced Rule Builder → Order Structure → Every order item/Any order item/None of the order items → Select a product collection or create a new product collection based on Source Id filters . Read more.

Example:

"product_1234"

order.items.product_id

string

A unique identifier that represents the product and is assigned by Voucherify.

Example:

"prod_0a9f9aeddb019a42db"

order.items.amount

integer

Represents a total pre-discount amount of order item (price * quantity). You can send the total item amount to check against vouchers requiring specific order amount validation rules to be satisfied.

The qualification runs against rules that are defined through the Create Validation Rules endpoint or via the Dashboard; in the Advanced Rule Builder → Order volume → Total amount. The qualification adds the individual amounts of the items and checks whether the sum meets the limits set by the Total amount. Additionally, another rule checked is one that is defined in Advanced Rule Builder → Order structure → Every order item/Any order item → Subtotal of matched items.

The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

Example:

10000

order.items.quantity

integer

Quantity of the item in the cart.

The qualification runs against rules that are defined through the Create Validation Rules endpoint or via the Dashboard; in the Advanced Rule Builder → Order Volume → Items quantity. The qualification adds the individual quantities of the items and checks whether the sum meets the limits set by Items quantity validation rule. Another validation rule against which the qualification does the checks is defined in the Advanced Rule Builder → Order Structure → Every order item/Any order item → Quantity of matched items. Read more.

Example:

1

order.items.price

integer

Unit price of an item. [This is not true in the case of using sourceid what was the case that this happened.]This price property takes precedence. If you provide a value at this level, then a price property defined once again in the related_object will be ignored. If this property will not be defined here, then the price property in the related_object will be used in the qualification.

The qualification runs against rules that are defined through the Create Validation Rules endpoint or via the Dashboard; in the Advanced Rule Builder → Order Structure → Every order item/Any order item → Unit Price of any matching order line and also Order Volume → Price of each item/Price of any item. Read more.

The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

Example:

10000

order.items.metadata

object

A set of key/value pairs that you can send in the request body to check against vouchers requiring order line item metadata validation rules to be satisfied.

The qualification runs against rules that are defined through the Create Validation Rules endpoint or via the Dashboard; in the Advanced Rule Builder → Order structure → Every order item/Any order item → Metadata of matched items. Read more.

A reference to the object containing details of the related product. Required when sending source_id in payload.

Available options:

product

order.items.product

object

An object containing details of the related product. Required when sending source_id in payload. These details will be used for qualification on top of details already stored in the system.

Show child attributes

order.items.product.source_id

string

A unique product identifier from your inventory system.

Example:

"product_1234"

order.items.product.name

string

Product name.

Example:

"Phone"

order.items.product.price

integer

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

Example:

10000

order.items.product.metadata

object

A set of key/value pairs that you can send in the request body to check against vouchers requiring product metadata validation rules to be satisfied.

order.customer

Customer Object · object

Show child attributes

order.customer.id

string

The ID of an existing customer that will be linked to the redemption in this request. This ID was assigned by the Voucherify API.

Example:

"cust_J1CDUdbqn5Exva8ASWk1Fq0j"

order.customer.source_id

string

Example:

"firstname.lastname@mycompany.com"

order.customer.name

string

First and Last Name. You can send the name in the request body to check against vouchers requiring specific name validation rules to be satisfied.

Example:

"FirstName LastName"

order.customer.email

string

You can send the email in the request body to check against vouchers requiring specific email validation rules to be satisfied.

Example:

"firstname.lastname@mycompany.com"

order.customer.phone

string

You can send the phone in the request body to check against vouchers requiring specific phone validation rules to be satisfied.

Required string length: 1 - 30

order.customer.address

object

A set of key/value pairs which describes the address. You can send the address in the request body to check against vouchers requiring specific address validation rules to be satisfied.

Show child attributes

order.customer.address.city

string

You can send the city in the request body to check against vouchers requiring specific city validation rules to be satisfied.

Example:

"New York"

order.customer.address.country

string

You can send the country in the request body to check against vouchers requiring specific country validation rules to be satisfied.

Example:

"United States of America"

order.customer.address.postal_code

string

You can send the postal code in the request body to check against vouchers requiring specific postal code validation rules to be satisfied.

Example:

"10001"

order.customer.address.state

string

You can send the state in the request body to check against vouchers requiring specific state validation rules to be satisfied.

Example:

"NY"

order.customer.metadata

object

order.customer.birthdate

string<date>

You can send the birthdate in the request body to check against vouchers requiring specific birthdate validation rules to be satisfied.

Example:

"2022-01-01"

order.referrer

object

The person who referred the customer to make the order.

order.metadata

object

A set of key/value pairs that you can send in the request body to check against vouchers requiring order metadata validation rules to be satisfied. The qualification runs against rules that are defined through the Create Validation Rules endpoint or via the Dashboard; in the Advanced Rule Builder → Order structure → Order metadata satisfy or Basic Builder → Attributes match → ORDER METADATA. Read more.

reward

object

Show child attributes

reward.points

integer

reward.assignment_id

string

reward.id

string

metadata

object

A set of key/value pairs that you can send in the request body to check against vouchers requiring redemption metadata validation rules to be satisfied. The qualification runs against rules that are defined through the Create Validation Rules endpoint or via the Dashboard; in the Advanced Rule Builder → Advanced → Redemption metadata satisfy or Basic Builder → Attributes match → REDEMPTION METADATA. Read more.

Response

200 - application/json

This operation returns the list of valid and active vouchers based on the qualification of given context (e.g., customer profile, redemptions metadata, order).

Response body schema for vouchers/qualification

object

string

default:list

The type of the object represented by JSON. Default is list.

data_ref

string

default:data

Identifies the name of the attribute that contains the array of qualified vouchers.

data

InapplicableToObject · object[]

Array of qualified vouchers.

Show child attributes

data.id

string

Assigned by the Voucherify API, identifies the voucher.

Example:

"v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV"

data.code

string

A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.

Example:

"WVPblOYX"

data.campaign

string

A unique campaign name, identifies the voucher's parent campaign.

Example:

"Gift Card Campaign"

data.campaign_id

string

Assigned by the Voucherify API, identifies the voucher's parent campaign.

Example:

"camp_FNYR4jhqZBM9xTptxDGgeNBV"

data.category

string

Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint.

data.category_id

string

Unique category ID assigned by Voucherify.

Example:

"cat_0bb343dee3cdb5ec0c"

data.type

enum<string>

Defines the type of the voucher.

Available options:

GIFT_VOUCHER,

DISCOUNT_VOUCHER,

LOYALTY_CARD

data.discount

Discount · object

Contains information about discount.

Discount
Discount
Discount
Discount
Discount

Show child attributes

data.discount.type

enum<string>

default:AMOUNT

required

Defines the type of the voucher.

Available options:

AMOUNT

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

data.discount.amount_off_formula

string

Formula used to dynamically calculate the discount.

data.discount.aggregated_amount_limit

integer

Maximum discount amount per order.

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

data.discount.is_dynamic

boolean

Flag indicating whether the discount was calculated using a formula.

data.gift

object

Object representing gift parameters. Child attributes are present only if type is GIFT_VOUCHER. Defaults to null.

Show child attributes

data.gift.amount

integer

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.

Example:

10000

data.gift.subtracted_amount

integer

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

data.gift.balance

integer

Available funds. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.

Example:

500

data.gift.effect

enum<string>

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

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS

data.loyalty_card

object

Object representing loyalty card parameters. Child attributes are present only if type is LOYALTY_CARD. Defaults to null.

Show child attributes

data.loyalty_card.points

integer

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

Example:

7000

data.loyalty_card.balance

integer

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

Example:

6970

data.loyalty_card.next_expiration_date

string<date>

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

Example:

"2023-05-30"

data.loyalty_card.next_expiration_points

integer

The amount of points that are set to expire next.

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

data.loyalty_card.expired_points

integer

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

data.loyalty_card.subtracted_points

integer

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

data.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"

data.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"

data.validity_timeframe

Validity Timeframe · object

Set recurrent time periods when the earning rule is valid. For example, valid for 1 hour every other day.start_date required when including the validity_timeframe.

Show child attributes

data.validity_timeframe.duration

string

Defines the amount of time an earning rule will be active in ISO 8601 format. For example, an earning rule with a duration of PT1H will be valid for a duration of one hour.

Example:

"PT1H"

data.validity_timeframe.interval

string

Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, an earning rule with an interval of P2D will be valid every other day.

Example:

"P2D"

data.validity_day_of_week

enum<integer>[]

Integer array corresponding to the particular days of the week in which the voucher is valid.

0 Sunday
1 Monday
2 Tuesday
3 Wednesday
4 Thursday
5 Friday
6 Saturday

Available options:

0,

1,

2,

3,

4,

5,

6

data.validity_hours

Validity Hours · object

Determines the hours of validity, e.g. to create a happy hours scenario.

Show child attributes

data.validity_hours.daily

object[]

Defines the recurring period(s) when the resource is active. The periods should not overlap.

Show child attributes

data.validity_hours.daily.start_time

string<time>

Defines the starting hour of validity in the HH:mm format. The resource is inactive before this time.

Example:

"12:00"

data.validity_hours.daily.days_of_week

enum<integer>[]

Integer array corresponding to the particular days of the week in which the resource is valid.

0 Sunday
1 Monday
2 Tuesday
3 Wednesday
4 Thursday
5 Friday
6 Saturday

Available options:

0,

1,

2,

3,

4,

5,

6

data.validity_hours.daily.expiration_time

string<time>

Defines the ending hour of validity in the HH:mm format. The resource is inactive after this time.

Example:

"14:00"

data.active

boolean | null

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.

true indicates an active voucher
false indicates an inactive voucher

data.additional_info

string

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

data.metadata

object

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.

data.assets

Voucher Assets · object

Stores links to images of QR and barcode that correspond to an encrypted voucher code.

Show child attributes

data.assets.qr

object

Stores Quick Response (QR) representation of encrypted code.

Show child attributes

data.assets.qr.id

string

Encrypted voucher code ID.

Example:

"U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q=="

data.assets.qr.url

string

URL to QR code

Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.

size: integer value from 1 to 100
format: string, either png (default) or svg

Example:

"https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D"

data.assets.barcode

object

Stores barcode representation of encrypted code.

Show child attributes

data.assets.barcode.id

string

Encrypted voucher code ID.

Example:

"U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ=="

data.assets.barcode.url

string

URL to barcode

Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.

size: integer value from 1 to 100
format: string, either png (default) or svg

Example:

"https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D"

data.is_referral_code

boolean | null

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

data.created_at

string<date-time>

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

Example:

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

data.updated_at

string<date-time>

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

Example:

"2021-12-22T10:14:45.316Z"

data.holder_id

string

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

Example:

"cust_eWgXlBBiY6THFRJwX45Iakv4"

data.referrer_id

string

Unique identifier of the referring person.

Example:

"cust_Vzck5i8U3OhcEUFY6MKhN9Rv"

data.object

string

default:voucher

The type of the object represented by JSON. Default is voucher.

data.publish

object

Stores a summary of publication events: an event counter and endpoint to return details of each event. Publication is an assignment of a code to a customer, e.g. through a distribution.

Show child attributes

data.publish.object

string

default:list

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.

data.publish.count

integer

Publication events counter.

Example:

0

data.publish.url

string

The endpoint where this list of publications can be accessed using a GET method. /v1/vouchers/{voucher_code}/publications

Example:

"/v1/vouchers/WVPblOYX/publications?page=1&limit=10"

data.redemption

object

Stores a summary of redemptions that have been applied to the voucher.

Show child attributes

data.redemption.quantity

integer

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

data.redemption.redeemed_quantity

integer

How many times a voucher has already been redeemed.

Example:

1

data.redemption.redeemed_points

integer

Total loyalty points redeemed.

Example:

100000

data.redemption.object

string

default:list

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.

data.redemption.url

string

The endpoint where this list of redemptions can be accessed using a GET method. /v1/vouchers/{voucher_code}/redemptions

Example:

"/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"

data.categories

Category · object[]

Contains details about the category.

Show child attributes

data.categories.id

string

required

Unique category ID assigned by Voucherify.

data.categories.name

string

required

Category name.

data.categories.hierarchy

integer

required

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

Required range: x >= 0

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

data.categories.created_at

string<date-time>

required

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

Example:

"2022-07-14T10:45:13.156Z"

data.categories.updated_at

string<date-time>

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

Example:

"2022-08-16T10:52:08.094Z"

data.validation_rules_assignments

Validation Rules Assignments List · object

List of Validation Rules Assignments

Show child attributes

data.validation_rules_assignments.object

enum<string>

default:list

required

The type of the object represented by JSON. This object stores information about validation rules assignments.

Available options:

list

data.validation_rules_assignments.data_ref

enum<string>

default:data

required

Identifies the name of the attribute that contains the array of validation rules assignments.

Available options:

data

data.validation_rules_assignments.data

Business Validation Rule Assignment · object[]

required

Contains array of validation rules assignments.

Show child attributes

data.validation_rules_assignments.data.id

string

required

The unique identifier for a assignment

data.validation_rules_assignments.data.rule_id

string

required

The unique identifier for a rule

The unique identifier for a related object

The type of related object

data.validation_rules_assignments.data.object

enum<string>

default:validation_rules_assignment

required

The type of the object represented by JSON.

Available options:

validation_rules_assignment

data.validation_rules_assignments.data.created_at

string<date-time>

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

Example:

"2022-03-09T11:19:04.819Z"

data.validation_rules_assignments.data.updated_at

string<date-time>

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

Example:

"2022-03-09T11:19:04.819Z"

data.validation_rules_assignments.data.validation_status

enum<string>

The validation status of the assignment

Available options:

VALID,

PARTIALLY_VALID,

INVALID

data.validation_rules_assignments.data.validation_omitted_rules

string[]

The list of omitted rules

data.validation_rules_assignments.total

integer

required

Total number of validation rules assignments.

Required range: x >= 0

data.applicable_to

Included Items · object

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.

Show child attributes

data.applicable_to.data

Contains array of items to which the discount can apply.

Contains definition for a product collection.

Product Collection
Product Collection for Unit Discount
Product Collection for Fixed Amount Discount
Product
Product for Unit Discount
Product for Fixed Amount Discount
SKU
SKU for Unit Discount
SKU for Amount Discount

Show child attributes

data.applicable_to.data.object

string

default:products_collection

This object stores information about the product collection.

data.applicable_to.data.id

string

Unique product collection ID assigned by Voucherify.

Example:

"pc_4ndRXAsTOzwSdHcQcxf489uU"

data.applicable_to.data.effect

enum<string>

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

Available options:

APPLY_TO_EVERY,

APPLY_TO_CHEAPEST,

APPLY_TO_MOST_EXPENSIVE

data.applicable_to.total

integer

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

data.applicable_to.data_ref

string

default:data

Identifies the name of the attribute that contains the array of included objects.

data.applicable_to.object

string

default:list

The type of the object represented by JSON. This object stores information about included products, SKUs, or product collections in a dictionary.

data.inapplicable_to

Excluded Items · object

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.

Show child attributes

data.inapplicable_to.data

(Product Collection · object | Product · object | SKU · object)[]

Contains array of items to which the discount cannot apply.

Contains definition for a product collection.

Product Collection
Product
SKU

Show child attributes

data.inapplicable_to.data.object

string

default:products_collection

This object stores information about the product collection.

data.inapplicable_to.data.id

string

Unique product collection ID assigned by Voucherify.

Example:

"pc_4ndRXAsTOzwSdHcQcxf489uU"

data.inapplicable_to.data.effect

enum<string>

default:APPLY_TO_EVERY

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

Available options:

APPLY_TO_EVERY

data.inapplicable_to.total

integer

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

data.inapplicable_to.data_ref

string

default:data

Identifies the name of the attribute that contains the array of excluded objects.

data.inapplicable_to.object

string

default:list

The type of the object represented by JSON. This object stores information about excluded products, SKUs, or product collections in a dictionary.

total

integer

Total valid and active vouchers matching the qualification criteria in given context.

Example:

37

string

Unique qualification ID.

Example:

"qfl_nAMVLoxIqSLh9O6YmfoAXRPG"

created_at

string<date-time>

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

Example:

"2022-02-25T13:32:08.734Z"

tracking_id

string

Hashed customer source ID.

Introduction

Endpoints

Events

Examine Voucher Qualification

How does this endpoint work?

What’s excluded?

Customizing the response

Sending the request body payload

Customer

Available options:

Note:

Order

Available options:

Note:

Guidelines:

Authorizations

Query Parameters

Body

Response