v1
latestOpenAPI 3.0.32026-07-173196215.4 KBList categories
Each product can be assigned to one or more shop categories in a hierarchical shop category tree.
You can use /categories to get all categories. By default the categories will be returned as a tree in it's hierarchical order. This can be changes with the format` parameter.
To retrieve only specific categories the ids parameter can be used e.g.: /categories?ids=123,456,789.
You can also get individual categories with /v1/categories/{categoryId} or /v1/categories/{categoryPath}.
Query parameters
Only include results with categoryId matching one of the specified ids
The format determines whether the categories should be returned as a tree (nested lists) or a flattened list.
Include hidden categories in the result.
The number of nested categories to include in the response. If not defined the depth defaults to infinite.
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" ]
Use enabled locale instead of default locale e.g. ?locale=de_DE.
Response
successful operation