navigation

List navigation trees

Navigation trees map to menus and sub-menus on the front-end. Each shop can be assigned one ore more navigation trees. This End-point retrieves the complete list of navigation trees that are created for a shop.

You can also get individual navigation trees with /v1/navigation/trees/{navigationTreeId}.

get/v1/navigation/trees

Query parameters

localestring

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

withstring[]

The with parameter can be applied to include category in the navigationItem lists using with=category.

Includeincludes
categoryincludes category as an object into the navigation-item

Response

request successful

idinteger required
keystring required
namestring required

Example response

[
  {
    "items": [
      {
        "type": "external",
        "category": {
          "path": "/women",
          "name": "Women",
          "slug": "women",
          "parentId": 20201,
          "properties": [
            {
              "name": "gender"
            }
          ],
          "depth": 2
        }
      }
    ]
  }
]

Changes