Get a Hierarchy's Children
GEThttps://euwest.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/hierarchies/:hierarchy_id/children
Returns the parent nodes for the specified hierarchy from a published catalog.
Currently, published catalogs are limited to the current release and two releases prior to the current release.
In the bread_crumb
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 a filter to return a list of nodes in a hierarchy structure that a product belongs to. You can use this to build breadcrumbs in your storefront. An example is shown below.
filter=in(id,c83bfe55-0d87-4302-a86d-ab19e7e323f1,6003d7ef-84f3-49bb-a8bd-4cbfa203dcbb)
- Specify the node Ids in the filter expression.
- You can have as many node Ids as you want.
- It does not matter what order you specify the node Ids. The nodes are returned in the order they were last updated.
Request
Path Parameters
The catalog ID.
The unique identifier of a published release of the catalog or latest
for the most recently published version.
The catalog hierarchy ID.
Query Parameters
This endpoint supports filtering, see Filtering.
Possible values: >= 1
The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the page length store setting is used.
Possible values: <= 10000
The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the page length store setting is used.
Header Parameters
The language and locale your storefront prefers. See Accept-Language.
Responses
- 200
- default
The child nodes of a catalog hierarchy.
- application/json
- Schema
- Example (from schema)
Schema
meta object
data object[]
links object
{
"meta": {
"results": {
"total": 0
},
"page": {
"limit": 0,
"offset": 0,
"current": 0,
"total": 0
}
},
"data": [
{
"attributes": {
"created_at": "1970-01-01T00:00:00.000",
"published_at": "1970-01-01T00:00:00.000",
"description": "Formal dresswear",
"label": "category",
"name": "Formal dresswear",
"slug": "formal",
"curated_products": [
"8dbb35b2-ef04-477e-974d-e5f3abe6faae"
],
"status": "live",
"updated_at": "1970-01-01T00:00:00.000"
},
"id": "e871df93-c769-49a9-9394-a6fd555b8e8a",
"relationships": {
"products": {
"data": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "product"
}
],
"links": {
"related": "string"
}
},
"children": {
"links": {
"related": "string"
}
},
"parent": {
"data": {
"type": "node",
"id": "8fccaa19-dba9-4621-8d11-31a222a68c7c"
},
"links": {
"related": "string"
}
},
"hierarchy": {
"data": {
"type": "hierarchy",
"id": "8fccaa19-dba9-4621-8d11-31a222a68c7c"
},
"links": {
"related": "string"
}
}
},
"type": "node",
"meta": {
"language": "en-GB",
"bread_crumb": [
"8dbb35b2-ef04-477e-974d-e5f3abe6faae"
]
}
}
],
"links": {
"self": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
}
The unexpected error.
- application/json
- Schema
- Example (from schema)
Schema
errors object[]
{
"errors": [
{
"detail": "not processable",
"status": "422",
"title": "There was a problem processing your request."
}
]
}
Authorization: Authorization
name: Authorizationtype: httpin: headerscheme: bearer
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X GET 'https://euwest.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/hierarchies/:hierarchy_id/children' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'