• PXM Catalogs/
    PXM Shopper Catalog API/
    Get a Node

    Get a Node

    GET Get a Node


    Returns a node from the catalog.

    If you have multiple catalog rules defined, the rule that best matches the shopperʼs context is used to determine which catalog to retrieve. For information about how catalog rules are matched, see Resolving Catalog Rules.

    You can see the parent nodes a node is associated with in the bread_crumb metadata for each node. This is useful if you want to improve how your shoppers search your store, for example. For more information, see Catalog Releases Overview.

    You can curate the products in a node. Product curation allows you to promote specific products within each of your nodes, enabling you to create unique product collections in your storefront. You can do this using a filter. See Filtering.


    Path parameters

    nodeIdRequiredstringThe unique identifier of a hierarchy node.


    AuthorizationRequiredstringThe Bearer token to grant access to the API. Implicit Bearer token only returns products with live status; products with draft status are not included.
    X-Moltin-Customer-TokenOptionalstringThe unique identifier of a signed-in customer. Corresponds to the customer_ids attribute in a rule object.
    EP-ChannelOptionalstringThe channel, such as website or mobile app. Corresponds to the channel attribute in a rule object.
    EP-Context-TagOptionalstringA tag defined in the store, such as clearance. Corresponds to the tag attribute in a rule object.
    accept-languageOptionalstringThe natural language and locale that your storefront prefers. See accept-language.


    The following table describes the supported operator and attributes when applying filters to the Get a Node from a Catalog endpoint:

    inReturns the specified product IDs in the order specified in the string. Wildcards are supported. For example, /catalog/6dff977e-a8c4-4e32-8d2c-407266dde6dd/nodes/36bb85d0-4b7c-4667-a933-a4ff714f9282/products?filter=in(id,9214719b-17fe-4ea7-896c-d61e60fc0d05,e104d541-2c52-47fa-8a9a-c4382480d97c,65daaf68-ff2e-4632-8944-370de835967d)product Id

    When using the in filter, you should add the products IDs in the order you want them to be displayed in your node. The first product IDs is displayed first in the product list.

    • If you don't provide any curated_products, products are listed by their updated_at time in descending order, with the most recently updated product first.
    • If you configure curated_products for only a few products, the curated products are displayed first and the other products are displayed in the order of updated_at time.
    • You can only curate 20 products or less. You cannot have more than 20 curated products.
    • A product that is curated has the "curated_product": true attribute displayed.
    • If a curated product is removed from a node, the product is also removed from the curated_products list.

    An example filter is shown below.


    Request Example

    curl -X GET https://api.moltin.com/catalog/nodes/39f96a3f-5577-473f-a263-f21fb2013469 \
         -H "Authorization: Bearer XXXX" \
         -H "EP-Channel: web store" \

    Response Example

    200 OK

        "data": {
            "id": "39f96a3f-5577-473f-a263-f21fb2013469",
            "type": "node",
            "attributes": {
                "created_at": "2021-03-08T17:50:14.629Z",
                "description": "All cooling units for food",
                "name": "Refrigerators",
                "slug": "Refrigerators-MA1",
                "curated_products": [
                "updated_at": "2021-03-08T17:50:14.629Z",
                "published_at": "2021-04-13T02:36:16.505Z"
            "meta": {
                "bread_crumb": [
            "relationships": {
                "children": {
                    "links": {
                        "related": "/catalog/nodes/39f96a3f-5577-473f-a263-f21fb2013469/relationships/children"
                "hierarchy": {
                    "data": {
                        "id": "0e119de2-5fb0-4bca-9b84-b3fc6c903007",
                        "type": "hierarchy"
                    "links": {
                        "related": "/catalog/hierarchies/0e119de2-5fb0-4bca-9b84-b3fc6c903007"
                "parent": {
                    "data": {
                        "id": "0e119de2-5fb0-4bca-9b84-b3fc6c903007",
                        "type": "node"
                    "links": {
                        "related": "/catalog/nodes/0e119de2-5fb0-4bca-9b84-b3fc6c903007"
                "products": {
                    "links": {
                        "related": "/catalog/nodes/39f96a3f-5577-473f-a263-f21fb2013469/relationships/products"
        "links": {
            "self": "/catalog/nodes/39f96a3f-5577-473f-a263-f21fb2013469"

    Was this helpful?

    Get all Nodes