Get a node

GET 
/pcm/hierarchies/:hierarchyID/nodes/:nodeID

Retrieves a node from a hierarchy.

Request

Path Parameters

hierarchyID stringrequired

A unique identifier for the hierarchy.

nodeID stringrequired

A unique identifier for the node.

Responses

200

Returns a node with the following attributes.

application/json

Schema

Schema

data object

id string

The unique identifier of a node.

type string

Possible values: [node]

This represents the type of resource object being returned. Always node.

attributes object

name string

The name of the node, such as Ranges or Refrigerators. Names must be unique among sibling nodes in the hierarchy. Otherwise, a name can be non-unique within the hierarchy and across multiple hierarchies.

description string

A description for a node.

slug string

A slug for the node. Slugs must be unique among sibling nodes in the hierarchy. Otherwise, a slug can be non-unique within the hierarchy and across multiple hierarchies.

curated_products string[]

You can curate your products in your nodes product lists. Product curation allows you to promote specific products within each node in a hierarchy, enabling you to create unique product collections in your storefront.

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 object

Relationships allow you to move between requests. Includes links to the child nodes and products associated with a hierarchy or node.

children object

The child nodes related to the resource.

data array

An array of child nodes.

links object

Links allow you to move between requests.

related string

A link to a related resource.

parent object

The parent node related to the resource

data object

The parent node

type stringrequired

Possible values: [node]

This represents the type of resource object being returned. Always node.

id stringrequired

The unique identifier of a node.

products object

The products related to the resource.

data array

An array of products.

links object

Links allow you to move between requests.

related string

A link to a related resource.

meta object

sort_order integer

The sort order value. The node with the highest value of sort_order is displayed first. For example, a node with a sort_order value of 3 appears before a node with a sort_order value of 2. See Sorting Nodes in a hierarchy.

created_at date-time

The date and time a node is created.

updated_at date-time

The date and time a node was updated.

parent_name string

The name of the parent of the node if one exists.

owner string

Possible values: [store, organization]

The node owner, either organization or store.

Example (from schema)

{
  "data": {
    "id": "string",
    "type": "node",
    "attributes": {
      "name": "string",
      "description": "string",
      "slug": "string",
      "curated_products": [
        "string"
      ],
      "locales": {}
    },
    "relationships": {
      "children": {
        "data": [
          null
        ],
        "links": {
          "related": "string"
        }
      },
      "parent": {
        "data": {
          "type": "node",
          "id": "string"
        }
      },
      "products": {
        "data": [
          null
        ],
        "links": {
          "related": "string"
        }
      }
    },
    "meta": {
      "sort_order": 0,
      "created_at": "2020-09-22T09:00:00",
      "updated_at": "2020-09-22T09:00:00",
      "parent_name": "string",
      "owner": "store"
    }
  }
}

get-node

{
  "data": {
    "type": "node",
    "id": "9ea0de15-3347-43dd-8faa-cd32f44a04c7",
    "attributes": {
      "description": "All Ballet Shoes",
      "locales": {
        "fr-FR": {
          "name": "Chaussons de ballet",
          "description": "Toutes les chaussures de ballet"
        }
      },
      "name": "Ballet Shoes",
      "slug": "ballet-shoes"
    },
    "relationships": {
      "children": {
        "data": [],
        "links": {
          "related": "/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/children"
        }
      },
      "parent": {
        "data": {
          "type": "node",
          "id": "14e8e15a-7214-435d-bccb-6ae9b570d683"
        }
      },
      "products": {
        "data": [],
        "links": {
          "related": "/hierarchies/6183d10c-94b5-4caa-9f12-2f14cb738d41/nodes/9ea0de15-3347-43dd-8faa-cd32f44a04c7/products"
        }
      }
    },
    "meta": {
      "created_at": "2024-01-11T19:19:50.087Z",
      "owner": "store",
      "parent_name": "Shoes",
      "sort_order": 2,
      "updated_at": "2024-01-11T19:19:50.087Z"
    }
  }
}

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

404

Bad Request. Not Found.

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": [
    {
      "title": "Not Found",
      "status": "404"
    }
  ]
}

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