CSV files
Visidea needs some files in order to provide recommendations:
- Items file
- Users file
- Interactions file
All the files must follow this format:
- UTF-8 encoded
- Rows are separated by \n
- Fields separated by semicolon ;
- Text fields included by double quote "
- Double quote in text fields are escaped by slash character \
- Column names in the first row
Items file
File structure:
item_id;code;mpn;ean;name;description;brand_id;brand_name;price;market_price;discount;page_ids;page_names;url;images;stock;gender;tags;attributes
- item_id: product id
- code: internal code or sku code
- mpn: manifacture part numbers separated by pipe caracter |
- ean: ean codes separated by pipe caracter |
- name: product name
- description: product description
- brand_id: brand id
- brand_name: brand name
- price: original price in euro (floating point format with no thousand separator)
- market_price: discounted price in euro (if there’s no discount use the original price)
- discount: discount in percent
- page_ids: array of pages/categories ids where the product is published separated by pipe caracter |
- page_names: array of pages/categories names where the product is published separated by pipe caracter |
- page_urls: array of pages/categories urls where the product is published separated by pipe caracter |
- url: url of the product detail page
- images: images urls separated by pipe caracter |
- stock: availability quantity of the product (put 0 if not published)
- gender: product gender (put one of this strings: Man / Woman / Unisex )
- tags: list of tags separated by pipe caracter |
- attributes: object of attributes in JSON format
Translated fields
To upload translations of product information to Visidea, append the following columns to the items file:
name_[lang];description_[lang];page_names_[lang];page_urls_[lang];url_[lang]
Where [lang] refers to the two-letter ISO code corresponding to the language of the translation.
- name_[lang]: The product name translated into the specified language.
- description_[lang]: The product description translated into the specified language.
- page_names_[lang]: A list of page or category names, in the specified language, where the product is featured. These should be separated by a pipe character (|).
- page_urls_[lang]: A list of URLs for the pages or categories where the product is featured, in the specified language, also separated by a pipe character (|).
- url_[lang]: The URL of the product in the specified language.
Users file
File structure:
user_id;email;name;surname;address;city;zip;state;country;sex;birthday
- user_id: user id
- email: user e-mail
- name: user nome
- surname: user surname
- address: user address
- city: user city
- zip: user zip
- state: user state
- country: user country (ISO 3166-1 alpha-2 format, example: US)
- sex: user sex
- birthday: user birthday
Interactions file
File structure:
user_id;item_id;action;timestamp
- user_id: user id
- item_id: item id
- action: action (put one of this strings: purchase / cart)
- timestamp: timestamp of the event (ISO 8601, example: 2022-03-22T09:27Z)