Data import

You can upload CSV files straight from the dashboard. 

Contents

  1. Imports overview
  2. Guidelines
  3. Notifications
  4. Troubleshooting & Audit
  5. Examples

Import through API

For more information about importing files through the API, visit the following resources:

Imports overview

You can import vouchers, customers, products and SKUs. Importing is a three-step process.

  1. Prepare import CSV file. Below you will find a table with example CSV files.
    2. CSV file template Dedicated tutorial
    Import_standalone_discount_vouchers.CSV
    		 Import standalone discount vouchers
    Import_standalone_gift_cards.CSV
    		 Import standalone gift cards
    Import_loyalty_cards_into_campaign.CSV Import loyalty cards into a campaign
    Import_discount_vouchers_into_campaign.CSV Import discount vouchers into a campaign
    Import_gift_cards_into_campaign.CSV Import gift cards into a campaign
    Import_customers.CSV
    		 Import customers
    Import_products.CSV Import products
    Import_skus.CSV
    		 Import SKUs
  2. Map fields and attributes

    Go to specific dashboard section (Campaigns, Products, or Customers) and click Import CSV to open the import builder. Upload your CSV file. In Map fields map the CSV column titles to Voucherify fields, existing metadata, unknown metadata (undefined in the metadata schema), or do not map given data.

  3. Click Import to confirm. You will receive a notification when the import is completed in the Notifications Center.

    Notifications

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 or 2022-03-11.
  • Columns that can't be mapped to standard fields, will not be mapped by default. However, you can map them as Metadata (schema) or Metadata (unknown). Metadata (schema) is the metadata that has a schema defined in Project settings. The Metadata (unknown) do not have a defined schema, but you can add the field anyway. This metadata will be added to a relevant schema as undefined with a type set to string. 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"

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 a CSV file to create standalone vouchers. Even though you can create a standalone voucher campaign, if you import vouchers through CSV in the Campaign > Vouchers section in the dashboard, the vouchers will not have a campaign attached. However, if you have a standalone voucher campaign, you can import additional vouchers to that campaign.

You can import the following fields for standalone vouchers:

The options to choose from are:  AMOUNT, PERCENTAGE, FIXED, UNIT.
Reference Field Definition
A
Code
*required		 The unique discount code.
B
Voucher Type
*required		 The voucher type for discount vouchers is:  DISCOUNT_VOUCHER
C
Value The actual discount that will be applied (e.g., amount, percentage, fixed,).
D
Formula Custom formula for calculating the discount dynamically (if applicable).

E
Validation Rule ID The ID of the validation rule saying how and when the voucher can be redeemed.
F
Discount Effect The Discount Effect defines how a discount impacts the final price, either by applying it to the original price or after other discounts are applied.
G
Discount Type The Discount Type specifies the form of the discount, such as amount, percentage, fixed amount, or free shipping.
H
Category A custom tag for the voucher to help you filter codes.
I
Start Date The Start Date specifies when a standalone campaign voucher becomes valid, in ISO 8601 format (YYYY-MM-DD).
J
Expiration Date The Expiration Date defines when a standalone campaign voucher expires and is no longer valid, in ISO 8601 format (YYYY-MM-DD).
K
Redemption Limit Maximum number of redemptions allowed. If you leave this undefined, it will default to unlimited.
L
Redeemed Amount The Redeemed Amount refers to the total value of the discount that has been used by the customer from a voucher.
M
Redeemed Quantity Number of times the voucher was redeemed. If you leave this undefined, it will default to 0.
N
Active Active indicates whether the voucher is currently active and can be used by customers.
N
Additional Info Any additional information you would like to store about the voucher.
O
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.
CSV example
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 Additional Info Custom_metadata_property
SUMMER2023 DISCOUNT_VOUCHER FALSE 2023-05-19T00:00:00.000Z 2023-09-30T23:59:00.000Z AMOUNT 10 New 3 2 Planned release in Summer 2023 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.

Vouchers view

This screenshot shows how the details will be displayed for the given voucher.

Dashboard view
CSV File Template

Import_standalone_discount_vouchers.CSV

Standalone gift cards

You can import the following fields into Voucherify for Gift cards:

Reference Field Definition
A
Code
*required		 The unique gift card code.
B
Voucher Type
*required		 The voucher type for discount vouchers is: GIFT_VOUCHER
C
Value Value refers to the monetary amount stored on a gift card, representing the total available balance.
D
Formula Custom formula for calculating the discount dynamically (if applicable).

E
Validation Rule ID The ID of the validation rule saying how and when the voucher can be redeemed.
F
Discount Effect The Discount Effect defines how a discount impacts the final price, either by applying it to the original price or after other discounts are applied.
G
Discount Type The Discount Type specifies the form of the discount.
H
Category A custom tag for the voucher to help you filter codes.
I
Start Date The Start Date specifies when a gift voucher becomes valid, in ISO 8601 format (YYYY-MM-DD).
J
Expiration Date The Expiration Date defines when a giftvvoucher expires and is no longer valid, in ISO 8601 format (YYYY-MM-DD).
K
Redemption Limit Maximum number of redemptions allowed. If you leave this undefined, it will default to unlimited.
L
Redeemed Amount The Redeemed Amount refers to the total value of the discount that has been used by the customer from a voucher.
M
Redeemed Quantity Number of times the voucher was redeemed. If you leave this undefined, it will default to 0.
N
Active Active indicates whether the voucher is currently active and can be used by customers.
N
Additional Info Any additional information you would like to store about the voucher.
O
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.
CSV example
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
GIFT200 GIFT_VOUCHER FALSE 2022-05-01T00:00:00.000Z 2022-12-31T23:59:00.000Z 200 Gift 1 50 Birthday gift card 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.

