Skip to content

Navigation

https://{cluster-id}.api.esales.apptus.cloud/api/admin/v3/export/navigation

GET

An export of the navigation tree in eSales.

Request

Header parameters

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

Query parameters

Name Description Example
locale
Required
The visitor locale. Must match an available locale identifier on the current market in the data feed. en-UK
market
Required
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' \
"https://{cluster-id}.api.esales.apptus.cloud/api/admin/v3/export/navigation?locale=en-UK&market=UK&includeAppNodes=false"

Response

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 Apptus 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

Example
application/json;charset=UTF-8
{
  "locale" : "string",
  "market" : "string",
  "type" : "FULL",
  "addOrUpdate" : [ {
    "id" : "/women/shirts",
    "title" : "Shirts",
    "type" : "PAGE",
    "pageId" : "/se/women/shirts",
    "parentId" : "/women",
    "url" : "/shipping-and-returns"
  } ],
  "remove" : [ "string" ]
}
Schema
Name Type Description Example
locale
Required
string The market identifier for where the navigation should apply. Must match the corresponding market identifier in the data feed.
market
Required
string The market identifier for where the navigation should apply. Must match the corresponding market identifier in the data feed.
type
Required
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.

Schemas

Inner schemas

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.

Name Type Description Example
id
Required
string An identifier to represent the node. It should be unique within the navigation /women/shirts
title
Required
string The title of the node Shirts
type
Required
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
pageId string Required for page nodes! The pageId of the target page /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! /women
url string Required for link nodes! Either a suffix for the own domain or an entire url for another /shipping-and-returns
×
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