id
string

Unique campaign ID, assigned by Voucherify.

Example: camp_f7fBbQxUuTN7dI7tGOo5XMDA

name
string

Campaign name.

description
string

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

campaign_type
string

Type of campaign.

Available values: LOYALTY_PROGRAM, GIFT_VOUCHERS, DISCOUNT_COUPONS, PROMOTION, REFERRAL_PROGRAM

type
string

Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of generic (standalone) vouchers.

• AUTO_UPDATE : the campaign is dynamic, i.e. vouchers will generate based on set criteria
• STATIC : vouchers need to be manually published
• STANDALONE : campaign for single vouchers

Available values: AUTO_UPDATE, STATIC, STANDALONE

voucher

auto_join
boolean

Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.

join_once
boolean

If this value is set to true, customers will be able to join the campaign only once. It is always false for generic (standalone) vouchers campaigns and it cannot be changed in them. It is always true for loyalty campaigns and it cannot be changed in them.

use_voucher_metadata_schema
boolean

Flag indicating whether the campaign is to use the voucher’s metadata schema instead of the campaign metadata schema.

validity_timeframe

validity_day_of_week

validity_hours

activity_duration_after_publishing
string

Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days.

vouchers_count
integer

Total number of unique vouchers in campaign.

start_date
string

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

Example: 2022-09-20T00:00:00.000Z

expiration_date
string

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

Example: 2022-09-30T00:00:00.000Z

active
boolean

A flag to toggle the campaign on or off. You can disable a campaign even though it’s within the active period defined by the start_date and expiration_date.

• true indicates an active campaign
• false indicates an inactive campaign

metadata
object

The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format.

created_at
string

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

Example: 2021-12-01T08:00:50.038Z

updated_at
string

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

Example: 2022-09-20T09:18:19.623Z

category
string

Unique category name.

creation_status
string

Indicates the status of the campaign creation.

Available values: DONE, IN_PROGRESS, FAILED, DRAFT, MODIFYING

vouchers_generation_status
string

Indicates the status of the campaign’s voucher generation.

Available values: DONE, IN_PROGRESS, FAILED, DRAFT, MODIFYING

readonly
boolean

Indicates whether the campaign can be only read by a restricted user in the Areas and Stores enterprise feature. It is returned only to restricted users; this field is not returned for users with other roles. It is also not returned for restricted users who use the GET Campaign summary endpoint.

protected
boolean

Indicates whether the resource can be deleted.

category_id
string, null

Unique category ID that this campaign belongs to.

Example: cat_0b688929a2476386a7

categories
array

Contains details about the campaign category. For the GET List campaigns endpoint, this is returned only if the expand=category query parameter is passed in the request. Otherwise, it is returned as an empty array. For GET Campaign summary endpoint, it is always returned as an empty array.

object
string

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

referral_program

loyalty_tiers_expiration

access_settings_assignments

object
string

The type of the object represented by JSON. This object stores information about promotion tiers in a dictionary.

data_ref
string

Identifies the name of the attribute that contains the array of promotion tier objects.

tiers
array

total
integer

Total number of promotion tiers.

has_more
boolean

As query results are always limited (by the limit parameter), the has_more flag indicates if there are more records for given filter parameters. This lets you know if you can run another request to get more records returned in the results.

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

total
integer

Total number of validation rules assignments.

type
string

Type of voucher.

discount

Defines the voucher discount type and details.

gift

Defines the voucher gift details.

loyalty_card

Defines the voucher loyalty card details.

redemption
object

Defines the redemption limits on vouchers.

code_config

is_referral_code
boolean

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

start_date
string

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

Example: 2022-09-20T00:00:00.000Z

expiration_date
string

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

Example: 2022-09-30T00:00:00.000Z

validity_timeframe

validity_day_of_week

validity_hours

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

daily
array

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

conversion_event_type
string

Define how a referral is triggered.

Available values: redemption, custom_event

custom_event
object

Contains details about the custom event.

referee_reward
object

Defines the referee reward.

qualification_type
string

Tier qualification.

BALANCE : Points balance is based on the customer’s current points balance. Customers qualify for the tier if their points balance is in the points range of the tier.
POINTS_IN_PERIOD : A customer qualifies for the tier only if the sum of the accumulated points in a defined time interval reaches the tier threshold.

Available values: BALANCE, POINTS_IN_PERIOD

qualification_period
string

Customers can qualify for the tier if they collected enough points in a given time period. So, in addition to the customer having to reach a points range, they also need to have collected the points within a set time period.

Available values: MONTH, QUARTER, HALF_YEAR, YEAR

start_date
object

Defines the conditions for the start date of the tier.

expiration_date
object

Defines the conditions for the expiration date of a tier.

object
string

The type of the object represented by JSON. Default is list. This object stores information about campaign assignments to areas and stores

Available values: list

data_ref
string

Identifies the name of the attribute that contains the array of campaign assignments.

Available values: data

data
array

total
integer

Total number of areas and stores to which the campaign is assigned.

id
string

Unique promotion tier ID.

