During the initial setup, you must feed data from VTEX into Engage. This is a one-time effort. Once the data is in Engage and the integration is set up, new data will be added automatically. This article describes the process of downloading and preparing the data for this initial upload.

Procedure

A) Download CSV files from VTEX store

Place the files in one folder so you can process them more easily afterwards.

  1. Download the Products CSV file
    1. On your VTEX admin store page navigate to Catalog > All Products.
    2. Press the Click here link:
    3. Click Export/Import.
    4. Enter your email address in the Email for Notification field. Then click Export to Excel.
    5. Click the download link in the email that you receive.
    6. Once the file is downloaded, open it and save it as a .csv file.
  2. Download Product prices CSV file
    1. On your VTEX admin store page navigate to Catalog > Price List.
    2. Click the Export prices spreadsheet icon and select which table you want to export. Preferably, this should be the Table of computed prices. Deselect the others.
    3. Check the Include metadata in exported tables checkbox.
    4. Click Export table. You will receive an email with a download link.
    5. Download the file and save it as a .csv file.

      Make sure that the file name corresponds to the file name for products. This is needed so our converting script can locate that pricing file during conversion.

      Example

      If the name file from step 1 is:  products.csv ,
      then the name of the file in step 2 must be products-prices.csv.

  3. Download Orders CSV file
    1. On your VTEX admin store page navigate to Orders > All Orders.
    2. Clear all filters
    3. Click Export orders to e-mail.
    4. Click Export orders to e-mail again. You will receive an email with a download link.
    5. Download the file and unzip it. The extracted file is already in .csv format.
  4. On your VTEX master data page navigate to the Clientes tab.
    1. Click Exportar  XLS.
    2. Select all fields that need to be exported and click Exportar.
    3. A pop-up window appears. Click OK. You will receive an email with a download link.
    4. Download the file and unzip it. The extracted file is already in .csv format.

B) Prepare files for import into Mapp Engage

The script performs a conversion and provides us with a final CSV file which we can use to import data into Mapp Engage

  1. Download the script compatible with your system.
    1. Linuxvtmcsv-linux.zip
    2. Macvtmcsv-macos.zip
    3. Windows: vtmcsv-win.zip
  2. Unzip the content and place it next to the .csv files downloaded in point A of the procedure.
  3. Place all files and the script in one folder.
  4. Open Terminal (Linux & Mac) or Command Prompt (Windows).

  5. (optional) To see available options and descriptions, call the script with flag --help:
    1. Type in: cd Desktop/(name of the folder where the script is located) and press enter.
    2. In the same line, type in: vtmcsv.exe --help click and press enter. 
  6. Convert the files by calling the script ./vtmcsv {inputCSV} {outputCSV} {type} from terminal/Command Prompt. For example:

     Details
    VariableDescription
    inputCSV

    The location of the files downloaded from VTEX.

    outputCSVThe location where you want to store the converted file.
    type

    Type of conversion. The script allows conversion for:

    • users
    • orders, or
    • products

    The converted (output) files are placed in the same folder as the input files, and are ready for import into Mapp Engage.

Examples

Note that files must be in the same directory in order for the script to process them.

#FilesCall for Linux and MacCall for Windows
1

products.csv

products-prices.csv

./vtmcsv ./products.csv ./output_products.csv products./vtmcsv.csv ./products.csv ./output_products.csv products
2orders.csv./vtmcsv ./orders.csv ./output_orders.csv orders./vtmcsv.csv ./orders.csv ./output_orders.csv orders
3users.csv./vtmcsv ./users.csv ./output_users.csv users./vtmcsv.csv ./users.csv ./output_users.csv users

Related Topics