Campaign Object

Unique campaign ID, assigned by Voucherify.

camp_f7fBbQxUuTN7dI7tGOo5XMDA

Campaign name.

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

Type of campaign.

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 vouchers

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

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.

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

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.

Total number of unique vouchers in campaign.

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

2022-09-20T00:00:00.000Z

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

2022-09-30T00:00:00.000Z

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

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.

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

2021-12-01T08:00:50.038Z

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

2022-09-20T09:18:19.623Z

Unique category name.

Indicates the status of the campaign creation.

Indicates the status of the campaign's voucher generation.

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.

Indicates whether the resource can be deleted.

Unique category ID that this campaign belongs to.

cat_0b688929a2476386a7

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.

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

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

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

Contains array of promotion tier objects.

Total number of promotion tiers.

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.

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

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

Contains array of validation rules assignments.

Total number of validation rules assignments.

Type of voucher.

Defines the voucher discount type and details.

Defines the voucher gift details.

Defines the voucher loyalty card details.

Defines the redemption limits on vouchers.

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

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

2022-09-20T00:00:00.000Z

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

2022-09-30T00:00:00.000Z

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.

PT1H

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.

P2D

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

Unique category ID assigned by Voucherify.

Category name.

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

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

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

2022-07-14T10:45:13.156Z

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

2022-08-16T10:52:08.094Z

Define how a referral is triggered.

Contains details about the custom event.

Defines the referee reward.

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.

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.

Defines the conditions for the start date of the tier.

Defines the conditions for the expiration date of a tier.

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

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

Contains an array of campaign assignments.

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

Unique promotion tier ID.

promo_63fYCt81Aw0h7lzyRkrGZh9p

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

2021-12-15T11:34:01.333Z

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

2022-02-09T09:20:05.603Z

Name of the promotion tier.

Text to be displayed to your customers on your website.

Contains details about the discount applied by the promotion tier.

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.

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 unique ID.

Contains details about promotion tier's parent campaign.

Promotion tier's parent campaign's unique ID.

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

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

2022-09-23T00:00:00.000Z

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

2022-09-26T00:00:00.000Z

Contains statistics about promotion tier redemptions and orders.

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

Promotion tier category ID.

cat_0c9da30e7116ba6bba

The unique identifier for a assignment

The unique identifier for a rule

The unique identifier for a related object

The type of related object

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

2022-03-09T11:19:04.819Z

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

2022-03-09T11:19:04.819Z

The type of the object represented by JSON.

The validation status of the assignment

The list of omitted rules

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.

Total amount of subtracted credits over the gift card lifetime.

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.

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

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.

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

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

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

A text appended before the code.

A text appended after the code.

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

Internal value, does not change anything if provided.

Unique identifier of the campaign assignment.

arsca_0ef5ee192117ae2416

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

ar_0ea6cd7b781b8f857f

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.

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

ars_0ec347e2016bed85f4

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

2024-06-25T19:04:16.260Z

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

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

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

A dictionary that contains an array of validation rule assignments.

Total number of validation rule assignments.

Defines the type of the voucher.

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.

Formula used to dynamically calculate the discount.

Maximum discount amount per order.

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

Flag indicating whether the discount was calculated using a formula.

Discount type.

Number of units to be granted a full value discount.

Formula used to dynamically calculate the number of units.

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

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

Contains information about the product.

Flag indicating whether the discount was calculated using a formula.

Discount type.

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

Defines the type of the voucher.

The percent discount that the customer will receive.

Formula used to dynamically calculate the discount.

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.

Maximum discount amount per order.

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

Flag indicating whether the discount was calculated using a formula.

Defines the type of the voucher.

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.

Formula used to dynamically calculate the discount.

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

Flag indicating whether the discount was calculated using a formula.

Validation rule assignment ID.

asgm_74F7QZoYbUoljwQO

Validation rule ID.

val_4j7DCRm2IS59

The resource ID to which the validation rule was assigned.

v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT

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

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

2022-02-17T08:18:15.085Z

The type of the object represented by the ID.

Unique product ID, assigned by Voucherify.

Product's source ID.

Product name.

Unique SKU ID, assigned by Voucherify.

Product variant's source ID.

Sku name

Number of units to be granted a full value discount.

Formula used to dynamically calculate the number of units.

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

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

Contains information about the product.

Contains information about the sku.