Project
A project is an environment for managing your activities in Voucherify. A project can be used to run them concerning a brand, region, or currency, or you can use a project for development or staging purposes. For example, each Voucherify account has a Sandbox project for testing purposes.
Read Team and project settings article to learn more.
Voucherify Management API, available as an Enterprise feature, enables you to manage projects through the API. For instance, you can set up new projects with a specific configuration fully programmatically. You can conveniently list projects, retrieve specific project details, update, or delete projects and different project settings as needed.
Campaigns, vouchers, and promotions
A project consists of campaigns that are based on vouchers and promotion campaigns, which don’t need them.Campaign
You use campaigns to carry out promotional activities. There are five basic campaign types, which create:- discount coupons,
- loyalty cards.
- gift vouchers,
- referral codes,
- promotions (without vouchers),
| Links with | Example |
|---|---|
| Validation rule | Sets campaign eligibility criteria, like the order total must be over $100. |
| Product or Product collection | Targets discounts to specific products or collections. |
| Distribution | Sends campaign codes via email, SMS, and other channels. |
| Campaign metadata | Adds custom information, such as images or terms and conditions. |
| Category | Defines discount stacking behavior and helps filter results. |
| Template | Saves configuration of a gift or discount campaign. |
Campaign API reference
Voucher
A voucher is an incentive you offer to end customers. Each voucher has a unique code and ID. Vouchers can be grouped under one campaign to serve the same purpose. For example, you can create a campaign that assigns vouchers to customers who have a birthday. You use vouchers in the following campaign types:Voucher API reference
Promotions and promotion tiers
A promotion is a campaign that groups specific discounts. It does not require a voucher code. When a customer or their order qualifies, Voucherify automatically applies the discount to the order, or shows it to the customer as part of the qualification process. A promotion tier is a specific discount with conditions. Voucherify automatically applies the discount to customers and orders that meet those conditions. Promotion tiers can be applied together as a promotion stack or arranged in a hierarchy of an application in one promotion campaign.Promotion tier API reference
Template
A template saves a campaign configuration, so it links with all resources used in the original campaign, such as the validation rule, metadata, rewards, distribution setup, and other details. You can use the template to create a new campaign with the same configuration without setting it up again manually or edit its details, if necessary.- Create campaign template API endpoint
- Campaign templates article
Order
An order represents an order placed by a customer in your system. It contains details about the items and details about any incentives as well as discounts applied to the order. Orders work together with other Voucherify entities, see examples in the table below.| Links with | Example |
|---|---|
| Redemption | Incentives tied to specific orders. |
| Validation rule | Logic can include total amount, quantity, etc. |
| Metadata | Adds order-specific information for validation and reporting purposes. |
| Distribution | Can trigger messages based on order events. |
Order object API reference
Products and product collections
Voucherify can store your product catalog. The products can be also grouped together in collections.Product
A product represents an item or service sold to end-customers. A product can also have its variants – Stock Keeping Units (SKUs). Products work together with other Voucherify entities, see examples in the table below.| Links with | Example |
|---|---|
| Product collection | Used to form static or dynamic (updated automatically) groups of products. |
| Metadata | Defines properties like brand, category, etc. Used in filtering or dynamic discounts. |
Product object API reference
Product collection
A product collection groups products according to criteria defined with filters, for example price or metadata values. Product collections work together with other Voucherify entities, see examples in the table below.| Links with | Example |
|---|---|
| Product | Selected manually as a static collection. |
| Metadata | Filters products based on shared metadata. |
Product collection object API reference
Reward
A reward is a benefit that customers can get by exchanging (redeeming) loyalty points or as part of a referral program. Rewards work together with other Voucherify entities, see examples in the table below.| Links with | Example |
|---|---|
| Campaign (referral and loyalty programs) | Rewards can be linked to campaigns to define what the customer receives, like a gift card, a product, etc. |
Reward object API reference
Customer and customer segments
Voucherify can store details about your customers. You can also group customers into segments according to defined criteria.Customer
A customer is an entity in Voucherify that represents an end customer of a store, a B2B customer, or any partner who sees products or services. A customer can be assigned vouchers or be eligible for promotions. A customer object can have many parameters, for example:- name,
- email,
- birthdate,
- metadata.
| Links with | Example |
|---|---|
| Customer metadata | Adds attributes like VIP customers, region, etc. Used in segmentation. |
| Custom events | Triggers based on behavior, like app installation. |
| Customer segment | Selected manually as a static segment. |
Customer object API reference
Customer segments
A segment is a customer group that shares the same parameters. There are two types of segments in Voucherify:- static: it contains a manually prepared list of customers based on customer ID,
- dynamic: customers are dynamically added to or removed from the segment if they match a given filter. For example, it can be the customer’s birthday is today, they haven’t placed any orders in the past 30 days, or they joined a newsletter.
| Links with | Example |
|---|---|
| Customer | Source of data for static or dynamic segments. |
| Customer metadata | Filters customers based on shared metadata. |
| Custom events | Used for rules that define segment inclusion. |
| Validation rule | Used to narrow down campaign eligibility. |
| Distribution | Used to trigger message send out to matched customers. |
Customer segments article
Incentivization rules and processes
In Voucherify, you can set rules that govern how incentives, such as vouchers or discounts, are applied. You manage these incentives through several processes related to their application.Validation rules
Validation rules are conditions you apply to campaigns, generic (standalone) vouchers, promotion tiers, or distributions. For example, the customer or their order must meet these conditions before Voucherify applies the incentive. You can create a validation rule in advance. It is an independent object that you can attach to or detach from the above-mentioned objects and reuse in the future. Validation rules work together with other Voucherify entities, see examples in the table below.| Links with | Example |
|---|---|
| Metadata, for example for customers, orders, Custom events, redemptions | Customer metadata can restrict coupon usage to specific user profiles, like allow redemptions only if customer.region = "EU". |
| Order | Set conditions based on the contents of the cart, like Apply a discount on order.total_amount above $100. |
| Product or product collection | Require or exclude specific products in the cart. |
| Campaign | Sets eligibility criteria, like a discount campaign can include a validation rule that checks if the customer’s order exceeds $100; if the condition isn’t met, the coupon won’t apply. |
| Customer or customer segment | Apply discounts only to a specific segment, like limit access to the “Loyal Customers” segment. |
- Validation rule API reference
- Validation rules and campaign limits article
- How to build validation rules article
Qualification
Qualification is the process that validates which incentives (for example products, vouchers, or promotions) can be used in the customer’s order.- Qualification API reference
- Qualification – checking eligibility article
Validation
Validation checks if a combination of vouchers or promotion tiers, together with the applied validation rules, is valid for the customer. Based on the result, Voucherify calculates the final price. Validation checks up to 30 vouchers or promotion tiers.Validate stackable discounts API reference
Redemption
Redemption applies and consumes vouchers or promotion tiers on the customer’s order. It checks if a voucher or promotion tier, together with the applied validation rules, is valid for the customer. Redemption checks up to 30 vouchers or promotion tiers. Redemptions work together with other Voucherify entities, see examples in the table below.| Links with | Example |
|---|---|
| Metadata | Used for tracking or limiting redemptions. |
| Order | Ties redemption to a specific transaction. |
| Distribution | Can trigger a distribution. |
Redeem stackable discounts API reference
Rollback
A rollback reverts a redemption. It withdraws the incentive from the customer’s order and updates its status.Rollback stackable discounts API reference
Communication
You can use Voucherify as part of your communication strategy. Voucherify also supports webhooks to notify you about events related to customers, redemptions, or loyalty programs.Distribution
Distribution sends vouchers and other promotional messages to customers. You can use distribution as a publication method. There are two types of distributions:- automatic: an event triggers the distribution,
- manual: you send the message to all customers or a specified group.
- emails,
- text messages,
- live chat,
- push notifications.
| Links with | Example |
|---|---|
| Custom event | Trigger messages when an event occurs. |
| Customer segment | Sends messages to a defined group. |
| Campaign | Serves as a source for incentives. |
Publication
Publication assigns a voucher to an end customer.Publication API reference
Webhooks
A webhook is an HTTP callback that an event triggers, rather than a request. You can use webhooks to notify external systems about events or actions performed in Voucherify. The events can be custom. You can use custom events to track end-customer interactions with a system.- Introduction to Voucherify webhooks article
- Custom event API reference
- Webhook notifications article
- Custom events article
Metadata (custom attributes)
Metadata (custom attributes) are customizable data you can add to default Voucherify objects. A custom attribute consists of a key and value pair.- Metadata schema API reference
- Metadata mapping article
- Create metadata schema – Management API endpoint
- Getting started with metadata article
Custom events
Custom events are actions taken by your customers. You can use them to track customers’ behavior and then build highly personalized campaigns, for example, send customers a 5% off coupon if they’ve abandoned the cart.- Custom events article
- Create custom event schema – Management API endpoint