Navigation Tree

GET

Navigation tree requests are used to retrieve the navigation structure for the site, suitable to use for mobile navigation or top navigation on the site. The navigation content and structure returned in the request is set up and managed in the Experience App. There is no difference between GET and POST requests to this endpoint.

GET https://{cluster-id}.elevate-api.cloud/api/storefront/v3/queries/navigation-tree

Request

Request header parameters

Name	Description	Example
`Accept-Encoding`	Allows responses to be compressed using Gzip.	`gzip`

Request query parameters

Name	Description	Example
`customerKey`*	A key that uniquely identifies the current visitor. Using UUIDs as keys are recommended. This field is required unless `userContext` is set to `ANONYMOUS` or `UNPERSONALIZED` in which case it is not allowed. If `userContext` is set to `SYNTHETIC` this is optional.	`0b05119e-eeb8-418a-bbfb-defa0dde417e`
`locale`*	The visitor locale. Must match an available locale identifier on the current market in the data feed.	`en-GB`
`market`*	The visitor market identifier. Must match the corresponding market identifier in the data feed.	`UK`
`sessionKey`*	A unique key, identifying the session. Using UUIDs as keys are recommended. This field is required unless `userContext` is set to `ANONYMOUS` in which case it is not allowed. If `userContext` is set to `SYNTHETIC` this is optional.	`0b05119e-eeb8-418a-bbfb-defa0dde417e`
`touchpoint`*	The visitor’s touchpoint. Supported values: `DESKTOP`, `MOBILE`.	`DESKTOP`
`channels`	Which channels to use. Valid values are `ONLINE` and `STORE`. Multiple values are provided with a pipe, `\|`, as a separator. channels will default to `ONLINE\|STORE` if nothing is provided. If `STORE` is explicitly provided then stores cannot be empty. Supported values: `ONLINE`, `STORE`.	`ONLINE`
`notify`	A boolean that can be used to disable notifications and behavioural registration for the query. May not be combined with any userContext. You are recommended to set an appropriate userContext instead.	`false`
`priceId`	A custom price identifier that determines which price is used throughout the response. Must match a supplied custom price identifier in the data feed. When set, all product prices (selling price, list price etc.), price filtering, and price-based sorting will use this price instead of the standard prices.	`VIP`
`stores`	Which stores to use. Will impact which stock is displayed and which stock is used for filtering/ranking together with channel. Multiple values are provided with a pipe, `\|`, as a separator. Each store must match a supplied store key in the data feed.	`240\|100`
`userContext`	Specifies the level of consent for data tracking. Can also be used to flag requests as synthetic to not contribute to statistics. If omitted, the request will be treated as if PERSONALIZED is used. See user context for more details. Supported values: `PERSONALIZED`, `UNPERSONALIZED`, `ANONYMOUS`, `SYNTHETIC`.	`PERSONALIZED`
`viewId`	A parameter that is used to show the page in either production or preview mode. Can be `production` or `preview`. Defaults to `production` if omitted in the query. For more information, see App Integration. Supported values: `PRODUCTION`, `PREVIEW`.	`PRODUCTION`

Example request

bash

curl -i \
-X GET \
-H 'Accept-Encoding: null' \
"https://{cluster-id}.elevate-api.cloud/api/storefront/v3/queries/navigation-tree?customerKey=customerKey&locale=locale&market=market&sessionKey=sessionKey&touchpoint=touchpoint&channels=channels&notify=notify&priceId=priceId&stores=stores&userContext=userContext&viewId=viewId"

Response

Response codes

Status	Description
`200`	Query accepted, content flattened and serialised to JSON.
`400`	Invalid or missing required arguments.
`404`	Endpoint is not valid.
`503`	Service unavailable, no products found in the cluster.
`500`	Server error such as cluster unavailable or busy. The response body may contain more information about the error.

Example response

{
  "tree" : {
    "children" : [ null ],
    "count" : 5,
    "customData" : {
      "highlight" : "true",
      "viewableFrom" : "2010-10-20 00:00:00"
    },
    "expandable" : true,
    "iconPath" : "/resources/images/navigation/spring_node.jpg",
    "label" : "All products",
    "link" : "/springselections",
    "path" : "/",
    "selected" : false,
    "type" : "PRODUCT"
  }
}

Response body schema

NavigationTreeResult

The object representation of a navigation tree structure.

Name	Type	Description
tree	NavigationTreeNode	The root node of the navigation structure.

POST

POST https://{cluster-id}.elevate-api.cloud/api/storefront/v3/queries/navigation-tree

Request

Request header parameters

Name	Description	Example
`Accept-Encoding`	Allows responses to be compressed using Gzip.	`gzip`

Request query parameters

