Get a hierarchy
GEThttps://euwest.api.elasticpath.com/pcm/hierarchies/:hierarchyID
Retrieves the specified hierarchy.
Request
Path Parameters
hierarchyID stringrequired
A unique identifier for the hierarchy.
Responses
- 200
- 400
- 404
- 500
Returns a hierarchy with the following attributes.
- application/json
- Schema
- Example (auto)
- get-hierarchy
Schema
data objectrequired
{
"data": {
"id": "string",
"type": "hierarchy",
"attributes": {
"name": "string",
"description": "string",
"slug": "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"
}
}
},
"meta": {
"created_at": "2020-09-22T09:00:00",
"updated_at": "2020-09-22T09:00:00",
"owner": "store",
"breadcrumbs": [
{
"id": "string",
"name": "string",
"slug": "string",
"locales": {}
}
]
}
}
}
{
"data": {
"type": "hierarchy",
"id": "6183d10c-94b5-4caa-9f12-2f14cb738d41",
"attributes": {
"description": "Shoes Category",
"locales": {
"fr-FR": {
"name": "Chaussures",
"description": "Catégorie de chaussures"
}
},
"admin_attributes": {
"cost_of_goods": "42.0",
"charge_type": "credit card"
},
"shopper_attributes": {
"cost_of_goods": "42.0",
"charge_type": "credit card"
},
"name": "Shoes",
"slug": "shoes"
},
"relationships": {
"children": {
"data": [],
"links": {
"related": "/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/children"
}
}
},
"meta": {
"created_at": "2024-01-10T20:16:35.343Z",
"owner": "store",
"updated_at": "2024-01-10T20:16:35.343Z",
"breadcrumbs": [
{
"id": "6183d10c-94b5-4caa-9f12-2f14cb738d41",
"name": "Shoes",
"slug": "shoes",
"locales": {
"fr-FR": {
"name": "hierarchy 1 in French"
}
}
}
]
}
}
}
Bad request. The request failed validation.
- application/json
- Schema
- Example (auto)
- bad-request
Schema
errors undefined[]required
{
"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"
]
}
}
]
}
{
"errors": [
{
"title": "Bad Request",
"detail": "Could not parse the supplied filter",
"status": "400"
}
]
}
Bad Request. Not Found.
- application/json
- Schema
- Example (auto)
- internal-server-error
Schema
errors undefined[]required
{
"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"
]
}
}
]
}
{
"errors": [
{
"title": "Not Found",
"status": "404"
}
]
}
Internal server error. There was a system failure in the platform.
- application/json
- Schema
- Example (auto)
- internal-server-error
Schema
errors undefined[]required
{
"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"
]
}
}
]
}
{
"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");
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());
ResponseClear