Documentation Home

Category Import

Categories can be imported into the admin either directly into production or into a user sandbox sandbox for review.

Adding vs Updating Categories

By default, when a CSV of categories is uploaded all of the categories defined within it are treated as brand new and there is no attempt to try to update existing categories. The exception is when categories are referenced either by their externalId or their primary key (id).

Field-based Columns

All other columns function just like what you see in the admin screen. The columns can be referenced by either the display name that you see in the admin (like 'Active Start Date') or by the field definition itself as declared in the entity definition itself (like 'activeStartDate').

Columns not tied to fields

Column name Description
media see Media Format
parentCategories See Category Relationship Format
childCategories See Category Relationship Format

Parent and Child Categories

Each of these columns takes either an externalId value or an id value. For instance, consider that I already have these values in my database for Category:

ID NAME EXTERNAL_ID
100 'Category 100' 'cat-100'
200 'Category 200' 'cat-200'

Either one of these category imports would be acceptable:

Name,URL,parentCategories,childCategories
Home,/,100|200,100|200
Name,URL,parentCategories,childCategories
Home,/,cat-100|cat-200,cat-100|cat-200