Get all hierarchies

GET 
/pcm/hierarchies

Get all hierarchies

Request

Query Parameters

page[offset] int64

Possible values: <= 10000

The number of records to offset the results by.

page[limit] int64

Possible values: <= 10000

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

Responses

200

Returns a list of all hierarchies.

application/json

Schema

Schema

data object[]required
Array [
id stringrequired
A unique identifier generated when a hierarchy is created.
type stringrequired
Possible values: [hierarchy]
This represents the type of resource object being returned. Always hierarchy.
attributes objectrequired
name string
The name of a hierarchy, such as Major Appliances.
description string
A description for a hierarchy.
slug string
A unique slug for a hierarchy.
admin_attributes object
admin_attributes are not displayed in catalogs. This means admin_attributes can only be viewed by administrators. If you want a custom attribute to be displayed in a catalog, you must add it to shopper_attributes.
admin_attributes are structured as key-value pairs. Both the keys and values are strings. You can have up to 100 keys.
property name* stringnullable
shopper_attributes object
shopper_attributes are displayed in catalogs. This means shopper_attributes can be viewed by both shoppers and administrators. If you do not want a custom attribute to be displayed in a catalog, you must add it to admin_attributes.
shopper_attributes are structured as key-value pairs. Both the keys and values are strings. You can have up to 100 keys.
property name* stringnullable
locales object
Product Experience Manager supports localization of hierarchies and nodes. If you store supports multiple languages, you can localize hierarchy and node names and descriptions.
property name* object
A three-letter language code that represents the name of language you have used.
name string
A localized hierarchy or node name.
description string
A localized hierarchy or node description.
relationships objectrequired
children object
The child nodes related to the hierarchy.
data array
An array of child nodes.
links object
Links allow you to move between requests.
related string
A link to a related resource.
meta objectrequired
created_at date-time
The date and time a hierarchy is created.
updated_at date-time
The date and time a hierarchy is updated.
owner string
Possible values: [store, organization]
The owner of a resource, either organization or store.
]
links object

Links are used to allow you to move between requests.

first string

Always the first page.

last string

This is null if there is only one page.

next string

This is null if there is only one page.

prev string

This is null if you on the first page.

meta object

results object

Contains the results for the entire collection.

total integer

Total number of results for the entire collection.

Example (from schema)

{
  "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"
      }
    }
  ],
  "links": {
    "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
    }
  }
}

list-hierarchies

{
  "data": [
    {
      "type": "hierarchy",
      "id": "6183d10c-94b5-4caa-9f12-2f14cb738d41",
      "attributes": {
        "description": "Shoes Category",
        "locales": {
          "fr-FR": {
            "name": "Chaussures",
            "description": "Catégorie de chaussures"
          }
        },
        "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:30:50.867Z"
      }
    }
  ],
  "links": {
    "last": "/pcm/hierarchies?page[offset]=29&page[limit]=1",
    "next": "/pcm/hierarchies?page[offset]=1&page[limit]=1"
  },
  "meta": {
    "results": {
      "total": 30
    }
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors undefined[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
request_id string
Internal request ID.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

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

bad-request

{
  "errors": [
    {
      "title": "Bad Request",
      "detail": "Could not parse the supplied filter",
      "status": "400"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors undefined[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
request_id string
Internal request ID.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

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

internal-server-error

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

Loading...