Files format

The entire format is represented as an .zip archive containing the following files
The maximum file size is set to 250 MB.
products.csv - the product data
multimedia.csv - the multimedia resources
categories.csv - the categories
category_trees.csv - the category trees
category_trees_elements.csv - the category trees configuration
multimedia_folders.csv - the multimedia folders
attributes.csv - the attributes
options.csv - the collection attributes options
templates.csv - the templates
templates_elements.csv - the templates configuration
section_templates.csv - the section templates
section_templates_elements.csv - the section templates configuration
Columns are separated using ","(comma) separator.
Files should be UTF-8 formatted.
The files are placed in the archive as top-level entities.
Those should not be placed in a subdirectory within the archive - an often mistake for MacOs users - when using right-click menu on a directory containing files and using the option Compress "directory" which does just that.
products.csv
multimedia.csv
categories.csv
multimedia_folders.csv
attributes.csv
options.csv
templates.csv
templates_elements.csv
section_templates.csv
section_templates_elements.csv
category_trees.csv
category_trees_elements.csv
column
required
limitation
_sku
​✅
​
Max length of 255 chars.
_template
​✅
​
Only existing template codes.
_type
​✅
​
One of {SIMPLE-PRODUCT, GROUPING-PRODUCT, VARIABLE-PRODUCT}
_language
​✅
 if attribute values columns present
5 chars LCID language code. Example: pl_PL
_children
​
Applies for grouping and variable product types. Only existing SKUs. In case of grouping producs SKU will be miltiplied x quantity.
_bindings
​
Applies for variable product type only. Only existing attribute codes.
_categories
​
Only existsing category codes.
attribute_code(!)
​
Column name represents existing attribute code. Value should be valid according to given attribute type.
​
Example:
_sku
_template
_language
_type
_children
_bindings
_categories
text_attribute
textarea_attribute
numeric_attribute
price_attribute
unit_attribute
date_attribute
select_attribute
multiselect_attribute
image_attribute
gallery_attribute
file_attribute
product_relation_attribute
sku_with_variants
template_code
en_GB
VARIABLE-PRODUCT
"sku_simple1,sku_simple2"
product_size
"category1,category2"
text1
textarea1
-1
1
1
2022-01-25
option1
"option1,option2"
folder/multimedia.jpg
folder/multimedia.jpg,multimedia2.jpg
docs.pdf
​
sku_simple1
template_code
en_GB
SIMPLE-PRODUCT
​
​
​
text2
textarea2
-2
2
2
25-01-2022
option1
"option1,option2"
folder/multimedia.jpg
folder/multimedia.jpg,multimedia2.jpg
docs.pdf
"sku_with_variants,sku_simple2"
sku_simple2
template_code
en_GB
SIMPLE-PRODUCT
​
​
​
text3
textarea3
3
3
-3
2022-01-25 12:00:00
option1
"option1,option2"
folder/multimedia.jpg
folder/multimedia.jpg,multimedia2.jpg
docs.pdf
​
sku_grouping
template_code
en_GB
GROUPING-PRODUCT
"sku_with_variants,sku_simple1"
​
​
text4
textarea4
4
4
-4
2022-01-25
option1
"option1,option2"
folder/multimedia.jpg
folder/multimedia.jpg,multimedia2.jpg
docs.pdf
​
column
required
limitation
_name
​✅
​
Max length of 128 chars. Only existing folders(if given). Name has to contain a matching MIME type extension.
_url
​✅
​
URL from multimedia can be downloaded from. Download happen only once on multimedia creation.
_language
​✅
 if _alt column present
5 chars LCID language code. Example: pl_PL
_alt
​
Max length of 128 chars.
_title
​
Max length of 100 chars.
​
Example:
_name
_url
_language
_alt
filename.jpg
www.ergonode.com/image1.jpg
en_GB
alternative text
folder/filename.jpg
www.ergonode.com/image2.jpeg
en_GB
tekst alternatywny
column
required
limitation
_code
​✅
​
Max length of 128 chars. Lowercased, alphanumerical and "_" signes are accepted.
_name
​
Max length of 255 chars. 
_language
​✅
 if _name column present
