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
- Start with root
GET
the link with rel: navigations- Render the response
Read Navigation
Read a single navigation node.
Workflow
- Start with navigations
GET
the link with rel: element- 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
- Start with navigation
GET
the link with rel: itemsGET
the link with rel: element- 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
- Start with navigation
GET
the link with rel: offers- Render the response
Read Navigation To Child
Read a navigation node’s child node.
Workflow
- Start with navigation
GET
the link with rel: child- 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
- Start with navigation
GET
the link with rel: parent- 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
- Start with lookups
GET
the link with rel: navigationlookupform- Fill out the form
POST
the form using the link with rel: navigationlookupaction
Read Navigation Featured Offers
Retrieve featured offers for navigation
Workflow
- Start with navigation
GET
the link with rel: featuredoffersGET
the link with rel: element- Render the response