Get a Hierarchy
GEThttps://euwest.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/hierarchies/:hierarchy_id
Returns the specified hierarchy from a published catalog.
note
Currently, published catalogs are limited to the current release and two releases prior to the current release.
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.
hierarchy_id stringrequired
The catalog hierarchy ID.
Header Parameters
accept-language string
The language and locale your storefront prefers. See Accept-Language.
Responses
- 200
- default
The catalog hierarchy.
- application/json
- Schema
- Example (auto)
Schema
data object
links object
{
"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"
}
}
The unexpected error.
- application/json
- Schema
- Example (auto)
Schema
errors object[]
{
"errors": [
{
"detail": "not processable",
"status": "422",
"title": "There was a problem processing your request."
}
]
}
Authorization: Authorization
name: Authorizationtype: httpin: headerscheme: 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/catalogs/:catalog_id/releases/:release_id/hierarchies/:hierarchy_id");
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