Voucher Object

Voucher

This is an object representing a voucher with categories and validation rules assignments.

All of:

Voucher Base
Attributes Description
categories
array
Contains details about the category.
Array of Category
validation_rules_assignments See: Validation Rules Assignments List

Attributes	Description
categories `array`	Contains details about the category. Array of Category
validation_rules_assignments	See: Validation Rules Assignments List

Voucher Base

Attributes Description

id
string

Assigned by the Voucherify API, identifies the voucher.

Example:

v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV

code
string

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

Example:

WVPblOYX

campaign
string

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

Example:

Gift Card Campaign

campaign_id
string

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

Example:

camp_FNYR4jhqZBM9xTptxDGgeNBV

category
string

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

category_id
string

Unique category ID assigned by Voucherify.

Example:

cat_0bb343dee3cdb5ec0c

type
string

Defines the type of the voucher.

Available values: GIFT_VOUCHER, DISCOUNT_VOUCHER, LOYALTY_CARD

discount See: Discount

gift
object

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

Attributes Description

amount
integer

Total gift card income over the lifetime of the card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.

Example:

10000

balance
integer

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

Example:

500

effect
string

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

Available values: APPLY_TO_ORDER, APPLY_TO_ITEMS

loyalty_card
object

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

Attributes	Description
points `integer`	Total points incurred over the lifespan of the loyalty card. Example: 7000
balance `integer`	Points available for reward redemption. Example: 6970
next_expiration_date `string`	The next closest date when the next set of points are due to expire. Example: 2023-05-30
next_expiration_points `integer`	The amount of points that are set to expire next.

start_date
string

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

expiration_date
string

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

Example:

2021-12-31T00:00:00.000Z

validity_timeframe See: Validity Timeframe

validity_day_of_week See: Validity Day Of Week

validity_hours See: Validity Hours

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

additional_info
string

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

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.

assets See: Voucher Assets

is_referral_code
boolean, null

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

created_at
string

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

updated_at
string

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

Example:

2021-12-22T10:14:45.316Z

holder_id
string

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

Example:

cust_eWgXlBBiY6THFRJwX45Iakv4

referrer_id
string

Unique identifier of the referring person.

Example:

cust_Vzck5i8U3OhcEUFY6MKhN9Rv

object
string

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

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.

Attributes Description

object
string

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.

count
integer

Publication events counter.

Example:

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

redemption
object

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

Attributes	Description
quantity `integer`	How many times a voucher can be redeemed. A `null` value means unlimited.
redeemed_quantity `integer`	How many times a voucher has already been redeemed. Example: 1
redeemed_points `integer`	Total loyalty points redeemed. Example: 100000
object `string`	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.
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

Attributes	Description
id `string`	Unique category ID assigned by Voucherify.
name `string`	Category name.
hierarchy `integer`	Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.
object `string`	The type of the object represented by the JSON. This object stores information about the category. Available values: `category`
created_at `string`	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
updated_at `string`	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

Validation Rules Assignments List

Attributes	Description
object `string`	The type of the object represented by JSON. This object stores information about validation rules assignments. Available values: `list`
data_ref `string`	Identifies the name of the attribute that contains the array of validation rules assignments. Available values: `data`
data `array`	Contains array of validation rules assignments. Array of Business Validation Rule Assignment
total `integer`	Total number of validation rules assignments.

Discount

Contains information about discount.

One of:

Amount, Unit, Unit Multiple, Percent, Fixed

Validity Timeframe

Attributes Description

Attributes	Description
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
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

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

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

Validity Day Of Week

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

Validity Hours

Attributes Description

daily
array

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

Array of:

Attributes Description

start_time
string

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

Example:

12:00

days_of_week
array

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

expiration_time
string

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

Example:

14:00

Voucher Assets

Attributes Description

qr
object

Stores Quick Response (QR) representation of encrypted code.

Attributes Description

id
string

Encrypted voucher code ID.

Example:

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

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

barcode
object

Stores barcode representation of encrypted code.

Attributes Description

id
string

Encrypted voucher code ID.

Example:

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

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

Business Validation Rule Assignment

