Get a node's children

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

Retrieves the child nodes for a specified node.

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

Path Parameters

hierarchyID stringrequired

A unique identifier for the hierarchy.

nodeID stringrequired

A unique identifier for the node.

Query Parameters

filter string

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

page[offset] int64

Possible values: <= 10000

The number of records to offset the results by.

page[limit] int64

Possible values: <= 10000

The number of records per page. The maximum limit is 100.

Responses

200

Successfully returns the node's children

application/json

Schema

Schema

data object[]required
An array of nodes.
Array [
idstringrequired
The unique identifier of a node.
typestringrequired
This represents the type of resource object being returned. Always node.
Possible values: [node]
attributes objectrequired
namestring
The name of the node, such as Ranges or Refrigerators. Names must be unique among sibling nodes in the hierarchy. Otherwise, a name can be non-unique within the hierarchy and across multiple hierarchies.
descriptionstring
A description for a node.
slugstring
A slug for the node. Slugs must be unique among sibling nodes in the hierarchy. Otherwise, a slug can be non-unique within the hierarchy and across multiple hierarchies.
curated_productsstring[]
You can curate your products in your nodes product lists. Product curation allows you to promote specific products within each node in a hierarchy, enabling you to create unique product collections in your storefront.
admin_attributes object
admin_attributes are not displayed in catalogs. This means admin_attributes can only be viewed by administrators. If you want a custom attribute to be displayed in a catalog, you must add it to shopper_attributes.
admin_attributes are structured as key-value pairs. Both the keys and values are strings. You can have up to 100 keys.
property name*stringnullable
shopper_attributes object
shopper_attributes are displayed in catalogs. This means shopper_attributes can be viewed by both shoppers and administrators. If you do not want a custom attribute to be displayed in a catalog, you must add it to admin_attributes.
shopper_attributes are structured as key-value pairs. Both the keys and values are strings. You can have up to 100 keys.
property name*stringnullable
locales object
Product Experience Manager supports localization of hierarchies and nodes. If you store supports multiple languages, you can localize hierarchy and node names and descriptions.
property name* object
A three-letter language code that represents the name of language you have used.
namestring
A localized hierarchy or node name.
descriptionstring
A localized hierarchy or node description.
relationships objectrequired
Relationships allow you to move between requests. Includes links to the child nodes and products associated with a hierarchy or node.
children object
The child nodes related to the resource.
dataarray
An array of child nodes.
links object
Links allow you to move between requests.
relatedstring
A link to a related resource.
parent object
The parent node related to the resource
data object
The parent node
typestringrequired
This represents the type of resource object being returned. Always node.
Possible values: [node]
idstringrequired
The unique identifier of a node.
products object
The products related to the resource.
dataarray
An array of products.
links object
Links allow you to move between requests.
relatedstring
A link to a related resource.
meta objectrequired
sort_orderinteger
The sort order value. The node with the highest value of sort_order is displayed first. For example, a node with a sort_order value of 3 appears before a node with a sort_order value of 2. See Sorting Nodes in a hierarchy.
created_atdate-time
The date and time a node is created.
Example: 2020-09-22T09:00:00
updated_atdate-time
The date and time a node was updated.
Example: 2020-09-22T09:00:00
parent_namestring
The name of the parent of the node if one exists.
ownerstring
The node owner, either organization or store.
Possible values: [store, organization]
hierarchy_idstring
The unique identifier of hierarchy
breadcrumbs object[]
Breadcrumbs
Array [
idstring
The unique identifier of a hierarchy/node.
namestring
The name of the hierarchy/node.
slugstring
A slug for the hierarchy/node.
locales object
Product Experience Manager supports localization of hierarchies and nodes. If you store supports multiple languages, you can localize hierarchy and node names and descriptions.
property name* object
A three-letter language code that represents the name of language you have used.
namestring
A localized hierarchy or node name.
]
]
meta object
results object
Contains the results for the entire collection.
totalinteger
Total number of results for the entire collection.
Example: 30
links object
Links are used to allow you to move between requests.
firststring
Always the first page.
Example: /pcm/hierarchies?page[offset]=0&page[limit]=10
laststring
This is null if there is only one page.
Example: /pcm/hierarchies?page[offset]=20&page[limit]=10
nextstring
This is null if there is only one page.
Example: /pcm/hierarchies?page[offset]=10&page[limit]=10
prevstring
This is null if you on the first page.
Example: /pcm/hierarchies?page[offset]=8&page[limit]=10

Example (auto)

