Products and Product Collections

In the Products section in the dashboard, you can add your products and group them into collections. Using standard and custom product attributes (metadata), you can create product-specific rules limiting promotion and loyalty-earning rules. This article shows how to manage products and use them in campaigns. 

Contents

1. Glossary
2. Add Products
3. Import Products and SKUs with CSV
4. Product Metadata
5. Product Filters
   1. How to Use Standard Filters
   2. How to Use Custom (Metadata) Filters
6. Creating a Product Collection
1. Creating static collection
2. Creating dynamic collection
3. Predefined collection
7. Using Products
8. Products and Collections Maintenance

Glossary

The glossary explains the terms used when working with products and product collections. 

Product ID

When adding a product to your account (using the Dashboard or API), a unique internal identifier is assigned to it. You can find it in the URL address when viewing product details. The product ID is generated by Voucherify automatically when adding a new product and it cannot be edited. Here is an example of a product ID:

prod_09268673c85013482b

Source ID

Source ID is an optional attribute that reflects a unique product identifier from your system (also known as an external ID). Besides the source ID, each product is automatically assigned to a special internal ID (product ID) generated by Voucherify when adding a new product.

Filters Editor

The Filters Editor builds filters using standard and custom product attributes. You can use it to browse particular products or to group inventory into product collections. To open the Filters Editor, click Find and apply filters in the Products section.

Product Collection

Product collections group products under predefined criteria. You can create static collections that remain unchanged with time or dynamic collections that update the product list with ongoing changes. Adding products to Voucherify is not required to create dynamic collections.

Validation Rules

You can attach optional limits to your incentives and earning rules (loyalty program). A customer's order needs to meet all assigned rules to make a successful redemption or get loyalty points.

Order

The order entity lets you pass your transactional data to the Voucherify account. Passing order items with a redemption request is required to execute product-specific limits.

Product Metadata

Discount Effect

When creating discounts (in-cart discounts, coupons) or gift cards, you must choose how they will be applied to the customer's order. Different discount effects are available for different campaign types. Amount and percent discounts can be applied to the whole order or particular items, while unit discounts can add new or only missing items to the customer's cart.

SKU

A stock-keeping unit (SKU) is a product variant. You can define many product SKUs (variants) for each product. Each SKU has its metadata and attributes. During the validation process, SKUs are treated as products. This means that the SKU inherits the metadata assigned to the product and combines product and SKU attributes.

Add Products

You can add a new product in the Products section in the dashboard or with the Create Product API. Adding products to Voucherify is not required to create dynamic collections and product-specific campaign rules. 

Add a new product in the dashboard

Creating a new product is a three-step process:

1. Adding product details.
2. Adding product variants (SKUs) (optional).
3. Adding custom attributes as metadata (optional). 

Go to the Products section and click Create product.

Add product Details:

1. Provide the product name (required). 
2. Provide the source ID (unique external identifier) (optional).
3. Provide the product price (optional).
4. Create an attribute(s) corresponding to variants. Confirm the attribute with the enter key. The next step will fill it with different values when creating particular variants (SKUs). 
5. Upload the product image (optional).
6. Click Next step.

Add SKUs (optional):

1. Click Create SKU.
2. Fill in the Details:
   1. Name (required).
   2. Source ID (optional)
   3. SKU Price (optional)
   4. Add an image (optional)
   5. Enter values to attributes (optional).
   6. Add metadata (optional)
3. Click Save.
4. Click Next step.

Add Metadata (optional). Use metadata definitions added firstly to the Metadata Schema:

1. Configure values for the metadata keys.
2. If necessary, Add next property to configure new metadata.
3. Click Next step.

Review the product data in the Summary and click Save to add the product.

Add a new product via API

With the Voucherify Product API, you can create new products and SKUs as well as manage items that have already been created.

Import Products and SKUs with CSV

Using a CSV file, you can import products and SKUs into your project. This method can also be used to update the names of existing products in Voucherify.

Import Products with CSV

Prepare a CSV file with your products.

When the CSV file is ready, go to the Products section and click on the Import CSV tool in the top right corner. 

1. Select Import products.
2. Upload the CSV file and go to Map fields.
3. Map data from the CSV columns to Voucherify fields. On the left, there are the CSV column names that need to be mapped to Voucherify fields from the Select property list or to Custom attributes and their property name.
4. After selecting the matching field, click the plus button to confirm the mapping.
5. When all fields are mapped, click Import.

The import process can take some time, depending on the number of products or SKUs being added. When the import is finished, Voucherify will notify you about the result in the Notifications Center. Click  Notifications and select Go To Notification Center at the bottom, then select Personal Settings > Import products to set up notifications for importing products.

Import SKUs with CSV

When the CSV file is ready, go to the Products section and click on the Import CSV tool in the top right corner. 

1. Select Import products.
2. Upload the CSV file and go to Map fields.
3. Map data from the CSV columns to Voucherify fields. On the left, there are the CSV column names that need to be mapped to Voucherify fields from the Select property list or to Custom attributes and their property name.
4. After selecting the matching field, click the plus button to confirm the mapping.
5. When all fields are mapped, click Import.

The import process can take some time, depending on the number of products or SKUs being added. When the import is finished, Voucherify will notify you about the result in the Notifications Center. Click Notifications and select Go To Notification Center at the bottom, then select Personal Settings > Import products to set up notifications for importing products.

Product Metadata

With metadata (custom attributes) in products and SKUs, you can create and execute product-specific campaign rules whether you decide to sync your inventory with Voucherify or not. You can upload products and use metadata to extend their characteristics with custom attributes or skip adding products and still use metadata to validate the customer's cart while redeeming the code.

