Get a Hierarchy

GET 
https://euwest.api.elasticpath.com/catalog/hierarchies/:hierarchy_id

Returns a hierarchy from the catalog.

If you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog to retrieve. For information about how catalog rules are matched, see Resolving Catalog Rules.

Request

Path Parameters

hierarchy_id stringrequired

The catalog hierarchy ID.

Header Parameters

accept-language string

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

EP-Channel string

The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the catalog rule matches all channels. The channel will eventually be included in the bearer token that is used for authorization, but currently, you must set the EP-Channel header in your requests.

EP-Context-Tag string

Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the EP-Context-Tag header.

Responses

200

The catalog hierarchy.

application/json

Schema

Schema

data object

A category hierarchy in a catalog. Hierarchies can have parent nodes and child nodes, as well as a list of attached products.

attributes object

Resource attributes of a catalog hierarchy.

created_atdate-time

The date and time a hierarchy is created.

Example: 1970-01-01T00:00:00.000

published_atdate-timenullable

The date and time a hierarchy is published in a catalog.

Example: 1970-01-01T00:00:00.000

descriptionstring

A description of a hierarchy.

Example: Formal dresswear

namestring

The name of a hierarchy.

Example: Formal dresswear

slugstring

A unique slug for a hierarchy.

Example: formal

shopper_attributes object

A collection of key-value string pairs, viewable by shoppers.

property name*string

updated_atdate-time

The date and time a hierarchy was updated.

Example: 1970-01-01T00:00:00.000

idstring

A unique identifier of a hierarchy.

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

relationships object

Relationships to child nodes, and products.

products object

A URL to all the products associated with a hierarchy.

links object

A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.

relatedstringrequired

A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.

children object

A URL to all the child products associated with a hierarchy.

links objectrequired

A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.

relatedstringrequired

A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.

nodes object

A URL to all the nodes associated with a hierarchy.

links objectrequired

A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.

relatedstringrequired

A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas.

typestring

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

Example: hierarchy

meta object

A hierarchy's metadata.

languagestring

Product Experience Manager supports localization of hierarchies. If your store supports multiple languages, you can localize hierarchy names and descriptions. This is three-letter language code that represents the name of the language you have used.

Example: en-GB

breadcrumbs object[]

Hierarchy Breadcrumbs

Array [

idstring

The unique identifier of a hierarchy.

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

namestring

The name of the hierarchy.

Example: Formal dresswear

slugstring

A slug for the hierarchy.

Example: formal

]

has_childrenbooleannullable

Indicates whether a node has child nodes. true if the node has at least one child, false if it has none.

Example: true

links object

Links allow you to move between requests.

selfurinullable

Single entities use a self parameter with a link the specific resource.

firsturinullable

Always the first page.

lasturinullable

This is null if there is only one page.

prevurinullable

This is null if there is only one page.

nexturinullable

This is null if there is only one page.

Example (auto)

{
  "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"
  }
}

default

The unexpected error.

application/json

Schema

Schema

errors object[]
Array [
detailstring
Example: not processable
statusstring
Example: 422
titlestring
Example: There was a problem processing your request.
]

Example (auto)

{
  "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/catalog/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());

Request Collapse all

Base URL

https://euwest.api.elasticpath.com

Auth

Bearer Token

Parameters

hierarchy_id — pathrequired

accept-language — header

EP-Channel — header

EP-Context-Tag — header

ResponseClear

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