Category Paths

👍

Welcome note

Data hub is our new upgraded platform, which we rolled out in August 2025. It offers a single unified integration for passing your data through to your Bloomreach products.

You have access to Data hub if you've implemented with Bloomreach after August 2025.

Customers who have implemented before August 2025 should follow the existing documentation for Engagement, Discovery, and Clarity.

• Display Name: Category Paths

• System Name: category_paths

• Data Type: CategoryPaths

• Levels: Product

• Used By Apps: All

• Required By Apps: Discovery (when using Category Search)

Stores all categorical information about the product including category names,
identifiers, and the complete hierarchical category structure.

This single structured attribute powers category functionality across all Bloomreach
applications. At minimum, it requires one category with a name or ID in a single path.
For deeper categorization, you can provide parent categories to show hierarchy (like
"Home > Women's > Dresses"). For products in multiple categories, structure the
attribute with multiple paths.
The complexity adapts to your needs - use only what's required.
Schema Mapping handles standard categorization formats from flat files and source
systems automatically, or you can send data directly matching the CategoryPaths data
type specification.

Format

The attribute is an array of paths, where each path is an array of category objects
ordered from root to leaf:

• Each category object must have at least one of: name (display name) or id (unique
  identifier)

• Paths are ordered from root to leaf category

• Multiple paths represent products in multiple categories

• The first path is considered primary for level-based attributes

General Usage

Defines where products live in your category structure for navigation, filtering, and
merchandising across all applications.
Used for:

• Category pages and navigation

• Hierarchical filtering and faceting

• Breadcrumb navigation

• Category-based personalization and recommendations

Examples

Single Category with Name

[
    [
        {
            "name": "dresses"
        }
    ]
]

Common source format:

"category_name": "dresses"

Single Category with ID

[
    [
        {
            "id": "262"
        }
    ]
]

Common source format:

"category_id": "262"

Single Category with Name and ID

[
    [
        {
            "name": "dresses",
            "id": "262"
        }
    ]
]

Common source format:

"category_id": "262",
"category_name": "dresses"

Three-Level Hierarchy with Names Only

[
    [
        {
            "name": "home"
        },
        {
            "name": "womens"
        },
        {
            "name": "dresses"
        }
    ]
]

Common source format:

"category_names": "home > womens > dresses"

Three-Level Hierarchy with Names and IDs

[
    [
        {
            "name": "home",
            "id": "1"
        },
        {
            "name": "womens",
            "id": "2"
        },
        {
            "name": "dresses",
            "id": "262"
        }
    ]
]

Common source format:

"crumb_ids": "1 > 2 > 262",
"crumb_names": "home > womens > dresses"

Multiple Categories, No Hierarchy

[
    [
        {
            "name": "dresses"
        }
    ],
    [
        {
            "name": "on sale dresses"
        }
    ]
]

Common source format:

"category_names": "dresses;on sale dresses"

Multiple Categories with IDs

[
    [
        {
            "name": "dresses",
            "id": "262"
        }
    ],
    [
        {
            "name": "on sale dresses",
            "id": "2620"
        }
    ]
]

Common source format:

"category_names": "dresses;on sale dresses",
"category_ids": "262;2620"

Multiple Hierarchical Paths

[
    [
        {
            "name": "home",
            "id": "1"
        },
        {
            "name": "dresses",
            "id": "262"
        }
    ],
    [
        {
            "name": "home",
            "id": "1"
        },
        {
            "name": "on sale dresses",
            "id": "2620"
        }
    ]
]

Common source format:

"crumb_names": "home > dresses; home > on sale dresses",
"crumb_ids": "1 > 262; 1 > 2620"

Application Usage

Engagement

Reserved Attribute Names: category_ids, category_names, category_level_1
through category_level_n, category_path

Used for:

• Category-based segmentation and targeting

• Product categorization in recommendations

This system attribute is automatically translated into multiple reserved application
attributes:

• category_ids: List of leaf category IDs from all paths.
  If only names provided, uses names as IDs.

• category_names: List of leaf category names from all paths.

• category_level_1 through category_level_n: Name (or ID if name not present) of
  level 1 to N category.
  Derived only from the first path in the list.

• category_path: Full path of first category path names (or IDs if names not
  present) separated by pipe character.
  If pipe character is present in name or ID, it is replaced with empty string.

• category_paths: CategoryPaths object in JSON for free form use in Jinja
  templates to access complete categorical information.

Discovery

Reserved Attribute Name: category_paths

Used for:

• Hierarchical faceting in search results

• Category-based filtering and navigation

• Category search and management

Used for complex hierarchical faceting and filtering.
Required for Category Search functionality.

refers to category_paths

Feature Capabilities & Configuration

• Can be faceted and filtered on in Delivery APIs?

• Available to use in Variant/SKU-select use cases?
  NO.

• Available to use in facet management dashboard?

• Searchable by default?

• Facetable by default?

• Displayable by default?