Skip to content

Navigation Tree

https://{cluster-id}.api.esales.apptus.cloud/api/storefront/v3/queries/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.

Request

Header parameters

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

Query parameters

Name Description Example
customerKey
Required
A key that uniquely identifies the current visitor.Using UUIDs as keys are recommended. 0b05119e-eeb8-418a-bbfb-defa0dde417e
locale
Required
The visitor locale. Must match an available locale identifier on the current market in the data feed.
market
Required
The visitor market identifier. Must match the corresponding market identifier in the data feed. UK
sessionKey
Required
A unique key, identifying the session.Using UUIDs as keys are recommended. 0b05119e-eeb8-418a-bbfb-defa0dde417e
touchpoint
Required
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|STORE
notify A boolean that can be used to disable notifications and behavioural registration for the query. false
priceId A custom price identifier. Must match supplied custom price identifiers in the data feed. 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
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
curl -i \
-X GET \
-H 'Accept-Encoding: gzip' \
"https://{cluster-id}.api.esales.apptus.cloud/api/storefront/v3/queries/navigation-tree?customerKey=0b05119e-eeb8-418a-bbfb-defa0dde417e&locale=locale&market=UK&sessionKey=0b05119e-eeb8-418a-bbfb-defa0dde417e&touchpoint=DESKTOP&channels=ONLINE|STORE&notify=false&priceId=VIP&stores=240|100&viewId=production"

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.

Response headers

Name Type Description Example
X-Response-Time integer Response time in milliseconds (ms) 65

Response body

Example
application/json;charset=utf-8
{
  "tree" : {
    "children" : { },
    "count" : 5,
    "expandable" : true,
    "label" : "All products",
    "link" : "/springselections",
    "path" : "/",
    "selected" : false,
    "type" : "PAGE_LINK"
  }
}
Schema

The object representation of a navigation tree structure.

Name Type Description Example
tree NavigationTreeNode

POST

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.

Request

Header parameters

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

Query parameters

Name Description Example
customerKey
Required
A key that uniquely identifies the current visitor.Using UUIDs as keys are recommended. 0b05119e-eeb8-418a-bbfb-defa0dde417e
locale
Required
The visitor locale. Must match an available locale identifier on the current market in the data feed.
market
Required
The visitor market identifier. Must match the corresponding market identifier in the data feed. UK
sessionKey
Required
A unique key, identifying the session.Using UUIDs as keys are recommended. 0b05119e-eeb8-418a-bbfb-defa0dde417e
touchpoint
Required
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|STORE
notify A boolean that can be used to disable notifications and behavioural registration for the query. false
priceId A custom price identifier. Must match supplied custom price identifiers in the data feed. 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
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
curl -i \
-X POST \
-H 'Accept-Encoding: gzip' \
"https://{cluster-id}.api.esales.apptus.cloud/api/storefront/v3/queries/navigation-tree?customerKey=0b05119e-eeb8-418a-bbfb-defa0dde417e&locale=locale&market=UK&sessionKey=0b05119e-eeb8-418a-bbfb-defa0dde417e&touchpoint=DESKTOP&channels=ONLINE|STORE&notify=false&priceId=VIP&stores=240|100&viewId=production"

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.

Response headers

Name Type Description Example
X-Response-Time integer Response time in milliseconds (ms) 65

Response body

Example
application/json;charset=utf-8
{
  "tree" : {
    "children" : { },
    "count" : 5,
    "expandable" : true,
    "label" : "All products",
    "link" : "/springselections",
    "path" : "/",
    "selected" : false,
    "type" : "PAGE_LINK"
  }
}
Schema

The object representation of a navigation tree structure.

Name Type Description Example
tree NavigationTreeNode

Schemas

Inner schemas

The object representation of the navigation node.

Name Type Description Example
children object A list of NavigationNode children of the current node.
count integer The number of product groups in the node. 5
expandable boolean Indicates that this node can be expanded, e.g. a request with this node as selected will return children under this node. true
label string The presentation text for the node. All products
link string Link to page, will only by populated if type is PAGE_LINK /springselections
path string The path to the node. /
selected boolean Identifies the node as selected in the tree. false
type string The type of node, used for separating visuals of different node types. Supported values: PRODUCT, LABEL, PAGE_LINK, SPACER. PAGE_LINK
×
Copyright

This online publication is intellectual property of Voyado Lund AB. Its contents can be duplicated in part or whole, provided that a copyright label is visibly located on each copy and the copy is used in conjunction with the product described within this document.

All information found in these documents has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither Voyado Lund AB nor the authors shall be held liable for possible errors or the consequences thereof.

Software and hardware descriptions cited in these documents might be registered trademarks. All trade names are subject to copyright restrictions and may be registered trademarks. Voyado Lund AB essentially adheres to the manufacturer’s spelling. Names of products and trademarks appearing in this document, with or without specific notation, are likewise subject to trademark and trade protection laws and may thus fall under copyright restrictions.

CLOSE