Skip to content




An export of the navigation tree in Elevate.


Header parameters

Name Description Example
Api-key that was supplied during on-boarding pkA123456789AB1BE..
Allows responses to be compressed using Gzip. gzip

Query parameters

Name Description Example
The visitor locale. Must match an available locale identifier on the current market in the data feed. en-UK
The visitor market identifier. Must match the corresponding market identifier in the data feed. UK
includeAppNodes Whether to include nodes that were created in the app, defaults to false false
curl -i \
-X GET \
-H 'Api-Key: pkA123456789AB1BE..' \
-H 'Accept-Encoding: gzip' \


Response codes

Status Description
200 Query accepted. The data will be returned as an application/json-object.
400 Invalid or missing required arguments.
403 Incorrect cluster credentials.
404 Cluster not found.
406 No acceptable encoding found in Accept-Encoding header.
500 Server error such as cluster unavailable, busy or internal error. If 5xx errors persist, contact support and attach any information found in the response body.
503 The server in the cluster that received the request is currently unavailable or busy. It is recommended to retry the request. The time between request attempts should be increasing.

Response body

  "locale" : "sv-SE",
  "market" : "se",
  "type" : "FULL",
  "addOrUpdate" : [ {
    "id" : "/women/shirts",
    "title" : "Shirts",
    "type" : "PAGE",
    "customData" : {
      "highlight" : "true",
      "viewableFrom" : "2010-10-20 00:00:00"
    "iconPath" : "/resources/images/navigation/shirts.jpg",
    "pageId" : "/se/women/shirts",
    "parentId" : "/women",
    "url" : "/shipping-and-returns"
  } ],
  "remove" : [ "remove-me" ]
Name Type Description Example
string The locale identifier for where the navigation should apply. Must match the corresponding locale identifier in the data feed. "sv-SE"
string The market identifier for where the navigation should apply. Must match the corresponding market identifier in the data feed. Min length: 1. Max length: 20. "se"
string Type of import. PARTIAL amends to the existing tree, FULL replaces all nodes that originate from api imports (attempting to retain additions from the apps) while FORCE replaces ALL existing pages. We recommendusing PARTIAL or FULL to allow app users to extend the navigation. Supported values: FORCE, FULL, PARTIAL. "FULL"
addOrUpdate NavigationNode[] Navigation nodes to add or update. Each node must have an id and a type and may specify the parent it should be placed under in the tree. Nodes on the same level will be inserted in order of appearance in the import.
remove string[] Navigation nodes to remove, based on ids. Only used in partial imports. "remove-me"


Inner schemas
Name Type Description Example
string An identifier to represent the node. It should be unique within the navigation Min length: 1. Max length: 200. Pattern: [a-zA-Z0-9/_-]+. "/women/shirts"
string The title of the node Min length: 1. Max length: 200. "Shirts"
string What kind of node this is. Different node types have additional required fields. PAGE nodes have a corresponding page (usually a category) and should make up the tree structure of the navigation while LINK and LABEL nodes can be used to add extra information to leaf nodes. Only PAGE nodes are intended to be navigable in the tree as LINK nodes should take the user elsewhere and LABEL nodes are purely cosmetic. Supported values: PAGE, LABEL, LINK. "PAGE"
customData <string, string> A key-value mapping of custom data fields. The same mapping will be returned in the result of landing-page and navigation requests. The key order is not guaranteed to be the same. Limited to 1000 characters and 50 keys per node. Allowed characters for keys are alphanumerical, '-' and '_' {"highlight":"true","viewableFrom":"2010-10-20 00:00:00"}
iconPath string A path to an image to be used as an icon for the node Min length: 1. Max length: 500. "/resources/images/navigation/shirts.jpg"
pageId string Required for page nodes! The pageId of the target page Min length: 1. Max length: 200. "/se/women/shirts"
parentId string The id of the parent node in the navigation hierarchy. Omit or set to null for top level nodes. Only page nodes should be parent nodes! Min length: 1. Max length: 200. Pattern: [a-zA-Z0-9/_-]+. "/women"
url string Required for link nodes! Either a suffix for the own domain or an entire url for another Min length: 1. Max length: 200. "/shipping-and-returns"

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.