{
  "data": [
    {
      "id": "string",
      "type": "node",
      "attributes": {
        "name": "string",
        "description": "string",
        "slug": "string",
        "curated_products": [
          "string"
        ],
        "admin_attributes": {
          "cost_of_goods": "42.0",
          "charge_type": "credit card"
        },
        "shopper_attributes": {
          "cost_of_goods": "42.0",
          "charge_type": "credit card"
        },
        "locales": {}
      },
      "relationships": {
        "children": {
          "data": [
            null
          ],
          "links": {
            "related": "string"
          }
        },
        "parent": {
          "data": {
            "type": "node",
            "id": "string"
          }
        },
        "products": {
          "data": [
            null
          ],
          "links": {
            "related": "string"
          }
        }
      },
      "meta": {
        "sort_order": 0,
        "created_at": "2020-09-22T09:00:00",
        "updated_at": "2020-09-22T09:00:00",
        "parent_name": "string",
        "owner": "store",
        "hierarchy_id": "string",
        "breadcrumbs": [
          {
            "id": "string",
            "name": "string",
            "slug": "string",
            "locales": {}
          }
        ]
      }
    }
  ],
  "meta": {
    "results": {
      "total": 30
    }
  },
  "links": {
    "first": "/pcm/hierarchies?page[offset]=0&page[limit]=10",
    "last": "/pcm/hierarchies?page[offset]=20&page[limit]=10",
    "next": "/pcm/hierarchies?page[offset]=10&page[limit]=10",
    "prev": "/pcm/hierarchies?page[offset]=8&page[limit]=10"
  }
}

get-node-children

{
  "data": [
    {
      "id": "9ea0de15-3347-43dd-8faa-cd32f44a04c7",
      "type": "node",
      "attributes": {
        "description": "Latest Ballet Shoes",
        "locales": {
          "fr-FR": {
            "name": "Chaussons de ballet",
            "description": "Dernières chaussures de ballet"
          }
        },
        "name": "Ballet Shoes",
        "slug": "ballet-shoes"
      },
      "relationships": {
        "children": {
          "data": [],
          "links": {
            "related": "/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/children"
          }
        },
        "products": {
          "data": [],
          "links": {
            "related": "/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/products"
          }
        }
      },
      "meta": {
        "created_at": "2024-01-11T19:19:50.087Z",
        "owner": "store",
        "sort_order": 5,
        "updated_at": "2024-01-11T19:56:53.695Z",
        "hierarchy_id": "6183d10c-94b5-4caa-9f12-2f14cb738d41",
        "breadcrumbs": [
          {
            "id": "6183d10c-94b5-4caa-9f12-2f14cb738d41",
            "name": "Shoes",
            "slug": "shoes",
            "locales": {
              "fr-FR": {
                "name": "hierarchy 1 in French"
              }
            }
          },
          {
            "id": "9ea0de15-3347-43dd-8faa-cd32f44a04c7",
            "name": "Ballet Shoes",
            "slug": "ballet-shoes",
            "locales": {
              "fr-FR": {
                "name": "Node 1 in French"
              }
            }
          }
        ]
      }
    },
    {
      "type": "node",
      "id": "b2f5e53e-de3c-4548-98da-120f8b185d34",
      "attributes": {
        "description": "All Dress Shoes",
        "locales": {
          "fr-FR": {
            "name": "Chaussures habillées",
            "description": "Toutes les chaussures habillées"
          }
        },
        "name": "Dress Shoes",
        "slug": "dress-shoes"
      },
      "relationships": {
        "children": {
          "data": [],
          "links": {
            "related": "/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/b2f5e53e-de3c-4548-98da-120f8b185d34/children"
          }
        },
        "products": {
          "data": [],
          "links": {
            "related": "/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/b2f5e53e-de3c-4548-98da-120f8b185d34/products"
          }
        }
      },
      "meta": {
        "created_at": "2024-01-11T19:50:21.729Z",
        "owner": "store",
        "sort_order": 3,
        "updated_at": "2024-01-11T19:50:21.729Z",
        "hierarchy_id": "6183d10c-94b5-4caa-9f12-2f14cb738d41",
        "breadcrumbs": [
          {
            "id": "6183d10c-94b5-4caa-9f12-2f14cb738d41",
            "name": "Shoes",
            "slug": "shoes",
            "locales": {
              "fr-FR": {
                "name": "hierarchy 1 in French"
              }
            }
          },
          {
            "id": "b2f5e53e-de3c-4548-98da-120f8b185d34",
            "name": "Dress Shoes",
            "slug": "dress-shoes",
            "locales": {
              "fr-FR": {
                "name": "Node 2 in French"
              }
            }
          }
        ]
      }
    }
  ],
  "meta": {
    "results": {
      "total": 2
    }
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors undefined[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
request_idstring
Internal request ID.
Example: 00000000-0000-0000-0000-000000000000
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

bad-request

{
  "errors": [
    {
      "title": "Bad Request",
      "detail": "Could not parse the supplied filter",
      "status": "400"
    }
  ]
}

404

Bad Request. Not Found.

application/json

Schema

Schema

errors undefined[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
request_idstring
Internal request ID.
Example: 00000000-0000-0000-0000-000000000000
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Not Found",
      "status": "404"
    }
  ]
}

500

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

application/json

Schema

Schema

errors undefined[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
request_idstring
Internal request ID.
Example: 00000000-0000-0000-0000-000000000000
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "status": "500",
      "title": "Internal Server Error",
      "detail": "There was an internal server error, you can report with your request id.",
      "request_id": "635da56d-75a1-43cd-b696-7ab119756b3a"
    }
  ]
}

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/:nodeID/children");
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

nodeID — pathrequired

filter — query

page[offset] — query

page[limit] — query

ResponseClear

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