Data import
You can upload CSV files straight from the dashboard.
Contents
Import through API
For more information about importing files through the API, visit the following resources:
Import vouchers.
Import vouchers to campaign.
Import customers.
Import products.
Import SKUs.
Imports overview
You can import vouchers, customers, products and SKUs. Importing is a three-step process.
- Prepare import CSV file. Below you will find a table with example CSV files.
- Map fields and attributes
Navigate and click on the import icon for the given import type. Map CSV column titles to Voucherify fields and any custom fields in the dashboard. On the left-hand side, you can see the CSV column names (1) that need to be mapped to fields from a Select property list (2). After selecting the matching field, choose the Plus (3) to confirm mapping.
- Import data by clicking import to confirm. You will be notified when the import is completed in the Notifications Center.
Guidelines
There are few things you need to know before starting the import. Here are some guidelines to follow for importing data into Voucherify:
- Is there a limit to the amount of data I can import? The import file size is
10 megabytes
for all import types. - Note that dates and date-time attributes need to be provided in compliance with the ISO 8601 norms. For example,
2022-03-11T09:00:00.000Z
or2022-03-11
. - Columns that can't be mapped to standard fields, will be mapped to Custom attributes and added as metadata. There is no limit on the number of custom attributes that you can import as metadata. To provide the proper data type, you need to add all custom attributes to the metadata schema before importing the file.
- Headers with metadata names can't contain white-space characters.
- If you import metadata defined in the schema as arrays (multiple), you need to separate each value using a comma, for example:
- array of strings:
"subscribed,premium"
- array of numbers:
"123,234"
- array of dates:
"2000-01-01,2000-01-02"
- array of strings:
Notifications
You can set custom notifications for data import by going to the Notifications Center > Personal Settings.
Troubleshooting & Audit
Once your import is finished you can find its status under the notification bell icon, whether it was successful or failed.
If you receive an error during your data import attempt, you can check the details regarding the problem in your dashboard in the Audit Log. You can find it at the bottom of the left hand side menu as shown on the screenshot below.
This will guide you to what to change in your import CSV to get the import through.
Note that if the number of errors in one import exceeds 100 then the import process is automatically stopped.
Examples
Below you will find a couple of CSV file examples.
Note that only metadata that is NOT nested will be imported correctly.
Vouchers
We'll begin with showing some examples for the different voucher types that you can import to Voucherify.
Standalone discount vouchers
You can import the following fields for standalone vouchers:
Reference | Field | Definition | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Code *required |
The unique discount code. | ||||||||||
|
Voucher Type *required |
The voucher type for discount vouchers is: DISCOUNT_VOUCHER |
||||||||||
|
Active | Use TRUE or FALSE to enable or disable the voucher; this flag can be used to turn off the ability to redeem a voucher even though it is within its start/end validity timeframe. |
||||||||||
|
Start Date | Provide voucher start date in compliance with the ISO 8601 norms. For example, 2022-09-19T00:00:00.000Z . |
||||||||||
|
Expiration Date | Provide voucher expiration date in compliance with the ISO 8601 norms. For example, 2022-11-30T00:00:00.000Z . |
||||||||||
|
Discount Type *required |
The options to choose from are: AMOUNT , PERCENT , FIXED , UNIT . |
||||||||||
|
Value *required
|
The discount value.
|
||||||||||
|
Category | A custom tag for the voucher to help you filter codes. | ||||||||||
|
Redemption Limit | Maximum number of redemptions allowed. If you leave this undefined, it will default to unlimited. | ||||||||||
|
Redeemed Quantity | Number of times the voucher was redeemed. If you leave this undefined, it will default to 0. | ||||||||||
|
Additional Info | Any additional information you would like to store about the voucher. | ||||||||||
|
Custom_metadata_property | Any additional data that you would like to store for the given voucher as a Custom attribute. Remember to define the metadata schema in the Dashboard prior to importing codes. Read more. |
A | B | C | D | E | F | G | H | I | J | K | L |
---|---|---|---|---|---|---|---|---|---|---|---|
Code | Voucher Type | Active | Start Date | Expiration Date | Discount Type | Value | Category | Redemption Limit | Redeemed Quantity | Additinal Info | Custom_metadata_property |
|
|
|
|
|
|
|
|
|
|
|
|
You can see below how the data will appear in Voucherify. Follow the column headers in the example above to the matched location in the screenshots below. The first screenshot shows how the data will be displayed in the Vouchers section.
This screenshot shows how the details will be displayed for the given voucher.
CSV File Template
Standalone gift cards
You can import the following fields into Voucherify for Gift cards:
Reference | Field | Definition |
---|---|---|
|
Code *required |
The unique gift card code. |
|
Voucher Type *required |
The voucher type for discount vouchers is: GIFT_VOUCHER |
|
Active | Use TRUE or FALSE to enable or disable the gift card; this flag can be used to turn off the ability to redeem a gift card even though it is within its start/end validity timeframe. |
|
Start Date | Provide gift card start date in compliance with the ISO 8601 norms. For example, 2022-09-19T00:00:00.000Z . |
|
Expiration Date | Provide gift card expiration date in compliance with the ISO 8601 norms. For example, 2022-11-30T00:00:00.000Z . |
|
Value | The initial gift card balance to be added. |
|
Category | A custom tag for the gift card to help you filter codes. |
|
Redemption Limit | Maximum number of redemptions allowed. If you leave this undefined, it will default to unlimited. |
|
Redeemed Quantity | Number of times the gift card was redeemed. |
|
Redeemed Amount | Amount that was redeemed from the available balance on the gift card. |
|
Additional Info | Any additional information you would like to store about the gift card. |
|
Custom_metadata_property | Any additional data that you would like to store for the given gift card as a Custom attribute. Remember to define the metadata schema in the Dashboard prior to importing codes. Read more. |
A | B | C | D | E | F | G | H | I | J | K | L |
---|---|---|---|---|---|---|---|---|---|---|---|
Code | Voucher Type | Active | Start Date | Expiration Date | Value | Category | Redemption Limit | Redeemed Quantity | Redeemed Amount | Additional Info | Region |
|
|
|
|
|
|
|
|
|
|
|
|
You can see below how the data will appear in Voucherify. Follow the column headers in the example above to the matched location in the screenshots below. The first screenshot shows how the data will be displayed in the Vouchers section.
This screenshot shows how the details will be displayed for the given gift card.
CSV File Template
Add loyalty cards to a campaign
You can import the following fields into Voucherify for Loyalty cards into a Loyalty Campaign:
Reference | Field | Definition |
---|---|---|
|
Code *required |
The unique loyalty card code. |
|
Active | Use TRUE or FALSE to enable or disable the loyalty card; this flag can be used to turn off the ability to redeem a loyalty card even though it is within the campaign's start/end validity timeframe. |
|
Loyalty Points | The number of points to be added to the loyalty card. If you leave this undefined, then the initial number of points will be set according to the campaign settings. Note that this option works only for the newly added loyalty cards. If the card existed before, the update of points is not possible this way - the balance put in the CSV file will be ignored. However, there is a dedicated API endpoint to adding points: Add or Remove Loyalty Card Balance, so you can use it to implement changes. |
|
Category | A custom tag for the loyalty card to help you filter codes. |
|
Custom_metadata_property | Any additional data that you would like to store for the given loyalty card as a Custom attribute. Remember to define the metadata schema in the Dashboard prior to importing codes. Read more. |
A | B | C | D | E |
---|---|---|---|---|
Code | Active | Loyalty Points | Category | Season |
|
|
|
|
|
You can see below how the data will appear in Voucherify. Follow the column headers in the example above to the matched location in the screenshots below. The first screenshot shows how the data will be displayed in the Vouchers section.
This screenshot shows how the details will be displayed for the given loyalty card.
CSV File Template
Add discount vouchers to a campaign
You can import the following fields for vouchers into a specific campaign:
Reference | Field | Definition |
---|---|---|
|
Code *required |
The unique discount voucher code. |
|
Active | Use TRUE or FALSE to enable or disable the voucher; this flag can be used to turn off the ability to redeem a voucher even though it is within the campaign's start/end validity timeframe. |
|
Category | A custom tag for the voucher to help you filter codes. |
|
Redeemed Quantity | The number of times the voucher was already redeemed. |
|
Custom_metadata_property | Any additional data that you would like to store for the given voucher as a Custom attribute. Remember to define the metadata schema in the Dashboard prior to importing codes. Read more. |
A | B | C | D | E |
---|---|---|---|---|
Code | Active | Category | Redeemed Quantity | Region |
|
|
|
|
|
You can see below how the data will appear in Voucherify. Follow the column headers in the example above to the matched location in the screenshots below. The first screenshot shows how the data will be displayed in the Vouchers section.
This screenshot shows how the details will be displayed for the given discount voucher.
CSV File Template
Add gift cards to a campaign
You can import the following fields for gift cards into a specific campaign:
Reference | Field | Definition |
---|---|---|
|
Code *required |
A unique gift card code. |
|
Active | Use TRUE or FALSE to enable or disable the gift card; this flag can be used to turn off the ability to redeem a voucher even though it is within the campaign's start/end validity timeframe. |
|
Gift Amount | The initial gift card balance. |
|
Category | A custom tag for the gift card to help you filter codes. |
|
Redeemed Quantity | The number of times the gift card was redeemed. |
|
Redeemed Amount | The amount that has been redeemed from the available balance on the gift card. |
|
Custom_metadata_property | Any additional data that you would like to store for the given gift card as a Custom attribute. Remember to define the metadata schema in the Dashboard prior to importing codes. Read more. |
A | B | C | D | E | F | G |
---|---|---|---|---|---|---|
Code | Active | Gift Amount | Category | Redeemed Quantity | Redeemed Amount | Region |
GIFT1000 | FALSE | 1000 | New | 4 | 25 | Europe |
You can see below how the data will appear in Voucherify. Follow the column headers in the example above to the matched location in the screenshots below. The first screenshot shows how the data will be displayed in the Vouchers section.
This screenshot shows how the details will be displayed for the given gift card.
CSV File Template
Customers
You can import the following fields into Voucherify for Customers:
Reference | Field | Definition |
---|---|---|
|
Name | Customer's first and last name. |
|
Source_id | Custom unique customer ID; for example, a customer ID stored in your CRM database that will help you easily identify this customer. source_id of the customer, you need to import the
source_id on the first customer upload. You will not be able to change or update the
source_id later on.
|
|
Description | Any additional information you would like to store about the customer. |
|
Customer's email address. | |
|
Phone | Customer's phone number. |
|
Address_line_1 | Address line |
|
Address_line_2 | Address line |
|
City | City |
|
Postal Code | Postal code |
|
State | State |
|
Country | Country |
|
Birthdate | Customer's birthdate; format: YYYY-MM-DD |
|
Custom_metadata_property | Any additional data that you would like to store for the given customer as a Custom attribute. Remember to define the metadata schema in the Dashboard prior to importing customers. Read more. |
A | B | C | D | E | F | G | H | I | J | K | L | M |
---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Source_id | Description | Phone | Adress_line_1 | Adress_line_2 | City | Postal_Code | State | Country | Birthdate | favorite_brands | |
|
|
|
|
|
|
|
|
|
|
|
|
|
You can see below how the data will appear in Voucherify. Follow the column headers in the example above to the matched location in the screenshot below.
CSV File Template
Products
You can import the following fields into Voucherify for Products:
Reference | Field | Definition |
|
name *required |
Product name |
|
source_id | Custom unique product ID; for example, a product ID stored in your CRM database that will help you easily identify this product. |
|
price | Product price |
|
attributes | A list of product attributes whose values you can customize for given SKUs. Define your attributes here and then you can set a value for these attributes in SKUs. For example, "color,size,ranking" . |
|
image_url | The HTTPS URL pointing to the .png or .jpg file. |
|
Custom_metadata_property | Any additional data that you would like to store for the given product as a Custom attribute. Remember to define the metadata schema in the Dashboard prior to importing products. Read more. |
A | B | C | D | E | F |
---|---|---|---|---|---|
name | source_id | price | attributes | image_url | Metadata_property_name |
|
|
|
|
|
|
You can see below how the data will appear in Voucherify. Follow the column headers in the example above to the matched location in the screenshot below.
CSV File Template
SKUs
You can import the following fields into Voucherify for SKUs:
Reference | Field | Definition |
|
product_id *required |
This value is the source_id that belongs to the parent product. This is required in order to connect the child SKU to the parent Product. |
|
sku | The name of the given SKU. |
|
source_id *required |
Custom unique SKU ID; for example, a SKU ID stored in your CRM database that will help you easily identify this product. |
|
price | The SKU price. |
|
image_url | The HTTPS URL pointing to a .png or .jpg file. |
|
attributes | Once you have attributes defined for the product, you can set a value for this attribute for a given SKU. Format is important here. Within brackets { } surrounded by double quotations " " , you create a list separated by commas , . Each list item consists of 1) the attribute defined on the product level, 2) the value for the given SKU. These elements are separated by a colon : . Each attribute must be surrounded by a single quotation ' ' . The value can be surrounded by a single quotation if it is a string, and left without the quotation if it is a number. For example, "{'color':'blue','size':'XS','ranking':4}" . |
A | B | C | D | E | F |
---|---|---|---|---|---|
product_id | sku | source_id | price | image_url | attributes |
|
|
sku_source_id_1
|
|
|
|
|
|
sku_source_id_2
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
You can see below how the data will appear in Voucherify. Follow the column headers in the example above to the matched location in the screenshot below. The product_id (A) will be displayed in the Dashboard tab. The attributes (F) and SKU image (E) can be found by clicking on the three dots ⋮ under the Actions column and then choosing either Show attributes or Show image.