Category Tree
It represents a hierarchical category list
Definition
A category tree represents a hierarchical category list. The category tree contains a principal node. This node can have multiple children. Each child is composed of the name and an array of localized names.
As the item schema, the category tree is versioned to be associated in a catalog.
Category Trees aren't mandatory unless you want to associate an item with a category.
Structure
Name | Type | Description |
---|---|---|
name | String | Name of the root node |
tenant | String | Tenant of the account |
environment | String | Environment to use |
version | Int | The version of the category tree - manage by the API |
localizedNames | List | List of objects providing available translations per locale:
|
children | List | list of CategoryTree Category |
The root name can't be 0
Localized Name Structure
Name | Type | Description |
---|---|---|
name | String | Name of the category |
locale | String | Based on the Java locale format <languagecode>_<countrycode>
|
CategoryTree Category
Name | Type | Description |
---|---|---|
name | String | Name of the root node |
localizedNames | List | List of objects providing available translations per locale:
|
children | List | list of CategoryTree Category |
Example
FHR data model validation
The query parameter fhrValidation=true can be added to enforce Fredhopper specific validation to the category API. This includes the following additional checks to the schema:
Category names (aka Category_ids) only contain the alphanumerical characters [a-z0-9]
Last updated