Overview

Campaign

All of:

1. Campaign Base

2. Campaign Additional Data

   Attributes	Description
   promotion	See: Promotion Tiers
   validation_rules_assignments	See: Validation Rules Assignments List

Campaign Base

Attributes	Description
idstring	Unique campaign ID, assigned by Voucherify.Example:camp_f7fBbQxUuTN7dI7tGOo5XMDA
namestring	Campaign name.
descriptionstring	An optional field to keep any extra textual information about the campaign such as a campaign description and details.
campaign_typestring	Type of campaign.Available values: LOYALTY_PROGRAM, GIFT_VOUCHERS, DISCOUNT_COUPONS, PROMOTION, REFERRAL_PROGRAM
typestring	Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of generic (standalone) voucherss.- 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 vouchersAvailable values: AUTO_UPDATE, STATIC, STANDALONE | | voucher | See: Campaign Voucher | | auto_joinboolean | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | | join_onceboolean | 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_schemaboolean | Flag indicating whether the campaign is to use the voucher’s metadata schema instead of the campaign metadata schema. | | validity_timeframe | See: Validity Timeframe | | validity_day_of_week | See: Validity Day Of Week | | validity_hours | See: Validity Hours | | activity_duration_after_publishingstring | 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_countinteger | Total number of unique vouchers in campaign. | | start_datestring | 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_datestring | Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date.Example:2022-09-30T00:00:00.000Z | | activeboolean | 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 | | metadataobject | 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_atstring | 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_atstring | Timestamp representing the date and time when the campaign was last updated in ISO 8601 format.Example:2022-09-20T09:18:19.623Z | | categorystring | Unique category name. | | creation_statusstring | Indicates the status of the campaign creation.Available values: DONE, IN_PROGRESS, FAILED, DRAFT, MODIFYING | | vouchers_generation_statusstring | Indicates the status of the campaign’s voucher generation.Available values: DONE, IN_PROGRESS, FAILED, DRAFT, MODIFYING | | readonlyboolean | 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. | | protectedboolean | Indicates whether the resource can be deleted. | | category_idstring, null | Unique category ID that this campaign belongs to.Example:cat_0b688929a2476386a7 | | categoriesarray | 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.Array of Category | | objectstring | The type of the object represented by JSON. This object stores information about the campaign. | | referral_program | See: Referral Program | | loyalty_tiers_expiration | See: Loyalty Tiers Expiration | | access_settings_assignments | See: Access Settings Campaign Assignments List |

Promotion Tiers

Attributes	Description
objectstring	The type of the object represented by JSON. This object stores information about promotion tiers in a dictionary.
data_refstring	Identifies the name of the attribute that contains the array of promotion tier objects.
tiersarray	Contains array of promotion tier objects.Array of Promotion Tier
totalinteger	Total number of promotion tiers.
has_moreboolean	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.

Validation Rules Assignments List

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

Campaign Voucher

Attributes	Description
typestring	Type of voucher.
discount	Defines the voucher discount type and details.Discount
gift	Defines the voucher gift details.Gift
loyalty_card	Defines the voucher loyalty card details.Campaign Loyalty Card
redemptionobject	Defines the redemption limits on vouchers.Attributes Descriptionquantityinteger, null How many times a voucher can be redeemed. A null value means unlimited.
code_config	Code Config
is_referral_codeboolean	Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.
start_datestring	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_datestring	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	See: Validity Timeframe
validity_day_of_week	See: Validity Day Of Week
validity_hours	See: Validity Hours

Validity Timeframe

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

dailyarray

Defines the reccuring period(s) when the resource is active. The periods should not overlap.Array of:Attributes Descriptionstart_timestring Defines the starting hour of validity in the HH:mm format. The resource is inactive before this time. Example: 12:00 days_of_weekarray 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_timestring Defines the ending hour of validity in the HH:mm format. The resource is inactive after this time. Example: 14:00

Category

