Get all nodes in a hierarchy

GET 
https://euwest.api.elasticpath.com/pcm/hierarchies/:hierarchyID/nodes

A fully paginated view of all nodes in a hierarchy regardless of depth.

Filtering

Many Commerce API endpoints support filtering. The general syntax is described in Filtering.

The following attributes and operators are supported.

Operator	Attribute	Description	Example
eq	id, hierarchy_id, owner, parent_id, name, slug, description, has_children, created_at, updated_at, locales.[locale].name, locales.[locale].description, breadcrumbs.id, breadcrumbs.name, breadcrumbs.slug, breadcrumbs.locales.[locale].name	Equals. Checks if the value of the attribute matches the specified value.	filter=eq(name,some-name), filter=eq(locales.fr-FR.name,Nom-du-produit)
in	id, hierarchy_id, parent_id, breadcrumbs.id	Checks if the value of the attribute is included in the specified list.	filter=in(id,1,2,3,4)
lt, le, gt, ge	id, hierarchy_id, parent_id, created_at, updated_at	Comparison operators. lt: Less than, le: Less than or equal to, gt: Greater than, ge: Greater than or equal to.	filter=lt(id,100), filter=ge(created_at,2022-01-01)
like	name, slug, description, locales.[locale].name, locales.[locale].description, breadcrumbs.name, breadcrumbs.slug, breadcrumbs.locales.[locale].name	Like. Checks if the attribute contains the specified string (wildcards supported).	filter=like(name,*some-name*), filter=like(locales.es-ES.description,*descripción*)

Request

Responses

200

Successfully returns the node's children

400

Bad request. The request failed validation.

404

Bad Request. Not Found.

500

Internal server error. There was a system failure in the platform.

Authorization: http

name: bearerAuthtype: httpscheme: bearer

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

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://euwest.api.elasticpath.com/pcm/hierarchies/:hierarchyID/nodes");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://euwest.api.elasticpath.com

Auth

Bearer Token

Parameters

hierarchyID — pathrequired

filter — query

page[offset] — query

page[limit] — query

ResponseClear

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