ELelasticpath
Shopper Catalog API

Get a Hierarchy

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.

get/catalog/hierarchies/{hierarchy_id}

Request

Path parameters

hierarchy_idstring required

The catalog hierarchy ID.

Headers

accept-languagestring

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

EP-Channelstring

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-Tagstring

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

Response

The catalog hierarchy.

Example response

{
  "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",
      "updated_at": "1970-01-01T00:00:00.000"
    },
    "id": "e871df93-c769-49a9-9394-a6fd555b8e8a",
    "type": "hierarchy",
    "meta": {
      "language": "en-GB",
      "breadcrumbs": [
        {
          "id": "e871df93-c769-49a9-9394-a6fd555b8e8a",
          "name": "Formal dresswear",
          "slug": "formal"
        }
      ],
      "has_children": true
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.