Attributes	Description
idstring	Unique category ID assigned by Voucherify.
namestring	Category name.
hierarchyinteger	Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.
objectstring	The type of the object represented by the JSON. This object stores information about the category.Available values: category
created_atstring	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_atstring	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

Referral Program

Attributes	Description
conversion_event_typestring	Define how a referral is triggered.Available values: redemption, custom_event
custom_eventobject	Contains details about the custom event.Attributes Descriptionidstring Unique custom event ID. Example: ms_Ll9enAm2BCN0M1s4VxWobLFM namestring Custom event name.
referee_rewardobject	Defines the referee reward.Attributes Descriptionrelated_object_parentobject Details of the resource from which the reward originates. Attributes Descriptionidstring Unique ID of the reward source. Example: camp_kdxp3vf1clQ9CFs1jpqv3tZe namestring Name of the reward source. objectstring Type of resource represented by the source of the reward. Available values: CAMPAIGN typestring Type of reward. Available values: LOYALTY_CARD, GIFT_VOUCHER amountstring Define the number of points to add to a loyalty card or credits to the balance on a gift card. In case of the gift card, the value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.

Loyalty Tiers Expiration

Attributes	Description
qualification_typestring	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_periodstring	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.Period DefinitionCalendar Month Points collected in one calendar monthJanuary, February, March, etc. Calendar Quarter Points collected in the quarter- January - March- April - June- July - September- October - December Calendar Half-year Points collected in the half-year- January - June- July - December Calendar Year Points collected in one calendar yearJanuary - DecemberAvailable values: MONTH, QUARTER, HALF_YEAR, YEAR
start_dateobject	Defines the conditions for the start date of the tier.Attributes Descriptiontypestring What triggers the tier to be valid for a customer.IMMEDIATE: After reaching the minimum required points.NEXT_PERIOD: When the next qualification period starts. Available values: IMMEDIATE, NEXT_PERIOD
expiration_dateobject	Defines the conditions for the expiration date of a tier.Attributes Descriptiontypestring What triggers the tier to expire for a customer.END_OF_PERIOD: Expire tier at the end of the period.END_OF_NEXT_PERIOD: Expire tier at the end of the next period.BALANCE_DROP: Tier expires when the points balance drops below the required range of the tier.CUSTOM: Tier expires after a certain time period passes following the instance the points balance drops below the required range of the tier. Available values: END_OF_PERIOD, END_OF_NEXT_PERIOD, BALANCE_DROP, CUSTOM extendstring Extend the expiration by adding extra months or days in ISO 8601 format. The tier will remain active even though it reaches its expiration time period. For example, a tier with a duration of P3M will be valid for an additional duration of 3 months and a tier with a duration of P1D will be valid for an additional duration of 1 day. rounding Defines the rounding mechanism for tier expiration.

Access Settings Campaign Assignments List

Attributes	Description
objectstring	The type of the object represented by JSON. Default is list. This object stores information about campaign assignments to areas and storesAvailable values: list
data_refstring	Identifies the name of the attribute that contains the array of campaign assignments.Available values: data
dataarray	Contains an array of campaign assignments.Array of Areas and Stores Campain Assignment
totalinteger	Total number of areas and stores to which the campaign is assigned.

Promotion Tier

