Get By Context Node

Get a Node

GET/catalog/nodes/{node_id}

Use it in a workflow

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

Request

Path parameters

node_idstringrequired

The catalog node ID.

Headers

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.

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 {{getByContextNode.response.data.<field>}}.

dataobject

A category node in a catalog. Nodes can have child nodes, as well as a list of attached products.

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

{
  "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": "00000000-0000-0000-0000-000000000000",
            "type": "product"
          }
        ],
        "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?