Category data feed specifications

The category data feed is used to populate SEO-friendly category information to Sitecore Discover hosted category pages.

Attribute

Type

Description

Example

ccid

string

Required.

Customer category ID. Make sure ccid is included in the product feed).

cat123

name

string

Required.

Category name. Make sure name is included in the product feed).

Hunter Original Tall Rain Boots

url_path or page_url

string

Required.

Category page URL path. SEO friendly, full URL of the page that represents this category. Should not contain any query parameters. Any query parameters in this field will be ignored.

If not provided, Discover can generate it using the seo_name attribute.

/shoes/boots/Hunter-Womens-Original-Tall-Rain-Boots

parent_ccid

string

Optional.

The ID of the parent category. Used to determine hierarchy information. The highest level category has an empty value (no parent).

cat12

parent_ccids

string

Optional.

List of CCIDs of the parent category. Used to determine hierarchy information. The highest level category has an empty value (no parent).

Use a pipe separator ( | ) between ccids.

cat12|cat23|cat34

seo_name

string

Optional.

Category URL SEO name (SEO friendly) to use when synthesizing the category URL.

Also used to map the URL to a category by extracting a portion of the URL to match the seo_name attribute. In this case, the names must uniquely identify a category.

Hunter-Womens-Original-Tall-Rain-Boots

title

string.

Optional.

Category title to display in category pages (SEO friendly). If not provided, name is used.

Hunter Women's Original Tall Rain Boots

desc

string

Optional.

Category description to display under the title (SEO friendly). Format as text or as simple HTML snippet.

These are the best rubber boots you can buy!

meta_title

string

Optional.

Category page meta title (if different from category title) to include as part of the metadata on the page.

Hunter - Hunter Women's Original Tall Rain Boots - Company Name

meta_desc

string

Optional.

Category meta description to include in page metadata. If not provided, desc is used.

Free 2-day shipping. Buy Hunter Women's Original Tall Rain Boots at companyname.com

meta_keywords

string

Optional.

Category meta keywords to include in page metadata.

Free 2-day shipping. Buy Hunter Women's Original Tall Rain Boots at companyname.com

secondary_url_paths

string

Optional.

Additional list of URL paths.

breadcrumbs

string

Optional.

Category breadcrumb information (category>sub-category>...)

If not provided, uses category hierarchy information to generate the path.

Shoes>Womens Shoe>All Womens Shoes

image_url

string

Optional.

Category image/thumbnail URL

/pub/media/catalog/category/Hunter-Womens-Original-Tall-Rain-Boots.png

banner_url

string

Optional.

Category banner URL, to display a banner in the category pages.

To use dynamic banners or manage banners through the CEC, use content widgets.

/pub/media/catalog/category/Hunter-Womens-Original-Tall-Rain-Boots-banner.jpg

is_active

Boolean

Optional.

Flag to specify whether the category is active or not.

true (default)

is_primary

Boolean

Optional.

Flag to specify whether this category represents a primary or true product hierarchy, independent of other ways you might organize a set of products.

Default: true.

The following shows category camera, and sub-category dslr as primary category. Categories canon and nikon represent brands, and are not considered true (primary) categories.

/camera, is_primary = true

/camera/dslr, is_primary = true

/camera/dslr/canon, is_primary = false

/camera/dslr/nikon, is_primary = false

Do you have some feedback for us?

If you have suggestions for improving this article,