File Format - Category
Note: Catalogs must be created before sending product information.
Please refer here for details on catalog structure/hierarchy
Category File Format
The first line of a Category CSV file must be the header row.
A category instance is a group of rows in the CSV file that are sequential and include the same required fields. Data relating to fields specified under Base Headers and Multi-Column Headers must be specified in the first row of a category instance. Additional rows of a category instance may only include fields specified under Multi-Row Headers.
Required Headers
To successfully import a category CSV file, the following columns must be included in the header row:
| Column Name | Description | Type |
|---|---|---|
Category ID (Required) | Identification string for a category. Must be unique for every category | string |
Parent Category ID | ID of the parent category
| string |
Catalog ID | ID of the catalog this category belongs to | string |
Is Root(Required) | Whether or not this is a root category
| boolean |
Is Hidden (Required) | Whether or not this category is hidden | boolean |
Sort Order | Display order the app | integer |
Image (Required) | URL of an image to be used with this category | string |
Groups | May Be Required | See below |
Groups
A group is a class of headers that relate to one another, and may allow for multiple pieces of information to be presented. For example, a customer can have multiple emails, addresses, phone numbers, and more.
Category groups include:
Localized Data (Required)
There are two ways that localized data can be formatted in your CSV file: A Multi-Row Approach or Multi-Column Approach.
Multi-Row Approach
In this approach, one set of column headers is used alongside multiple rows of data. To allow for multiple rows of data, additional rows must include the same Required Headers fields.
Multi-Column Approach
In this approach, multiple sets of column headers may be used alongside one row (the first row) of a category instance. To use these columns multiple times, an identifying number must exist for N and be unique for every new set of columns.
Columns from the Multi-Row Approach cannot be mixed with columns from the Multi-Column Approach in a CSV file for the Localized Data group.
The following columns may be included:
| Multi-Row Approach Column Name | Multi-Column Approach Column Name | Description | Type |
|---|---|---|---|
Localized Description ID | Localized Description N | Description of the category localized to the specified language | string |
Localized Name | Localized Name N | Name of the category localized to the specified language | string |
Localized Language ID | Localized Language ID N | ID of the language in which the record appears. Integers will be resolved to internal identifiers | integer, string |
Where N is some positive integer.
Custom Attributes
There are two ways that custom attributes can be formatted in your CSV file: A Multi-Row Approach or Multi-Column Approach.
Multi-Row Approach
In this approach, one set of column headers is used alongside multiple rows of data. To allow for multiple rows of data, additional rows must include the same Required Headers fields.
Multi-Column Approach
In this approach, multiple sets of column headers may be used alongside one row (the first row) of a category instance. To use these columns multiple times, an identifying number must exist for N and be unique for every new set of columns.
Columns from the Multi-Row Approach cannot be mixed with columns from the Multi-Column Approach in a CSV file for the Custom Attributes group.
The following columns may be included:
| Multi-Row Approach Column Name | Multi-Column Approach Column Name | Description | Type |
|---|---|---|---|
Custom Attribute ID | Custom Attribute N ID | Identifier of the custom attribute | string |
Custom Attribute Value | Custom Attribute N Value | Value of the attribute | string |
Custom Attribute Language ID | Custom Attribute N Language ID | Language of the attribute. Integers will be resolved to internal identifiers | integer, string |
Where N is some positive integer.
Category CSV Example
See the following Category CSV sample file.