Get a Hierarchy's Children
GET/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
Responses
- 200
- default