Get a category tree

GET

/web-pages/page/trees/{categoryNodeId}

Required scope: webpage:read

Returns the hierarchical category tree from a specific category that will be seen as the root of the tree.

Parameters

categoryNodeId string

Format: uuid

ID of a category. Retrieves the tree starting from this category as root.

countryCode string

Country code to retrieve the categories' paths for. This or contentLocaleId must be provided.

languageCode string

Language code (in ISO 639-1 format) to retrieve the categories' paths for. This or contentLocaleId must be provided.

contentLocaleId string

The content locale to retrieve the categories' paths for. This or countryCode and languageCode combination must be provided.

The hierarchical category tree is successfully retrieved.

Error code	Description
`web-pages.get-tree.category-not-found`	Could not find the category by ID.
`web-pages.get-tree.category-tree-not-found`	Could not find the category tree for the web store.
`web-pages.get-tree.content-locale-id-is-exclusive-with-country-code-and-language-code`	Content locale ID was provided together with country code or language code, but they are mutually exclusive.
`web-pages.get-tree.content-locale-not-found`	Could not find the locale by ID or by country code and language code combination.
`web-pages.get-tree.country-code-required`	Country code is required.
`web-pages.get-tree.language-code-invalid`	Specified language code is invalid.