Campaign
All of:
- Campaign Base
-
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 , LUCKY_DRAW | ||||||
typestring | Defines whether the campaign can be updated with new vouchers after campaign creation.
AUTO_UPDATE , STATIC | ||||||
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 | ||||||
use_voucher_metadata_schemaboolean | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | ||||||
validity_timeframeobject | Set recurrent time periods when the campaign is valid. For example, valid for 1 hour every other day.
| ||||||
validity_day_of_weekarray | Integer array corresponding to the particular days of the week in which the campaign is valid.
| ||||||
activity_duration_after_publishingstring | Defines the amount of time the campaign will be active in ISO 8601 format after publishing. For example, a campaign with a | ||||||
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
| ||||||
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 | ||||||
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 category. Array of Category | ||||||
objectstring | The type of object represented by JSON. This object stores information about the campaign. | ||||||
referral_program | See: Referral Program | ||||||
loyalty_tiers_expiration | See: Loyalty Tiers Expiration |
Promotion Tiers
Attributes | Description |
---|---|
objectstring | The type of 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 |
Validation Rules Assignments List
Attributes | Description |
---|---|
objectstring | The type of 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.
| ||||||
code_config | See: Code Config Required Length Charset Pattern | ||||||
is_referral_codeboolean | Flag indicating whether this voucher is a referral code; | ||||||
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_timeframeobject | Set recurrent time periods when the campaign is valid. For example, valid for 1 hour every other day.
|
Category
Attributes | Description |
---|---|
idstring | Unique category ID assigned by Voucherify. |
namestring | Category name. |
hierarchyinteger | Category hierarchy. |
objectstring | The type of 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 |
stacking_rules_typestring | The type of the stacking rule eligibility. Available values:JOINT , EXCLUSIVE |
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.
| ||||||||||||||||
referee_rewardobject | Defines the referee reward.
|
Loyalty Tiers Expiration
Attributes | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
qualification_typestring | Tier qualification.
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.
MONTH , QUARTER , HALF_YEAR , YEAR | ||||||||||
start_dateobject | Defines the conditions for the start date of the tier.
| ||||||||||
expiration_dateobject | Defines the conditions for the expiration date of a tier.
|
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.
| ||||||||||||||||||||||||
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.
| ||||||||||||||||||||||||
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_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_timeframeobject | Set recurrent time periods when the promotion tier is valid. For example, valid for 1 hour every other day.
| ||||||||||||||||||||||||
validity_day_of_weekarray | Integer array corresponding to the particular days of the week in which the promotion tier is valid.
| ||||||||||||||||||||||||
summaryobject | Contains statistics about promotion tier redemptions and orders.
| ||||||||||||||||||||||||
objectstring | The type of 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 object represented by JSON. Available values:validation_rules_assignment |
validation_statusstring | The validation status of the assignment Available 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. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. |
balancenumber | Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. |
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 |
|
Code Config Required Length Charset Pattern
Validation Rule Assignments List
Attributes | Description |
---|---|
objectstring | The type of 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 | |
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 | |
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 | |
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_formulastring | |
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. |
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:
|
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 |
initial_countinteger | The initial count |
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 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 | |
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