5 chars LCID language code. Example: pl_PL
attribute_code(!)
​
Column name represents existing attribute code. Value should be valid according to given attribute type.
​
Example:
_code
_name
_language
text_attribute
textarea_attribute
numeric_attribute
price_attribute
unit_attribute
date_attribute
select_attribute
multiselect_attribute
image_attribute
gallery_attribute
file_attribute
product_relation_attribute
category
category one
en_GB
text1
textarea1
-1
1
1
2022-11-09
option1
"option1,option2"
folder/multimedia.jpg
folder/multimedia.jpg,multimedia2.jpg
docs.pdf
"sku_with_variants,sku_simple2"
category
pierwsze kategoria
pl_PL
text2
textarea2
2
2
-2
09-11-2022
option2
option1
folder/multimedia.jpg
folder/multimedia.jpg,multimedia2.jpg
docs.pdf
​
column
required
limitation
_name
​✅
​
Max length of 255 chars.
​
Example:
_name
folder_one
folder_two
column
required
limitation
_code
​✅
​
Max length of 128 chars. Lowercased, alphanumerical and "_" signes are accepted.
_type
​✅
​
One of {TEXT, TEXTAREA, NUMERIC, PRICE, UNIT, DATE, SELECT, MULTI_SELECT, IMAGE, GALLERY, FILE, PRODUCT_RELATION}
_scope
​✅
​
One of {LOCAL, GLOBAL}
_language
​✅
if one of _name, _hint or _placeholder columns present
5 chars LCID language code. Example: pl_PL
_name
​
Max length of 255 chars. Lowercased, alphanumerical and "_" signes are accepted.
_hint
​
Max length of 4000 chars. Lowercased, alphanumerical and "_" signes are accepted.
format
​✅
 if _type column is DATE
One of existing date formats.
currency
​✅
 if _type column is PRICE
One of existing Currencies.
rich_edit
​✅
 if _type column is TEXTAREA
One of {true, false}
unit
​✅
 if _type column is UNIT
One of existing Units.
​
Example:
_code
_type
_scope
_language
_name
format
currency
rich-edit
unit
text
TEXT
LOCAL
en_GB
text
​
​
​
​
textarea
TEXTAREA
GLOBAL
en_GB
textarea
​
​
true
​
numeric
NUMERIC
LOCAL
en_GB
numeric
​
​
​
​
price
PRICE
GLOBAL
en_GB
price
​
PLN
​
​
unit
UNIT
LOCAL
en_GB
unit
​
​
​
m
data
DATE
GLOBAL
en_GB
date
yyyy-MM-dd
​
​
​
select
SELECT
LOCAL
en_GB
select
​
​
​
​
multiselect
MULTI_SELECT
GLOBAL
en_GB
multiselect
​
​
​
​
image
IMAGE
LOCAL
en_GB
image
​
​
​
​
gallery
GALLERY
GLOBAL
en_GB
gallery
​
​
​
​
file
FILE
LOCAL
en_GB
file
​
​
​
​
product_relation
PRODUCT_RELATION
GLOBAL
en_GB
product relation
​
​
​
​
column
required
limitation
_code
​✅
​
Max length of 128 chars. Lowercased, alphanumerical and "_" signes are accepted.
_attribute
​✅
​
Applies for select and multiselect attribute types only. Only existsing attribute codes.
_language
​✅
if _name column present
5 chars LCID language code. Example: pl_PL
_label (⚠
 deprecated - duplicates _name column)
​
Max length of 255 chars.
_name
​
Max length of 255 chars.
​
Example:
_code
_attribute
_name
_language
select
select
name
en_GB
multiselect
multiselect
name
en_GB
​
column
required
limitation
_code
​✅
​
Max length of 128 chars.
_name
​
​
​
​
Example:
_code
_name
code
name
column
required
limitation
_name
​✅
​
One of existing Templates.
_code
​
One of existing Templates.
_type
​✅
​
One of {attribute, ui, section}
_x
​✅
​
Numeric value 0-3.
_y
​✅
​
Positive numeric value.
_width
​✅
​
Numeric value 1-4.
_height
​✅
​
Numeric value 1-10.
attribute
​✅
 if _type column is attribute
One of existing Attributes.
require
​✅
 if _type column is attribute
One of {true, false}
label
​✅
 if _type column is ui
Max length of 255 chars.
section
​
One of existing Section templates.
column
required
limitation
_code
​✅
​
Max length of 128 chars.
​
Example:
_code
code
​
column
required
limitation
_code
​✅
​
One of existing Section Templates.
_type
​✅
​
One of {attribute, ui}
_x
​✅
​
Numeric value 0-3.
_y
​✅
​
Positive numeric value.
_width
​✅
​
Numeric value 1-4.
_height
​✅
​
Numeric value 1-10.
attribute
​✅
 if _type column is attribute