Attributes	Description
idstring	Unique promotion tier ID.Example:promo_63fYCt81Aw0h7lzyRkrGZh9p
created_atstring	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_atstring	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
namestring	Name of the promotion tier.
bannerstring	Text to be displayed to your customers on your website.
actionobject	Contains details about the discount applied by the promotion tier.Attributes Descriptiondiscount See: Discount
metadataobject	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.
hierarchyinteger	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_idstring	Promotion unique ID.
campaignobject	Contains details about promotion tier’s parent campaign.Attributes Descriptionidstring Unique campaign ID. start_datestring Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date. Example: 2022-09-22T00:00:00.000Z expiration_datestring 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 See: Validity Timeframe validity_day_of_week See: Validity Day Of Week validity_hours See: Validity Hours activeboolean A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it’s within the active period defined by the start_date and expiration_date using the Disable Campaign endpoint. true indicates an active campaign false indicates an inactive campaign category_idstring Unique category ID that this campaign belongs to. Example: cat_0b688929a2476386a6 objectstring The type of the object represented by the campaign object. This object stores information about the campaign.
campaign_idstring	Promotion tier’s parent campaign’s unique ID.
activeboolean	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_datestring | 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_datestring | 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 | See: Validity Timeframe | | validity_day_of_week | See: Validity Day Of Week | | validity_hours | See: Validity Hours | | summaryobject | Contains statistics about promotion tier redemptions and orders.Attributes Descriptionredemptionsobject

  Contains statistics about promotion tier redemptions.

  Attributes Descriptiontotal_redeemedinteger

  Number of times the promotion tier was redeemed.

  ordersobject

  Contains statistics about orders related to the promotion tier.

  Attributes Descriptiontotal_amountinteger

  Sum of order totals.

  total_discount_amountinteger

  Sum of total discount applied using the promotion tier. | | objectstring | The type of the object represented by JSON. This object stores information about the promotion tier. | | validation_rule_assignments | See: Validation Rule Assignments List | | category_idstring | Promotion tier category ID.Example:cat_0c9da30e7116ba6bba | | categoriesarray | Array of Category |

Business Validation Rule Assignment

Attributes	Description
idstring	The unique identifier for a assignment
rule_idstring	The unique identifier for a rule
related_object_idstring	The unique identifier for a related object
related_object_typestring	The type of related object
created_atstring	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_atstring	Timestamp representing the date and time when the object was last updated in ISO 8601 format.Example:2022-03-09T11:19:04.819Z
objectstring	The type of the object represented by JSON.Available values: validation_rules_assignment
validation_statusstring	The validation status of the assignmentAvailable values: VALID, PARTIALLY_VALID, INVALID
validation_omitted_rulesarray	The list of omitted rules

Discount

Contains information about discount.

One of:

Amount, Unit, Unit Multiple, Percent, Fixed

Gift

Attributes	Description
amountnumber	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_amountinteger	Total amount of subtracted credits over the gift card lifetime.
balancenumber	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.
effectstring	Defines how the credits are applied to the customer’s order.Available values: APPLY_TO_ORDER, APPLY_TO_ITEMS

Campaign Loyalty Card

Attributes	Description
pointsinteger	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_rulesobject	Defines the loyalty point expiration rule. This expiration rule applies when there are no expiration_rules defined for an earning rule.Attributes Descriptionperiod_typestring Type of period. Can be set for MONTH or FIXED_DAY_OF_YEAR. MONTH requires the period_value field. FIXED_DAY_OF_YEAR requires the fixed_month and fixed_day fields. Available values: FIXED_DAY_OF_YEAR, MONTH period_valueinteger Value of the period. Required for the period_type: MONTH. rounding_typestring Type of rounding of the expiration period. Optional for the period_type: MONTH. Available values: END_OF_MONTH, END_OF_QUARTER, END_OF_HALF_YEAR, END_OF_YEAR, PARTICULAR_MONTH rounding_valueinteger Value of rounding of the expiration period. Required for the rounding_type. fixed_monthinteger Determines the month when the points expire; 1 is January, 2 is February, and so on. Required for the period_type: FIXED_DAY_OF_YEAR. fixed_dayinteger Determines the day of the month when the points expire. Required for the period_type: FIXED_DAY_OF_YEAR.

Code Config

