CategoryFieldName

Column identifiers recognised by the category CSV importer.

Each value identifies a category attribute that can be mapped to a column in the source spreadsheet so the import understands how to populate the catalogue.

enum CategoryFieldName {
  PARENT_SOURCE_ID
  PARENT_SOURCE_NAME
  PARENT_ID
  DEFAULT_LANGUAGE
  LANGUAGE
  NAME
  DESCRIPTION
  SHORT_DESCRIPTION
  METADATA_TITLE
  METADATA_DESCRIPTION
  METADATA_KEYWORDS
  METADATA_CANONICAL_URL
  SOURCE_NAME
  SOURCE_ID
  ID
  HIDDEN
  SLUG
}

Values

`CategoryFieldName.PARENT_SOURCE_ID`

[Optional][String] Identifier assigned to the parent category within its originating external system.

Supply together with the matching source name. Cannot be combined with the internal parent identifier column.

`CategoryFieldName.PARENT_SOURCE_NAME`

[Optional][String] Name of the external system that originated the parent category.

Supply together with the matching source identifier. Cannot be combined with the internal parent identifier column.

`CategoryFieldName.PARENT_ID`

[Optional][Integer] Internal identifier of the parent category.

Cannot be combined with the external source columns for the parent category.

`CategoryFieldName.DEFAULT_LANGUAGE`

[Required][String] Primary language for category content.

The default language code used when localized content is not available in the requested language. Determines fallback behavior for multilingual category display.

`CategoryFieldName.LANGUAGE`

[Required][String] Two-letter ISO 639-1 language code paired with the name, description and short description.

`CategoryFieldName.NAME`

[Required][String] Localized category names for display in different languages.

Collection of category names in various supported languages for international markets and multilingual storefronts. Falls back to the category's default language when specific language is not available.

Maximum length is 150 characters.

`CategoryFieldName.DESCRIPTION`

[Optional][String] Detailed category description with rich content support.

Comprehensive category information including features, purpose, and context. Supports HTML formatting for rich content display and can be translated for multilingual catalogs. Used for category pages and detailed product organization.

`CategoryFieldName.SHORT_DESCRIPTION`

[Optional][String] Brief category summary for listings and previews.

Concise category description suitable for navigation menus, category cards, and overview displays where space is limited. Supports HTML formatting and multilingual translation for consistent user experience.

`CategoryFieldName.METADATA_TITLE`

[Optional][String] SEO-optimized page title for search engines.

Localized title tag content used for search engine optimization and browser tab display. Should be concise, descriptive, and include relevant keywords for better search visibility.

`CategoryFieldName.METADATA_DESCRIPTION`

[Optional][String] SEO meta description for search engine results.

Localized meta description tag content that appears in search engine results pages. Should be compelling, informative, and within recommended character limits to improve click-through rates.

`CategoryFieldName.METADATA_KEYWORDS`

[Optional][String] SEO keywords for search engine optimization.

Localized meta keywords relevant to the category content. Used by search engines to understand category context and improve discoverability for relevant search queries.

`CategoryFieldName.METADATA_CANONICAL_URL`

[Optional][String] Canonical URL for duplicate content management.

Localized canonical URL that tells search engines which version of the category page is the authoritative source, preventing duplicate content issues and consolidating SEO value.