Metadata Schema

With the Metadata Schema, you can reflect the custom product and SKU properties. In effect, every product or SKU will get a set of custom fields (each for a corresponding level or in an array form), which you can fill in if you decide to add or import your product catalog to Voucherify. If you do not want to import your catalog, you can pass added metadata attributes with order line items in the redemption request and still execute metadata-specific validation rules in your campaigns.

Products and SKUs share the same dedicated schema that stores all their custom attributes and ensures data integrity. To add new metadata to a schema:

1. Go to the Project Settings and the Metadata schema tab. 
2. Expand the list of Standard schemas and choose Product to add a new definition of metadata attribute.
3. Choose Add new definition to define custom attribute details.
4. You do not attach these attributes to specific products or SKUs; you define their names, types, and values (optional). If you check the mandatory option, defining this attribute value will be required when adding a new product or SKU to your account.
5. For string and number properties, you can define additional conditions for accepted property values. 

When a new definition is ready, confirm with Save. For the list of all metadata types and available configurations, go to the Getting started guide. 

Product Filters

You can use filters for standard searching (to browse particular items) and for grouping products into collections. To find product filters, go to the Products tab in the Campaign Hub section, and click Add filter.

Standard product filters:

• Source ID
• Name
• Creation date
• Price

How to Use Standard Filters?

1. Go to the Products section in your dashboard and click Add filter.
2. Click the name of the filter, for example, Price.
3. Use available conditions. You can create many filters for a single attribute. For example, two conditions: more than or equal $25; less than or equal $50.
4. Once ready, Save the filter.
5. You can add another filter from the list to refine the results. Use the AND/OR logical conjunctions to define if items need to match all added filters (AND) or only one of them (OR).

The results that meet the filters are updated in real time. From this view, you can group products into collections.

How to Use Custom Product Filters (Metadata)

WIth the Custom attributes (metadata), you can filter results that are not available by default. You can choose to filter by metadata already added to the Products schema or filter by a new metadata attribute. Although you can create filters with a new metadata attribute, it is highly encouraged to add all needed metadata to your Product schema first.

Creating a Filter with a Custom Property

1. Add a new metadata attribute to the schema (if necessary).
2. Go to the Products section and click Add filter.
3. Select Metadata.
4. Choose a previously added metadata attribute.
5. Use available conditions. You can create many filters for a single attribute.
6. Once ready, Save the filter.
7. You can add another filter from the list to refine the results. Use the AND/OR logical conjunctions to define if items need to match all added filters (AND) or only one of them (OR).

The results that meet the filters are updated in real time. From this view, you can group products into collections.

Creating a Product Collection

Collections group products that share the same attributes (standard and custom ones). Product collections can be used in validation rules to model product-specific limits. Collections can be created using the filters in the Products section or in the Product Collection section in the dashboard. There are two types of collections:

• Static collection that remains unchanged after it is saved. Each static collection may contain up to 20 products.
• Dynamic collection that checks each incoming order item against collection criteria and updates its product list in real time.

Both static and dynamic collections are built on top of applied filters. Additionally, a static collection can be created by manually selecting items from the main products list. 

Creating a Static Collection

Follow the steps below to create a static collection. 

1. Go to Products in the dashboard and browse the products you want to include in the collection by using the filters. Alternatively, go to the Product Collections and click Create collection.
2. Mark the checkboxes next to the items you want to add to the collection.
3. Click Save as collection and select Static collection.
4. Name your collection and click Save. In the Product Collections, name your collection and click Save as collection.

Once saved, the collection is created and it cannot be updated. 

When a product that is added to the static collection has SKUs, all its SKUs are also added to the static collection.

Creating a Dynamic Collection

Follow the steps below to create a dynamic collection. 

1. Go to Products in the dashboard and apply filters to define the criteria for the products included in the collection. In the Product Collections, click Create collection and apply filters.
2. Click Save as collection and select Dynamic collection.
3. Name your collection and click Save. In the Product Collections, name your collection and click Save as collection.

Once saved, products dynamically join and leave the collection depending on whether they meet the criteria or not. 

Predefined collection

In each Voucherify project, you can find a predefined collection All Products that gathers all items already added to your account and items that come with each request. You can use this collection to build product-specific validation rules that will be checked for each product coming in the customer's order.

Using Products

If you pass orders with validation or redemption requests, they will be validated against product-specific campaign rules and limits. The order object needs to provide the list of order line items and their attributes. Voucherify validates each item from the customer's cart, whether it is added to your account or not. You can read more about the Order object in this API reference. 

Product and Collection Maintenance

You can manage your products and collections using the dashboard – Products and Product Collections, respectively – or Products API.

Managing Products

In the Products section, you can:

• View the product list
• Create static and dynamic collections through fitlers
• Create products
• Import CSV files with products or SKUs
• View product details (in the three-dot menu or by clicking the product name)
  • Product dashboard: Name, source ID, price, and attributes
  • SKUs – all SKUs of a given product
  • Metadata – all custom attributes attached to the product
  • Activity – all actions performed with regard to the product or its SKUs. Open the event or go to log to learn more details about a given activity.
• Edit product details (in the three-dot menu)
• Delete a product by moving it to the bin or deleting it permanently (in the three-dot menu)

Managing Product Collections

In the Product Collections section, you can:

• View the collection list
• View collection details, including the products included in the collection and the filters used to create the dynamic collection
• Delete a collection