Attributes	Description
lengthnumber	Number of characters in a generated code (excluding prefix and postfix).
charsetstring	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 | | prefixstring | A text appended before the code. | | postfixstring | A text appended after the code. | | patternstring | A pattern for codes where hashes (#) will be replaced with random characters. Overrides length. | | initial_countinteger | Internal value, does not change anything if provided. |

Areas and Stores Campain Assignment

Attributes	Description
idstring	Unique identifier of the campaign assignment.Example:arsca_0ef5ee192117ae2416
area_idstring	Unique identifier of the area to which the campaign is assigned.Example:ar_0ea6cd7b781b8f857f
all_storesboolean	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_idstring	Unique identifier of the store to which the campaign is assigned.Example:ars_0ec347e2016bed85f4
created_atstring	Date and time when the assignment was made. The value is shown in the ISO 8601 format.Example:2024-06-25T19:04:16.260Z
objectstring	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

Validation Rule Assignments List

Attributes	Description
objectstring	The type of the object represented by JSON. This object stores information about validation rule assignments.
data_refstring	Identifies the name of the JSON property that contains the array of validation rule assignments.
dataarray	A dictionary that contains an array of validation rule assignments.Array of Validation Rule Assignment
totalinteger	Total number of validation rule assignments.

Amount

Attributes	Description
typestring	Defines the type of the voucher.Available values: AMOUNT
amount_offnumber	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_formulastring	Formula used to dynamically calculate the discount.
aggregated_amount_limitinteger	Maximum discount amount per order.
effect	Defines how the discount is applied to the customer’s order.Discount Amount Vouchers Effect Types
is_dynamicboolean	Flag indicating whether the discount was calculated using a formula.

Unit

Attributes	Description
typestring	Discount type.Available values: UNIT
unit_offinteger	Number of units to be granted a full value discount.
unit_off_formulastring	Formula used to dynamically calculate the number of units.
effect	Defines how the unit is added to the customer’s order.Discount Unit Vouchers Effect Types
unit_typestring	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_dynamicboolean	Flag indicating whether the discount was calculated using a formula.

Unit Multiple

Attributes	Description
typestring	Discount type.Available values: UNIT
effectstring	Defines how the discount is applied to the customer’s order.Available values: ADD_MANY_ITEMS
unitsarray	Array of One Unit

Percent

Attributes	Description
typestring	Defines the type of the voucher.Available values: PERCENT
percent_offnumber	The percent discount that the customer will receive.
percent_off_formulastring	Formula used to dynamically calculate the discount.
amount_limitnumber	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_limitinteger	Maximum discount amount per order.
effect	Defines how the discount is applied to the customer’s order.Discount Percent Vouchers Effect Types
is_dynamicboolean	Flag indicating whether the discount was calculated using a formula.

Fixed

Attributes	Description
typestring	Defines the type of the voucher.Available values: FIXED
fixed_amountnumber	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_formulastring	Formula used to dynamically calculate the discount.
effect	Defines how the discount is applied to the customer’s order.Discount Fixed Vouchers Effect Types
is_dynamicboolean	Flag indicating whether the discount was calculated using a formula.

Validation Rule Assignment

Attributes	Description
idstring	Validation rule assignment ID.Example:asgm_74F7QZoYbUoljwQO
rule_idstring	Validation rule ID.Example:val_4j7DCRm2IS59
related_object_idstring	The resource ID to which the validation rule was assigned.Example:v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT
related_object_typestring	The type of resource to which the validation rule was assigned.Available values: voucher, campaign, earning_rule, reward_assignment, promotion_tier, distribution
created_atstring	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
objectstring	The type of the object represented by the ID.Available values: validation_rules_assignment

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
idstring	Unique product ID, assigned by Voucherify.
source_idstring	Product’s source ID.
namestring	Product name.

Simple Sku Discount Unit

Attributes	Description
idstring	Unique SKU ID, assigned by Voucherify.
source_idstring	Product variant’s source ID.
namestring	Sku name

One Unit

Attributes	Description
unit_offnumber	Number of units to be granted a full value discount.
unit_off_formulastring	Formula used to dynamically calculate the number of units.
effectstring	Defines how the unit is added to the customer’s order.Available values: ADD_NEW_ITEMS, ADD_MISSING_ITEMS
unit_typestring	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