Name	Description	Example
`customerKey`*	A key that uniquely identifies the current visitor. Using UUIDs as keys are recommended. This field is required unless `userContext` is set to `ANONYMOUS` or `UNPERSONALIZED` in which case it is not allowed. If `userContext` is set to `SYNTHETIC` this is optional.	`0b05119e-eeb8-418a-bbfb-defa0dde417e`
`locale`*	The visitor locale. Must match an available locale identifier on the current market in the data feed.	`en-GB`
`market`*	The visitor market identifier. Must match the corresponding market identifier in the data feed.	`UK`
`sessionKey`*	A unique key, identifying the session. Using UUIDs as keys are recommended. This field is required unless `userContext` is set to `ANONYMOUS` in which case it is not allowed. If `userContext` is set to `SYNTHETIC` this is optional.	`0b05119e-eeb8-418a-bbfb-defa0dde417e`
`touchpoint`*	The visitor’s touchpoint. Supported values: `DESKTOP`, `MOBILE`.	`DESKTOP`
`channels`	Which channels to use. Valid values are `ONLINE` and `STORE`. Multiple values are provided with a pipe, `\|`, as a separator. channels will default to `ONLINE\|STORE` if nothing is provided. If `STORE` is explicitly provided then stores cannot be empty. Supported values: `ONLINE`, `STORE`.	`ONLINE`
`notify`	A boolean that can be used to disable notifications and behavioural registration for the query. May not be combined with any userContext. You are recommended to set an appropriate userContext instead.	`false`
`priceId`	A custom price identifier that determines which price is used throughout the response. Must match a supplied custom price identifier in the data feed. When set, all product prices (selling price, list price etc.), price filtering, and price-based sorting will use this price instead of the standard prices.	`VIP`
`stores`	Which stores to use. Will impact which stock is displayed and which stock is used for filtering/ranking together with channel. Multiple values are provided with a pipe, `\|`, as a separator. Each store must match a supplied store key in the data feed.	`240\|100`
`userContext`	Specifies the level of consent for data tracking. Can also be used to flag requests as synthetic to not contribute to statistics. If omitted, the request will be treated as if PERSONALIZED is used. See user context for more details. Supported values: `PERSONALIZED`, `UNPERSONALIZED`, `ANONYMOUS`, `SYNTHETIC`.	`PERSONALIZED`
`viewId`	A parameter that is used to show the page in either production or preview mode. Can be `production` or `preview`. Defaults to `production` if omitted in the query. For more information, see App Integration. Supported values: `PRODUCTION`, `PREVIEW`.	`PRODUCTION`

Example request

bash

curl -i \
-X POST \
-H 'Accept-Encoding: null' \
"https://{cluster-id}.elevate-api.cloud/api/storefront/v3/queries/navigation-tree?customerKey=customerKey&locale=locale&market=market&sessionKey=sessionKey&touchpoint=touchpoint&channels=channels&notify=notify&priceId=priceId&stores=stores&userContext=userContext&viewId=viewId"

Response

Response codes

Status	Description
`200`	Query accepted, content flattened and serialised to JSON.
`400`	Invalid or missing required arguments.
`404`	Endpoint is not valid.
`503`	Service unavailable, no products found in the cluster.
`500`	Server error such as cluster unavailable or busy. The response body may contain more information about the error.

Example response

{
  "tree" : {
    "children" : [ null ],
    "count" : 5,
    "customData" : {
      "highlight" : "true",
      "viewableFrom" : "2010-10-20 00:00:00"
    },
    "expandable" : true,
    "iconPath" : "/resources/images/navigation/spring_node.jpg",
    "label" : "All products",
    "link" : "/springselections",
    "path" : "/",
    "selected" : false,
    "type" : "PRODUCT"
  }
}

Response body schema

NavigationTreeResult

The object representation of a navigation tree structure.

Name	Type	Description
tree	NavigationTreeNode	The root node of the navigation structure.

Inner Schemas

NavigationTreeNode

The object representation of the navigation node.

Name	Type	Description
children	NavigationTreeNode[]	A list of NavigationNode children of the current node.
count	integer	The number of product groups in the node. Examples: `5`
customData	<string, string>	A key-value mapping of custom data associated with this page as defined in the navigation import. Examples: `{"highlight":"true","viewableFrom":"2010-10-20 00:00:00"}`
expandable	boolean	Indicates that this node can be expanded, e.g. a request with this node as selected will return children under this node. Examples: `true`
iconPath	string	The path to the image used as this node’s icon, if any. Examples: `"/resources/images/navigation/spring_node.jpg"`
label	string	The presentation text for the node. Examples: `"All products"`
link	string	Link to page, will only by populated if type is PAGE_LINK Examples: `"/springselections"`
path	string	The path to the node. Examples: `"/"`
selected	boolean	Identifies the node as selected in the tree. Examples: `false`
type	NavigationTreeNodeType	The type of node, used for separating visuals of different node types. Supported values: `PRODUCT`, `LABEL`, `PAGE_LINK`, `SPACER`. Examples: `"PAGE_LINK"`

NavigationTreeNodeType (enum)

Name	Description
PRODUCT	A node containing products, typically modifies a product listing on click.
LABEL	A node used for visually separating other navigation nodes.
PAGE_LINK	A node intended to takes the user to another page, does not have to contain products.
SPACER	A node used for adding spaces between other navigation nodes.

Overview

Admin

Storefront

GET

Request

Response

NavigationTreeResult

POST

Request

Response

NavigationTreeResult

Inner Schemas

NavigationTreeNode

NavigationTreeNodeType (enum)

​GET

​Request

​Response

​NavigationTreeResult

​POST

​Request

​Response

​NavigationTreeResult

​Inner Schemas

​NavigationTreeNode

​NavigationTreeNodeType (enum)

GET

Request

Response

NavigationTreeResult

POST

Request

Response

NavigationTreeResult

Inner Schemas

NavigationTreeNode

NavigationTreeNodeType (enum)