File details: category.csv

Last updated:
Edit on GitHub
You are browsing a previous version of the document. The latest version is 202307.0.

This document describes the category.csv file to configure categories in your Spryker shop.

Import file dependencies

category_template.csv.

Import file parameters

PARAMETER REQUIRED TYPE REQUIREMENTS OR COMMENTS DESCRIPTION
category_key ✓ String Unique. This value can set as parent_category_key for the following lines, allowing multi-level relations Category key identifier.
parent_category_key ✓ String Must have an existing value if the category is not the “root” category. Parent category key identifier.
name.{ANY_LOCALE_NAME}*
Example value: name.de_DE		 ✓ String Unique. Name of categories in available locations. The set of these fields depends on available locations in some projects. Category name in the specified location (DE for our example).
meta_title.{ANY_LOCALE_NAME}
Example value: meta_title.de_DE		 String Title in the specified location (DE for our example).
meta_description.{ANY_LOCALE_NAME}
Example value: meta_description.de_DE		 String Description in the specified location (DE for our example).
meta_keywords.{ANY_LOCALE_NAME}
Example value: meta_keywords.de_DE		 String Keywords in the specified location (DE for our example).
is_active Boolean True (1), if it is active. False (0), if it is not active. Indicates if the category is active or not.
is_in_menu Boolean True (1), if it is in the menu. False (0), if it is not in the menu. Indicates if the category is in the menu or not.
is_clickable Boolean True (1), if it is clickable. False (0), if it is not clickable. Indicates if the category is clickable or not.
is_searchable Boolean True (1), if it is searchable. False (0), if it is not searchable. Indicates if it is a searchable category in the menu or not.
is_root Boolean True (1), if it is root. False (0), if it is not root. Indicates if it is a root category or not.
is_main Boolean True (1), if it is main. False (0), if it is not main. Indicates if it is a main category or not.
node_order Integer Order of the category node.
template_name String Template name of the category.
category_image_name.{ANY_LOCALE_NAME} String Name of the image for the category in the locale.
Info

*ANY_LOCALE_NAME: Locale data is dynamic in data importers. It means that ANY_LOCALE_NAME postfix can be changed or removed, and any number of columns with different locales can be added to the CSV files. For the following fields, it can be replaced by two sets of fields: one for de_DE and another for en_US.

Import template file and content example

FILE DESCRIPTION
category.csv template Exemplary import file with headers only.
category.csv Exemplary import file with Demo Shop data.

Import command

data:import:category