One of existing Attributes.
require
​✅
 if _type column is attribute
One of {true, false}
label
​✅
 if _type column is ui
Max length of 255 chars.
column
required
limitation
_code
​✅
​
Max length of 64 chars.
_name
​
Max length of 255 chars.
_language
​✅
if _name column present
5 chars LCID language code. Example: pl_PL
​
Example:
_code
_name
_language
category_tree_1
Category tree one
en_GB
category_tree_2
Category tree two
en_GB
column
required
limitation
_code
​✅
​
One of existing Category Trees.
_parent
​
One of existing Categories.
_category
​✅
​
One of existing Categories.
​
Example:
_code
_parent
_category
category_tree_1
​
category_root
category_tree_1
category_root
category_child
​
​
​

column	required	limitation
_sku	✅	Max length of 255 chars.
_template	✅	Only existing template codes.
_type	✅	One of {`SIMPLE-PRODUCT`, `GROUPING-PRODUCT`, `VARIABLE-PRODUCT`}
_language	✅ if attribute values columns present	5 chars LCID language code. Example: `pl_PL`
_children		Applies for grouping and variable product types. Only existing SKUs. In case of grouping producs SKU will be miltiplied x quantity.
_bindings		Applies for variable product type only. Only existing attribute codes.
_categories		Only existsing category codes.
attribute_code(!)		Column name represents existing attribute code. Value should be valid according to given attribute type.

_sku	_template	_language	_type	_children	_bindings	_categories	text_attribute	textarea_attribute	numeric_attribute	price_attribute	unit_attribute	date_attribute	select_attribute	multiselect_attribute	image_attribute	gallery_attribute	file_attribute	product_relation_attribute
sku_with_variants	template_code	en_GB	VARIABLE-PRODUCT	"sku_simple1,sku_simple2"	product_size	"category1,category2"	text1	textarea1	-1	1	1	2022-01-25	option1	"option1,option2"	folder/multimedia.jpg	folder/multimedia.jpg,multimedia2.jpg	docs.pdf
sku_simple1	template_code	en_GB	SIMPLE-PRODUCT				text2	textarea2	-2	2	2	25-01-2022	option1	"option1,option2"	folder/multimedia.jpg	folder/multimedia.jpg,multimedia2.jpg	docs.pdf	"sku_with_variants,sku_simple2"
sku_simple2	template_code	en_GB	SIMPLE-PRODUCT				text3	textarea3	3	3	-3	2022-01-25 12:00:00	option1	"option1,option2"	folder/multimedia.jpg	folder/multimedia.jpg,multimedia2.jpg	docs.pdf
sku_grouping	template_code	en_GB	GROUPING-PRODUCT	"sku_with_variants,sku_simple1"			text4	textarea4	4	4	-4	2022-01-25	option1	"option1,option2"	folder/multimedia.jpg	folder/multimedia.jpg,multimedia2.jpg	docs.pdf

column	required	limitation
_name	✅	Max length of 128 chars. Only existing folders(if given). Name has to contain a matching MIME type extension.
_url	✅	URL from multimedia can be downloaded from. Download happen only once on multimedia creation.
_language	✅ if `_alt` column present	5 chars LCID language code. Example: `pl_PL`
_alt		Max length of 128 chars.
_title		Max length of 100 chars.

_name	_url	_language	_alt
filename.jpg	www.ergonode.com/image1.jpg	en_GB	alternative text
folder/filename.jpg	www.ergonode.com/image2.jpeg	en_GB	tekst alternatywny

column	required	limitation
_code	✅	Max length of 128 chars. Lowercased, alphanumerical and "_" signes are accepted.
_name		Max length of 255 chars.
_language	✅ if `_name` column present	5 chars LCID language code. Example: `pl_PL`
attribute_code(!)		Column name represents existing attribute code. Value should be valid according to given attribute type.

_code	_name	_language	text_attribute	textarea_attribute	numeric_attribute	price_attribute	unit_attribute	date_attribute	select_attribute	multiselect_attribute	image_attribute	gallery_attribute	file_attribute	product_relation_attribute
category	category one	en_GB	text1	textarea1	-1	1	1	2022-11-09	option1	"option1,option2"	folder/multimedia.jpg	folder/multimedia.jpg,multimedia2.jpg	docs.pdf	"sku_with_variants,sku_simple2"
category	pierwsze kategoria	pl_PL	text2	textarea2	2	2	-2	09-11-2022	option2	option1	folder/multimedia.jpg	folder/multimedia.jpg,multimedia2.jpg	docs.pdf