Example: promo_63fYCt81Aw0h7lzyRkrGZh9p

created_at
string

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

Example: 2021-12-15T11:34:01.333Z

updated_at
string

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

Example: 2022-02-09T09:20:05.603Z

name
string

Name of the promotion tier.

banner
string

Text to be displayed to your customers on your website.

action
object

Contains details about the discount applied by the promotion tier.

metadata
object

The metadata object stores all custom attributes assigned to the promotion tier. A set of key/value pairs that you can attach to a promotion tier object. It can be useful for storing additional information about the promotion tier in a structured format.

hierarchy
integer

The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer’s order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy.

promotion_id
string

Promotion unique ID.

campaign
object

Contains details about promotion tier’s parent campaign.

campaign_id
string

Promotion tier’s parent campaign’s unique ID.

active
boolean

A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it’s within the active period defined by the start_date and expiration_date.

• true indicates an active promotion tier
• false indicates an inactive promotion tier

start_date
string

Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is inactive before this date.

Example: 2022-09-23T00:00:00.000Z

expiration_date
string

Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is inactive after this date.

Example: 2022-09-26T00:00:00.000Z

validity_timeframe

validity_day_of_week

validity_hours

summary
object

Contains statistics about promotion tier redemptions and orders.

object
string

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

validation_rule_assignments

category_id
string

Promotion tier category ID.

Example: cat_0c9da30e7116ba6bba

categories
array

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
number

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.

subtracted_amount
integer

Total amount of subtracted credits over the gift card lifetime.

balance
number

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.

effect
string

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

Available values: APPLY_TO_ORDER, APPLY_TO_ITEMS

points
integer

The initial number of points to assign to the loyalty card. This is the current loyalty card score i.e. the number of loyalty points on the card.

expiration_rules
object

Defines the loyalty point expiration rule. This expiration rule applies when there are no expiration_rules defined for an earning rule.

length
number

Number of characters in a generated code (excluding prefix and postfix).

charset
string

Characters that can appear in the code.

Examples:

• Alphanumeric: 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ
• Alphabetic: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ
• Alphabetic Lowercase: abcdefghijklmnopqrstuvwxyz
• Alphabetic Uppercase: ABCDEFGHIJKLMNOPQRSTUVWXYZ
• Numbers: 0123456789
• Custom: a custom character set

prefix
string

A text appended before the code.

postfix
string

A text appended after the code.

pattern
string

A pattern for codes where hashes (#) will be replaced with random characters. Overrides length.

initial_count
integer

Internal value, does not change anything if provided.

id
string

Unique identifier of the campaign assignment.

Example: arsca_0ef5ee192117ae2416

area_id
string

Unique identifier of the area to which the campaign is assigned.

Example: ar_0ea6cd7b781b8f857f

all_stores
boolean

Determines if the campaign is assigned to all of the stores in the area, i.e. if an area ID is passed in the access_settings.assign.area_all_stores_ids in the request.

area_store_id
string

Unique identifier of the store to which the campaign is assigned.

Example: ars_0ec347e2016bed85f4

created_at
string

Date and time when the assignment was made. The value is shown in the ISO 8601 format.

Example: 2024-06-25T19:04:16.260Z

object
string

The type of the object represented by JSON. This object stores information about the campaign assignment to areas or stores.

Available values: area_store_campaign_assignment

object
string

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

data_ref
string

Identifies the name of the JSON property that contains the array of validation rule assignments.

data
array

total
integer

Total number of validation rule assignments.

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

Formula used to dynamically calculate the discount.

aggregated_amount_limit
integer

Maximum discount amount per order.

effect

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

is_dynamic
boolean

Flag indicating whether the discount was calculated using a formula.

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 dynamically calculate the number of units.

effect

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

unit_type
string

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

product

Contains information about the product.

sku

is_dynamic
boolean

Flag indicating whether the discount was calculated using a formula.

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

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

Formula used to dynamically calculate the discount.

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.

is_dynamic
boolean

Flag indicating whether the discount was calculated using a formula.

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

Formula used to dynamically calculate the discount.

effect

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

is_dynamic
boolean

Flag indicating whether the discount was calculated using a formula.

id
string

Validation rule assignment ID.

Example: asgm_74F7QZoYbUoljwQO

rule_id
string

Validation rule ID.

Example: val_4j7DCRm2IS59

related_object_id
string

The resource ID to which the validation rule was assigned.

Example: v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT

related_object_type
string

The type of resource to which the validation rule was assigned.

Available values: voucher, campaign, earning_rule, reward_assignment, promotion_tier, distribution

created_at
string

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

Example: 2022-02-17T08:18:15.085Z

object
string

The type of the object represented by the ID.

Available values: validation_rules_assignment

id
string

Unique product ID, assigned by Voucherify.

source_id
string

Product’s source ID.

name
string

Product name.

id
string

Unique SKU ID, assigned by Voucherify.

source_id
string

Product variant’s source ID.

name
string

Sku name

unit_off
number

Number of units to be granted a full value discount.

unit_off_formula
string

Formula used to dynamically 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.

sku

Contains information about the sku.