Get all Hierarchies

GET https://euwest.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/hierarchies

Returns the hierarchies from a published catalog.

note

Currently, published catalogs are limited to the current release and two releases prior to the current release.

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

Path Parameters

catalog_id stringrequired

The catalog ID.

release_id stringrequired

The unique identifier of a published release of the catalog or latestPublished for the most recently published version.

Query Parameters

filter string

This endpoints supports filtering. See Filtering.

page[limit] int64

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.

page[offset] int64

Possible values: >= 0 and <= 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

accept-language string

The language and locale your storefront prefers. See Accept-Language.

Responses

200
default

The hierarchies of a catalog.

Schema:

Schema

meta object

data object[]

Array [

attributes object

idstring

A unique identifier of a hierarchy.

Example: e871df93-c769-49a9-9394-a6fd555b8e8a

relationships object

typestring

This represents the type of object being returned. Always hierarchy.

Example: hierarchy

meta 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",
        "name": "Formal dresswear",
        "slug": "formal",
        "shopper_attributes": {},
        "updated_at": "1970-01-01T00:00:00.000"
      },
      "id": "e871df93-c769-49a9-9394-a6fd555b8e8a",
      "relationships": {
        "products": {
          "links": {
            "related": "string"
          }
        },
        "children": {
          "links": {
            "related": "string"
          }
        },
        "nodes": {
          "links": {
            "related": "string"
          }
        }
      },
      "type": "hierarchy",
      "meta": {
        "language": "en-GB",
        "breadcrumbs": [
          {
            "id": "e871df93-c769-49a9-9394-a6fd555b8e8a",
            "name": "Formal dresswear",
            "slug": "formal"
          }
        ],
        "has_children": true
      }
    }
  ],
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}

An unexpected error.

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

HTTPCLIENT
RESTSHARP

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

ResponseClear

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

Get all Hierarchies

https://euwest.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/hierarchies

Filtering​

Building breadcrumbs in a storefront​

Request​