column	required	limitation
_name	✅	Max length of 255 chars.

_name
folder_one
folder_two

column	required	limitation
_code	✅	Max length of 128 chars. Lowercased, alphanumerical and "_" signes are accepted.
_type	✅	One of {`TEXT`, `TEXTAREA`, `NUMERIC`, `PRICE`, `UNIT`, `DATE`, `SELECT`, `MULTI_SELECT`, `IMAGE`, `GALLERY`, `FILE`, `PRODUCT_RELATION`}
_scope	✅	One of {`LOCAL`, `GLOBAL`}
_language	✅ if one of `_name`, `_hint` or `_placeholder` columns present	5 chars LCID language code. Example: `pl_PL`
_name		Max length of 255 chars. Lowercased, alphanumerical and "_" signes are accepted.
_hint		Max length of 4000 chars. Lowercased, alphanumerical and "_" signes are accepted.
format	✅ if `_type` column is DATE	One of existing date formats.
currency	✅ if `_type` column is PRICE	One of existing Currencies.
rich_edit	✅ if `_type` column is TEXTAREA	One of {`true`, `false`}
unit	✅ if `_type` column is UNIT	One of existing Units.

_code	_type	_scope	_language	_name	format	currency	rich-edit	unit
text	TEXT	LOCAL	en_GB	text
textarea	TEXTAREA	GLOBAL	en_GB	textarea			true
numeric	NUMERIC	LOCAL	en_GB	numeric
price	PRICE	GLOBAL	en_GB	price		PLN
unit	UNIT	LOCAL	en_GB	unit				m
data	DATE	GLOBAL	en_GB	date	yyyy-MM-dd
select	SELECT	LOCAL	en_GB	select
multiselect	MULTI_SELECT	GLOBAL	en_GB	multiselect
image	IMAGE	LOCAL	en_GB	image
gallery	GALLERY	GLOBAL	en_GB	gallery
file	FILE	LOCAL	en_GB	file
product_relation	PRODUCT_RELATION	GLOBAL	en_GB	product relation

column	required	limitation
_code	✅	Max length of 128 chars. Lowercased, alphanumerical and "_" signes are accepted.
_attribute	✅	Applies for select and multiselect attribute types only. Only existsing attribute codes.
_language	✅ if `_name` column present	5 chars LCID language code. Example: `pl_PL`
_label ( ⚠ deprecated - duplicates _name column)		Max length of 255 chars.
_name		Max length of 255 chars.

_code	_attribute	_name	_language
select	select	name	en_GB
multiselect	multiselect	name	en_GB

column	required	limitation
_code	✅	Max length of 128 chars.
_name

_code	_name
code	name

column	required	limitation
_name	✅	One of existing Templates.
_code		One of existing Templates.
_type	✅	One of {`attribute`, `ui`, `section`}
_x	✅	Numeric value 0-3.
_y	✅	Positive numeric value.
_width	✅	Numeric value 1-4.
_height	✅	Numeric value 1-10.
attribute	✅ if `_type` column is `attribute`	One of existing Attributes.
require	✅ if `_type` column is `attribute`	One of {`true`, `false`}
label	✅ if `_type` column is `ui`	Max length of 255 chars.
section		One of existing Section templates.

column	required	limitation
_code	✅	Max length of 128 chars.

_code
code

column	required	limitation
_code	✅	One of existing Section Templates.
_type	✅	One of {`attribute`, `ui`}
_x	✅	Numeric value 0-3.
_y	✅	Positive numeric value.
_width	✅	Numeric value 1-4.
_height	✅	Numeric value 1-10.
attribute	✅ if `_type` column is `attribute`	One of existing Attributes.
require	✅ if `_type` column is `attribute`	One of {`true`, `false`}
label	✅ if `_type` column is `ui`	Max length of 255 chars.

column	required	limitation
_code	✅	Max length of 64 chars.
_name		Max length of 255 chars.
_language	✅ if `_name` column present	5 chars LCID language code. Example: `pl_PL`

_code	_name	_language
category_tree_1	Category tree one	en_GB
category_tree_2	Category tree two	en_GB

column	required	limitation
_code	✅	One of existing Category Trees.
_parent		One of existing Categories.
_category	✅	One of existing Categories.

_code	_parent	_category
category_tree_1		category_root
category_tree_1	category_root	category_child

Last modified 4d ago