Get a Hierarchy's Nodes

GET 
https://euwest.api.elasticpath.com/catalog/hierarchies/:hierarchy_id/nodes

Returns all the nodes for the specified hierarchy.

If you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. For information about how rules are matched, see Resolving Catalog Rules.

In the breadcrumbs metadata, you can identify the parent nodes that a node is associated with. This is useful if you want to improve how your shoppers search your store, for example. See Product and Node Associations in Breadcrumb Metadata.

Filtering

This endpoint supports filtering. For general syntax, see Filtering.

Operator	Description	Supported Attributes	Example
Eq	Checks if the values of two operands are equal. If they are, the condition is true.	name, slug	filter=eq(name,some-name)
In	Checks if the values are included in the specified string. If they are, the condition is true.	id	filter=in(id,some-id)

Building breadcrumbs in a storefront

In a catalog, you can use the nodes directly attached to a product to build breadcrumbs in your storefront. This eliminates the need for additional queries to fetch hierarchy or parent node details. Each node contains all the necessary information in breadcrumbs metadata, such as its own details and the details of its parent hierarchy/node(s), to construct the complete breadcrumb path without requiring additional queries.

An example is shown below:

filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)

• Specify the node IDs directly attached to the product in the filter expression.
• You can include as many node IDs as required.
• It does not matter what order you specify the node IDs. The nodes are returned in the order they were last updated.

Request

Responses

200

The child nodes of a catalog hierarchy.

default

The unexpected error.

Authorization: Authorization

name: Authorizationtype: httpin: headerscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

Request Collapse all

Base URL

https://euwest.api.elasticpath.com

Auth

Bearer Token

Parameters

hierarchy_id — pathrequired

filter — query

page[limit] — query

page[offset] — query

EP-Channel — header

EP-Context-Tag — header

accept-language — header

ResponseClear

Click the Send API Request button above and see the response here!