Vouchers view

This screenshot shows how the details will be displayed for the given gift card.

Dashboard view
CSV File Template

Import_standalone_gift_cards.CSV

Add loyalty cards to a campaign

You can import the following fields into Voucherify for Loyalty cards into a Loyalty Campaign:

Reference Field Definition
A
Code
*required		 The unique loyalty card code.
B
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.
C
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.
D
Category A custom tag for the loyalty card to help you filter codes.
E
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.
CSV example
A B C D E
Code Active Loyalty Points Category Season
Loyalty100 FALSE 100 Grand-Opening Spring

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.

Vouchers List View
Vouchers view

This screenshot shows how the details will be displayed for the given loyalty card.

Loyalty Card View
Dashboard view
CSV File Template

Import_loyalty_cards_into_campaign.CSV

Add discount vouchers to a campaign

You can import the following fields for vouchers into a specific campaign:

Reference Field Definition
A
Code
*required		 The unique discount voucher code.
B
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.
C
Category A custom tag for the voucher to help you filter codes.
D
Redeemed Quantity The number of times the voucher was already redeemed.
E
Redeemed Amount The Redeemed Amount refers to the total value of the discount that has been used by the customer from a voucher.
F
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.
CSV example
A B C D E
Code Active Category Redeemed Quantity Region
FALL2022 FALSE New 4 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.

Vouchers List View
Vouchers view

This screenshot shows how the details will be displayed for the given discount voucher.

Dashboard view
CSV File Template

Import_discount_vouchers_into_campaign.CSV

Add gift cards to a campaign

You can import the following fields for gift cards into a specific campaign:

Reference Field Definition
A
Code
*required		 A unique gift card code.
B
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.
C
Gift Amount The initial gift card balance.
D
Category A custom tag for the gift card to help you filter codes.
E
Redeemed Quantity The number of times the gift card was redeemed.
F
Redeemed Amount The amount that has been redeemed from the available balance on the gift card.
G
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.
CSV example
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.

Gift Card in Voucher List View
Gift Card in Vouchers view

This screenshot shows how the details will be displayed for the given gift card.

Gift Card View
Dashboard layout for given gift card
CSV File Template

Import_gift_cards_into_campaign.CSV

Customers

You can import the following fields into Voucherify for Customers:

Reference Field Definition
A
ID The unique identifier assigned to a specific customer within the system.
B
Name Customer's first and last name.
C
Source_id

Custom unique customer ID; for example, a customer ID stored in your CRM database that will help you easily identify this customer.

Please note that if you would like your data to sync based on the 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.
D
Description Any additional information you would like to store about the customer.
E
Email Customer's email address.
F
Phone Customer's phone number.
G
Address_line_1 Address line
H
Address_line_2 Address line
I
City City
J
Postal Code Postal code
K
State State
L
Country Country
M
Birthdate Customer's birthdate; format:  YYYY-MM-DD
N
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.
CSV example
A B C D E F G H I J K L M
Name Source_id Description Email Phone Adress_line_1 Adress_line_2 City Postal_Code State Country Birthdate favorite_brands
John Smith test-user@voucherify.io A good customer. test-user@voucherify.io 1 (989) 123-4632 100 Main St Blg 2 Apt 3 New York 12345 New York United States 2022-07-03 "Nike, Fenty, Reebok"

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.

Customer Dashboard Screenshot
Dashboard layout
CSV File Template

Import_customers.CSV

Products

You can import the following fields into Voucherify for Products:

Reference Field Definition
A
Name
*required		 Product name
B
Source ID Custom unique product ID; for example, a product ID stored in your CRM database that will help you easily identify this product.
C
Price Product price
D
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".
E
Image URL The HTTPS URL pointing to the .png or .jpg file.
F
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.
CSV example
A B C D E F
name source_id price attributes image_url Metadata_property_name
Shirts productSourceID11 21 "color,size,ranking" https://images.com/original.jpg 2000-01-01T10:00:00.000Z

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.

Product Dashboard Screenshot
Dashboard layout
CSV File Template

Import_products.CSV

SKUs

You can import the following fields into Voucherify for SKUs:

Reference Field Definition
A
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.
B
SKU The name of the given SKU.
C
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.
D
Price The SKU price.
E
Image URL The HTTPS URL pointing to a .png or .jpg file.
F
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}".
CSV example
A B C D E F
product_id sku source_id price image_url attributes
productSourceID11 Extra Small Blue Shirt sku_source_id_1 13 https://images.com/blue-extra-small.jpg "{'color':'blue','size':'XS','ranking':1}"
productSourceID11 Small Red Shirt sku_source_id_2 14 https://images.com/red-small.jpg "{'color':'red','size':'S','ranking':2}"
productSourceID11 Medium Yellow Shirt sku_source_id_3 14.50 https://images.com/yellow-medium.jpg "{'color':'yellow','size':'M','ranking':3}"
productSourceID11 Large Pink Shirt sku_source_id_4 17 https://images.com/pink-large.jpg "{'color':'pink','size':'L','ranking':4}"

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.

SKU Dashboard Screenshot
Dashboard layout
CSV File Template

Import_skus.CSV

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us