GET https://{cluster-id}.elevate-api.cloud/api/admin/v4/export/navigation
Request
Request header parameters
Request header parameters
| Name | Description | Example |
|---|---|---|
Api-Key* | API key supplied during onboarding. | 123456789.. |
Accept-Encoding* | Allows responses to be compressed using gzip. | gzip |
Request query parameters
Request query parameters
| Name | Description | Example |
|---|---|---|
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 |
includeAppNodes | Whether to include nodes that were created in the app, defaults to false. | false |
Example request
Example request
bash
curl -i \
-X GET \
-H 'Api-Key: 123456789..' \
-H 'Accept-Encoding: gzip' \
"https://{cluster-id}.elevate-api.cloud/api/admin/v4/export/navigation?locale=en-GB&market=UK&includeAppNodes=false"
Response
Response codes
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. |
Example response
Example response
{
"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" ]
}
Response body schema
Response body schema
NavigationContainer
| Name | Type | Description |
|---|---|---|
| locale* | string | The locale identifier for where the navigation should apply. Must match the corresponding locale identifier in the data feed. Examples: "sv-SE" |
| market* | 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.Examples: "se" |
| type* | 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.Examples: "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. Examples: "remove-me" |
Schemas
NavigationNode
| Name | Type | Description |
|---|---|---|
| id* | 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/_-]+.Examples: "/women/shirts" |
| title* | string | The title of the node Min length: 1. Max length: 200.Examples: "Shirts" |
| type* | 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.Examples: "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 ’_‘ Examples: {"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.Examples: "/resources/images/navigation/shirts.jpg" |
| pageId | string | Required for page nodes! The pageId of the target page Min length: 1. Max length: 200.Examples: "/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/_-]+.Examples: "/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.Examples: "/shipping-and-returns" |