Get category tree

GET

/web-pages/draft/drafts/{draftId}/trees/{categoryNodeId}

Required scope: viskan:draft:read

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

Parameters

draftId string

Format: uuid

Identifier of the draft. A draft is a workspace that holds unpublished changes to web store content.

categoryNodeId string

Format: uuid

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

countryCode string

Country code (in ISO 3166-1 alpha-2 format) 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.category-tree.cyclic-dependency`	Cyclic dependency detected in category tree.
`web-pages.get-tree.category-not-found`	Could not find the category by ID.
`web-pages.get-tree.content-locale-id-is-exclusive-with-country-code-and-language-code`	Content locale ID is exclusive with country code and language code.
`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-invalid`	Specified country code is invalid.
`web-pages.get-tree.draft-not-found`	Draft not found.
`web-pages.get-tree.language-code-invalid`	Specified language code is invalid.
`web-pages.get-tree.start-page-category-not-found`	Start page category for the web store was not found.
`web-pages.get-tree.web-store-not-found`	Web store specified on the selected draft was not found.