Skip to main content

Get a product's nodes

GET 

https://euwest.api.elasticpath.com/pcm/products/:productID/nodes

Returns the nodes associated with the product. Products must be in a live status.

Request

Path Parameters

    productID stringrequired

    A unique identifier for the product.

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

Successfully returns the product's nodes.

Schema
    data object[]required

    An array of nodes.

  • Array [
  • idstringrequired

    The unique identifier of a node.

    typestringrequired

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

    Possible values: [node]

    attributes objectrequired
    namestring

    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.

    descriptionstring

    A description for a node.

    slugstring

    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_productsstring[]

    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.

    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.

    namestring

    A localized hierarchy or node name.

    descriptionstring

    A localized hierarchy or node description.

    relationships objectrequired

    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.

    dataarray

    An array of child nodes.

    links object

    Links allow you to move between requests.

    relatedstring

    A link to a related resource.

    parent object

    The parent node related to the resource

    data object

    The parent node

    typestringrequired

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

    Possible values: [node]

    idstringrequired

    The unique identifier of a node.

    products object

    The products related to the resource.

    dataarray

    An array of products.

    links object

    Links allow you to move between requests.

    relatedstring

    A link to a related resource.

    meta objectrequired
    sort_orderinteger

    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_atdate-time

    The date and time a node is created.

    Example: 2020-09-22T09:00:00
    updated_atdate-time

    The date and time a node was updated.

    Example: 2020-09-22T09:00:00
    parent_namestring

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

    ownerstring

    The node owner, either organization or store.

    Possible values: [store, organization]

    hierarchy_idstring

    The unique identifier of hierarchy

    breadcrumbs object[]

    Breadcrumbs

  • Array [
  • idstring

    The unique identifier of a hierarchy/node.

    namestring

    The name of the hierarchy/node.

    slugstring

    A slug for the hierarchy/node.

    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.

    namestring

    A localized hierarchy or node name.

  • ]
  • ]
  • meta object
    results object

    Contains the results for the entire collection.

    totalinteger

    Total number of results for the entire collection.

    Example: 30
    links object

    Links are used to allow you to move between requests.

    firststring

    Always the first page.

    Example: /pcm/hierarchies?page[offset]=0&page[limit]=10
    laststring

    This is null if there is only one page.

    Example: /pcm/hierarchies?page[offset]=20&page[limit]=10
    nextstring

    This is null if there is only one page.

    Example: /pcm/hierarchies?page[offset]=10&page[limit]=10
    prevstring

    This is null if you on the first page.

    Example: /pcm/hierarchies?page[offset]=8&page[limit]=10

Authorization: http

name: bearerAuthtype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://euwest.api.elasticpath.com/pcm/products/:productID/nodes");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://euwest.api.elasticpath.com
Auth
Parameters
— pathrequired
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!

We use cookies to enhance your experience. By continuing to visit this site you agree to our use of cookies.