Navigation Object

Primary Object

{
  "results": [
    {
      "lang": "string",
      "navigation": [
        {
          "id": "string",
          "title": "string",
          "url": "string",
          "type": "PAGE|DYNAMIC_PAGE_TEMPLATE|EXTERNAL_PAGE|ANCHOR|FOLDER|DYNAMIC_NAVIGATION_ITEMS_PLACEHOLDER",
          "hidden": [
            "MOBILE",
            "TABLTET",
            "DESKTOP"
          ],
          "sub_navigation": [],
          "dynamic_navigation": {
            "type": "STORE_CATEGORIES|DYNAMIC_ITEMS",
            "collection_name": "string",
            "display_field": "string",
            "hidden": [
              "MOBILE",
              "TABLTET",
              "DESKTOP"
            ],
            "dynamic_navigation_parent": true
          },
          "parent_id": "string",
          "next_sibling_id": "string",
          "depth": 0
        }
      ]
    }
  ]
}

Property

Description

lang string

The language.

navigation
array of objects

The navigation.

navigation

Property

Description

id string

The unique identifier for the site navigation

title
string

The text of the navigation item. For page will be the page title (not applicable for DYNAMIC_NAVIGATION_ITEMS_PLACEHOLDER).

url
string

The URL of the navigation item (not applicable for DYNAMIC_NAVIGATION_ITEMS_PLACEHOLDER, FOLDER).

type
enum

One of: PAGE, DYNAMIC_PAGE_TEMPLATE, EXTERNAL_PAGE, ANCHOR, FOLDER, DYNAMIC_NAVIGATION_ITEMS_PLACEHOLDER.

hidden
array of enum

DESKTOP, TABLET, MOBILE.

sub_navigation
array of objects

Array of navigation items.

dynamic_navigation
object

The dynamic navigation object.

parent_id
string

The Id of the parent element. If an empty string, the item will be added to the top level of the navigation.

next_sibling_id
string

The Id of the next sibling element. If an empty string, the item will be added to the end of the navigation.

depth
int

The depth of the item in the navigation.

dynamic_navigation

Property

Description

is_dynamic_navigation_parent bool

Is the current navigation item the parent of dynamic navigation items.

type
enum

STORE_CATEGORIES, DYNAMIC_PAGE_ITEMS.

collection_name
string

The name of the collection powering the dynamic pages. Only applicable for DYNAMIC_PAGE_ITEMS.

display_field
string

The property within the collection powering the dynamic pages used to display the page name. Only applicable for DYNAMIC_PAGE_ITEMS.

hidden
array of enum

DESKTOP, TABLET, MOBILE.