Get Hierarchy 2

Get all hierarchies

GET/pcm/hierarchies

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the Get Hierarchy 2 action (under PIM).
Fill in the fields below, then reference the result from later steps as {{getHierarchy2.response.data}}.

Request

Query parameters

page[offset]integer (int64)

The number of records to offset the results by.

page[limit]integer (int64)

The number of records per page. The maximum limit is 100.

filterstring

Many Commerce API endpoints support filtering. The general syntax is described [**here**](/guides/Getting-Started/filtering).

Response

Returns 200 with an object. Read it in later steps with {{getHierarchy2.response.data.<field>}}.

dataarray<object>

idstringrequired

A unique identifier generated when a hierarchy is created.

typestringrequired

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

One ofhierarchy

attributesobjectrequired6 fields

relationshipsobjectrequired1 fields

metaobjectrequired5 fields

linksobject

Links allow you to navigate between pages of results. :::caution Planned pagination changes — on or after 1 September 2026 The pagination behaviour of PIM list endpoints (for example, `GET /pcm/products` and `GET /pcm/hierarchies`) currently differs from the rest of the Elastic Path Commerce Cloud platform. We plan to align PIM pagination with the platform standard on or after **1 September 2026**. Please review the details below and check that your integration code will handle the new behaviour correctly. ::: #### Current behaviour The current pagination link behaviour in PIM has the following known issues: - The `current` link is **not returned**. - The `first` and `last` links are **not always returned**. - The `prev` link is omitted on both the first **and** second pages. It should only be omitted on the first page. - The `next` link is omitted on both the last **and** second-to-last pages. It should only be omitted on the last page. #### Planned behaviour (on or after 1 September 2026) On or after 1 September 2026, PIM list endpoints will adopt the following pagination link behaviour, aligning with the rest of the platform: - `current` — always present, pointing to the current page. - `first` — always present. - `last` — present on all pages **except the final page**. Omitting `last` on the final page is intentional, to avoid triggering infinite‑loop bugs in integration code that uses the presence of `last` to detect whether more pages remain. - `next` — present on all pages except the last page. - `prev` — present on all pages except the first page.

currentstring

A link to the current page of results. **Note:** this link is not currently returned by PIM endpoints. It will be introduced on or after 1 September 2026.

firststring

A link to the first page of results. Currently this may not always be present. After the planned changes it will always be present.

laststring

A link to the last page of results. Currently this may not always be present. After the planned changes it will be present on all pages except the final page (where it is intentionally omitted).

nextstring

A link to the next page of results. Should be absent on the last page. Currently this is incorrectly absent on the second-to-last page as well; this will be fixed on or after 1 September 2026.

prevstring

A link to the previous page of results. Should be absent on the first page. Currently this is incorrectly absent on the second page as well; this will be fixed on or after 1 September 2026.

metaobject

resultsobject1 fields

Contains the results for the entire collection.

json

{
  "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.000Z",
        "updated_at": "2020-09-22T09:00:00.000Z",
        "owner": "store",
        "has_children": false,
        "breadcrumbs": [
          {
            "id": "string",
            "name": "string",
            "slug": "string",
            "locales": {}
          }
        ]
      }
    }
  ],
  "links": {
    "current": "/pcm/hierarchies?page[offset]=10&page[limit]=10",
    "first": "/pcm/hierarchies?page[offset]=0&page[limit]=10",
    "last": "/pcm/hierarchies?page[offset]=20&page[limit]=10",
    "next": "/pcm/hierarchies?page[offset]=10&page[limit]=10",
    "prev": "/pcm/hierarchies?page[offset]=8&page[limit]=10"
  },
  "meta": {
    "results": {
      "total": 30
    }
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.

Was this page helpful?