Skip to main content

Get a Hierarchy

GET 

https://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

The catalog hierarchy.

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.

Authorization: Authorization

name: Authorizationtype: httpin: headerscheme: bearer
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());
Request Collapse all
Base URL
https://euwest.api.elasticpath.com
Auth
Parameters
— pathrequired
— pathrequired
— pathrequired
— header
ResponseClear

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

We use cookies to enhance your experience. By continuing to visit this site you agree to our use of cookies.