Get Child Nodes

Get a Node's Children

GET/catalogs/{catalog_id}/releases/{release_id}/nodes/{node_id}/relationships/children

Use it in a workflow

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

Request

Path parameters

catalog_idstringrequired

The catalog ID.

release_idstringrequired

The unique identifier of a published release of the catalog or `latestPublished` for the most recently published version.

node_idstringrequired

The catalog node ID.

Query parameters

filterstring

This endpoint supports filtering, see [Filtering](#filtering).

page[limit]integer (int64)

The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.

page[offset]integer (int64)

The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results.

Headers

accept-languagestring

The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).

Response

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

metaobject

Contains the results for the entire collection.

resultsobject1 fields

Total number of results for the entire collection.

pageobject4 fields

dataarray<object>

attributesobject10 fields

Resource attributes of a catalog node.

idstring

The unique identifier of a node.

relationshipsobject4 fields

Relationships to parent and child nodes, and products.

typestring

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

metaobject4 fields

A node's metadata.

linksobject

Links allow you to move between requests.

selfstring (uri)

Single entities use a `self` parameter with a link the specific resource.

firststring (uri)

Always the first page.

laststring (uri)

This is `null` if there is only one page.

prevstring (uri)

This is `null` if there is only one page.

nextstring (uri)

This is `null` if there is only one page.

json

{
  "meta": {
    "results": {
      "total": 0
    },
    "page": {
      "limit": 0,
      "offset": 0,
      "current": 0,
      "total": 0
    }
  },
  "data": [
    {
      "attributes": {
        "created_at": "1970-01-01T00:00:00.000",
        "published_at": "1970-01-01T00:00:00.000",
        "description": "Formal dresswear",
        "label": "category",
        "name": "Formal dresswear",
        "slug": "formal",
        "curated_products": [
          "8dbb35b2-ef04-477e-974d-e5f3abe6faae"
        ],
        "status": "live",
        "shopper_attributes": {},
        "updated_at": "1970-01-01T00:00:00.000"
      },
      "id": "e871df93-c769-49a9-9394-a6fd555b8e8a",
      "relationships": {
        "products": {
          "data": [
            {
              "id": null,
              "type": null
            }
          ],
          "links": {
            "related": "string"
          }
        },
        "children": {
          "links": {
            "related": "string"
          }
        },
        "parent": {
          "data": {
            "type": "node",
            "id": "8fccaa19-dba9-4621-8d11-31a222a68c7c"
          },
          "links": {
            "related": "string"
          }
        },
        "hierarchy": {
          "data": {
            "type": "hierarchy",
            "id": "8fccaa19-dba9-4621-8d11-31a222a68c7c"
          },
          "links": {
            "related": "string"
          }
        }
      },
      "type": "node",
      "meta": {
        "language": "en-GB",
        "bread_crumb": [
          "8dbb35b2-ef04-477e-974d-e5f3abe6faae"
        ],
        "breadcrumbs": [
          {
            "id": "e871df93-c769-49a9-9394-a6fd555b8e8a",
            "name": "Formal dresswear",
            "slug": "formal"
          }
        ],
        "has_children": true
      }
    }
  ],
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}

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

Was this page helpful?