v1

latestOpenAPI 3.0.32026-07-173196215.4 KB

Get a category

Get category information for the specified categoryId or category path for example, /v1/categories/20204 or /v1/categories/women/clothing.

get/v1/categories/{category}

Path parameters

categorystring required

Query parameters

format'tree' | 'list'

The format determines whether the categories should be returned as a tree (nested lists) or a flattened list.

showHiddenboolean

Include hidden categories in the result.

depthinteger

Example:3

The number of nested categories to include in the response. If not defined the depth defaults to infinite.

withstring[]

The with parameter can be applied to include related resources, for example, the parents of a category can be attached using with=parents, and multiple includes are separated by commas, e.g. with=parents,children.

Include	includes
parents	includes all ancestors of the category
children	includes all descendants of the category, which are available as children on each node; depth can be modified using the depth parameter
properties:name(property)	retrieves only selected properties

[
  "parents,children"
]

localestring

Use enabled locale instead of default locale e.g. ?locale=de_DE.

Response

successful operation

idinteger required

The unique identifier of the category.

pathstring required

The slugs for all rootlineIds combined with / (e.g., /women/fashion).

namestring required

The name of the category

slugstring required

A short string to describe the current category (usable, for example, in URLs as).

parentIdinteger required

The parent category ID (root-level categories have a parent ID of 0)

rootlineIdsinteger[] required

The IDs for the path from the topmost root category to the current category, which is included as the last item.

childrenIdsinteger[] required

The child category IDs attached to the current category

isHiddenboolean required

A flag that defines if a category should be displayed by the frontend

depthinteger required

The nesting level of the category (root-level depth = 1, child nodes = 2, child nodes' children = 3, etc.)

supportedFilterstring[] required

A list of filters that can be used for filtering products in the category

shopLevelCustomDataobject required

Additional category data defined on the shop level

countryLevelCustomDataobject

Additional category data defined on the country level