Navigations

Entry Point: /navigations/{scope}

Navigation nodes organize your store’s catalogs by providing containers to group related items into. Each navigation node can contain details (attributes), any number of items, and other child nodes. Your company’s marketers create these navigation nodes, also known as categories, using the Commerce Manager. You may need to coordinate with your marketers for how the navigation nodes should be used in your client application.

Read Navigations

Read a list of navigations.

Workflow

1. Start with root
2. GET the link with rel: navigations
3. Render the response

Read Navigation

Read a single navigation node.

Workflow

1. Start with navigations
2. GET the link with rel: element
3. Render the response

Response Fields

Type: elasticpath.navigations.node

Name	Description	Type
name	The Cortex system’s name for the node.	string
display-name	The localized name of the node, intended for display in the client application.	string
details	An array of the navigation node’s attributes. Attributes describe the details of the navigation node, like the node’s name, description, associated subcategories, etc. Attributes are different for each store. To get a list of navigation attributes, you’ll need to coordinate with your store marketer who creates these navigation nodes and attributes.	array
display-name	The formatted string to display on the client.	string
name	The name used by the Cortex system.	string
display-value	The formatted string to display on the client.	string
value	The raw value.	any

Read Navigation Item

Retrieve a paginated list of items associated with the navigation node.

Workflow

1. Start with navigation
2. GET the link with rel: items
3. GET the link with rel: element
4. Render the response

Read Navigation Offers

Searches for the offers associated with the navigation node. For more information, see the searches and offers sections

Workflow

1. Start with navigation
2. GET the link with rel: offers
3. Render the response

Read Navigation To Child

Read a navigation node’s child node.

Workflow

1. Start with navigation
2. GET the link with rel: child
3. Render the response

Response Fields

Type: elasticpath.navigations.node

Name	Description	Type
name	The Cortex system’s name for the node.	string
display-name	The localized name of the node, intended for display in the client application.	string
details	An array of the navigation node’s attributes. Attributes describe the details of the navigation node, like the node’s name, description, associated subcategories, etc. Attributes are different for each store. To get a list of navigation attributes, you’ll need to coordinate with your store marketer who creates these navigation nodes and attributes.	array
display-name	The formatted string to display on the client.	string
name	The name used by the Cortex system.	string
display-value	The formatted string to display on the client.	string
value	The raw value.	any

Read Navigation To Parent

Read a navigation node’s parent node.

Workflow

1. Start with navigation
2. GET the link with rel: parent
3. Render the response

Response Fields

Type: elasticpath.navigations.node

Name	Description	Type
name	The Cortex system’s name for the node.	string
display-name	The localized name of the node, intended for display in the client application.	string
details	An array of the navigation node’s attributes. Attributes describe the details of the navigation node, like the node’s name, description, associated subcategories, etc. Attributes are different for each store. To get a list of navigation attributes, you’ll need to coordinate with your store marketer who creates these navigation nodes and attributes.	array
display-name	The formatted string to display on the client.	string
name	The name used by the Cortex system.	string
display-value	The formatted string to display on the client.	string
value	The raw value.	any

Lookup Navigation By Code

Look up a navigation item by category code.

Workflow

1. Start with lookups
2. GET the link with rel: navigationlookupform
3. Fill out the form
4. POST the form using the link with rel: navigationlookupaction

Request Fields

Type: elasticpath.navigations.category-code

Name	Description	Type
code	The category code.	string

Read Navigation Featured Offers

Retrieve featured offers for navigation

Workflow

1. Start with navigation
2. GET the link with rel: featuredoffers
3. GET the link with rel: element
4. Render the response

Read Facets

Retrieve the facets available for the navigation node to refine the results.

Workflow

1. Start with navigation
2. GET the link with rel: offers
3. GET the link with rel: facets
4. Render the response

Read Facet

Retrieve the display name of the facet and facet value selector resource.

Workflow

1. Start with navigation
2. GET the link with rel: offers
3. GET the link with rel: facets
4. GET the link with rel: element
5. Render the response

Response Fields

Type: offersearch.facet

Name	Description	Type
display-name	The display name of the selected facet in the API.	string

Facet Selector

Retrieve the facet values available for the selected facet and the facet selector resource to select the required facet values. You can refine the search results by selecting the required choices in multiple facets and retrieve the updated results using the offer search result resource.

Workflow

1. Start with navigation
2. GET the link with rel: offers
3. GET the link with rel: facets
4. GET the link with rel: element
5. GET the link with rel: facetselector
6. GET the link with rel: choice
7. GET the link with rel: chosen
8. GET the link with rel: offersearchresult
9. GET the link with rel: description
10. POST the choice using the link with rel: selectaction

Read Facet Value

Retrieve the facet value and the number of offers corresponding to the facet value selection.

Workflow

1. Start with facet-selector-choice
2. GET the link with rel: description
3. Render the response

Response Fields

Type: offersearch.facet-value

Name	Description	Type
value	The facet value.	string
count	The count of items corresponding to the selected facet value.	string

Sort Attributes Selector

Retrieve the sort attribute selectors available for the store to sort the search result.

Workflow

1. Start with navigation
2. GET the link with rel: offers
3. GET the link with rel: sortattributes
4. GET the link with rel: choice
5. GET the link with rel: chosen
6. GET the link with rel: offersearchresult
7. GET the link with rel: description
8. POST the choice using the link with rel: selectaction

Read Sort Attribute

Retrieve the localized display name of the sort attribute.

Workflow

1. Start with sort-attribute-selector-choice
2. GET the link with rel: description
3. Render the response

Response Fields

Type: offersearch.sort-attribute

Name	Description	Type
display-name	The display name of the attribute in the given locale.	string