Attributes	Description
id `string`	The unique identifier for a assignment
rule_id `string`	The unique identifier for a rule
related_object_id `string`	The unique identifier for a related object
related_object_type `string`	The type of related object
created_at `string`	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
updated_at `string`	Timestamp representing the date and time when the object was last updated in ISO 8601 format. Example: 2022-03-09T11:19:04.819Z
object `string`	The type of the object represented by JSON. Available values: `validation_rules_assignment`
validation_status `string`	The validation status of the assignment Available values: `VALID`, `PARTIALLY_VALID`, `INVALID`
validation_omitted_rules `array`	The list of omitted rules

Amount

Attributes	Description
type `string`	Defines the type of the voucher. Available values: `AMOUNT`
amount_off `number`	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.
amount_off_formula `string`
aggregated_amount_limit `integer`	Maximum discount amount per order.
effect	Defines how the discount is applied to the customer's order. Discount Amount Vouchers Effect Types
is_dynamic `boolean`	Flag indicating whether the discount was calculated using a formula.

Unit

Attributes	Description
type `string`	Discount type. Available values: `UNIT`
unit_off `integer`	Number of units to be granted a full value discount.
unit_off_formula `string`	Formula used to calculate the number of units.
effect	Defines how the unit is added to the customer's order. Discount Unit Vouchers Effect Types
unit_type `string`	The product deemed as free, chosen from product inventory (e.g. time, items).
product	Contains information about the product. Simple Product Discount Unit
sku	See: Simple Sku Discount Unit
is_dynamic `boolean`	Flag indicating whether the discount was calculated using a formula.

Unit Multiple

Attributes	Description
type `string`	Discount type. Available values: `UNIT`
effect `string`	Defines how the discount is applied to the customer's order. Available values: `ADD_MANY_ITEMS`
units `array`	Array of One Unit

Percent

Attributes	Description
type `string`	Defines the type of the voucher. Available values: `PERCENT`
percent_off `number`	The percent discount that the customer will receive.
percent_off_formula `string`
amount_limit `number`	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.
aggregated_amount_limit `integer`	Maximum discount amount per order.
effect	Defines how the discount is applied to the customer's order. Discount Percent Vouchers Effect Types
is_dynamic `boolean`	Flag indicating whether the discount was calculated using a formula.

Fixed

Attributes	Description
type `string`	Defines the type of the voucher. Available values: `FIXED`
fixed_amount `number`	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.
fixed_amount_formula `string`
effect	Defines how the discount is applied to the customer's order. Discount Fixed Vouchers Effect Types
is_dynamic `boolean`	Flag indicating whether the discount was calculated using a formula.

Discount Amount Vouchers Effect Types

Available values: APPLY_TO_ORDER, APPLY_TO_ITEMS, APPLY_TO_ITEMS_PROPORTIONALLY, APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY, APPLY_TO_ITEMS_BY_QUANTITY

Discount Unit Vouchers Effect Types

Available values: ADD_MISSING_ITEMS, ADD_NEW_ITEMS, ADD_MANY_ITEMS

Simple Product Discount Unit

Attributes	Description
id `string`	Unique product ID, assigned by Voucherify.
source_id `string`	Product's source ID.
name `string`	Product name.

Simple Sku Discount Unit

Attributes	Description
id `string`	Unique SKU ID, assigned by Voucherify.
source_id `string`	Product variant's source ID.
name `string`	Sku name

One Unit

Attributes	Description
unit_off `number`	Number of units to be granted a full value discount.
unit_off_formula `string`	Formula used to calculate the number of units.
effect `string`	Defines how the unit is added to the customer's order. Available values: `ADD_NEW_ITEMS`, `ADD_MISSING_ITEMS`
unit_type `string`	The product deemed as free, chosen from product inventory (e.g. time, items).
product	Contains information about the product. Simple Product Discount Unit
sku	Contains information about the sku. Simple Sku Discount Unit

Discount Percent Vouchers Effect Types

Available values: APPLY_TO_ORDER, APPLY_TO_ITEMS

Discount Fixed Vouchers Effect Types

Available values: APPLY_TO_ORDER, APPLY_TO_ITEMS

Voucher

Voucher Base

Category

Validation Rules Assignments List

Discount

Validity Timeframe

Validity Day Of Week

Validity Hours

Voucher Assets

Business Validation Rule Assignment

Amount

Unit

Unit Multiple

Percent

Fixed

Discount Amount Vouchers Effect Types

Discount Unit Vouchers Effect Types

Simple Product Discount Unit

Simple Sku Discount Unit

One Unit

Discount Percent Vouchers Effect Types

Discount Fixed Vouchers Effect Types