Get By Context All Related Products

Get all Related Products of a Product

GET/catalog/products/{product_id}/relationships/{custom_relationship_slug}/products

Use it in a workflow

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

Request

Path parameters

product_idstringrequired

The product ID.

custom_relationship_slugstringrequired

The custom relationship slug.

Query parameters

filterstring

This endpoints support 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).

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.

Response

Returns 200 with an object. Read it in later steps with {{getByContextAllRelatedProducts.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>

attributesobject23 fields

A product's attributes.

idstring

A unique identifier for a product.

relationshipsobject6 fields

Relationships allow you to move between requests. Includes links to the parent and child products, bundle component products, files, and main images associated with a product.

typestring

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

metaobject25 fields

A product's metadata contains information about products, for example, the nodes a product is associated with, any child products, bundle configurations, and so on.

includedobject

Included is an array of resources that are included in the response.

main_imagesarray<object>9 fields

The main images associated with a product.

component_productsarray<object>5 fields

Returns a list of component products in a product bundle. If a bundle has no component products (in other words, is not a product bundle), an empty array is returned.

filesarray<object>9 fields

The files associated with a product.

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": {
        "published_at": "1970-01-01T00:00:00.000",
        "base_product": false,
        "base_product_id": "cdf574bc-e36e-48fc-9eac-01c87839b285",
        "commodity_type": "physical",
        "curated_product": true,
        "upc_ean": "0123456",
        "manufacturer_part_num": "mfn1",
        "tags": [
          "tag-a"
        ],
        "price_modifiers": [
          "modifier-1"
        ],
        "created_at": "1970-01-01T00:00:00.000",
        "description": "This is a product",
        "name": "Blue shirt"
      },
      "id": "8fccaa19-dba9-4621-8d11-31a222a68c7c",
      "relationships": {
        "parent": {
          "data": {
            "id": "00000000-0000-0000-0000-000000000000",
            "type": "product"
          }
        },
        "children": {
          "data": [
            {
              "id": null,
              "type": null
            }
          ],
          "links": {
            "self": "string"
          }
        },
        "files": {
          "data": [
            {
              "type": null,
              "id": null,
              "created_at": null
            }
          ]
        },
        "main_image": {
          "data": {
            "type": "main_image",
            "id": "00000000-0000-0000-0000-000000000000"
          }
        },
        "component_products": {
          "data": [
            {
              "id": null,
              "type": null
            }
          ],
          "links": {
            "self": "string"
          }
        },
        "custom_relationships": {
          "data": [
            {
              "id": null,
              "type": null
            }
          ],
          "links": {}
        }
      },
      "type": "product",
      "meta": {
        "bread_crumbs": {},
        "bread_crumb_nodes": [
          "8dbb35b2-ef04-477e-974d-e5f3abe6faae"
        ],
        "catalog_id": "362a16dc-f7c6-4280-83d6-4fcc152af091",
        "pricebook_id": "f5466169-0037-460c-b181-b02682b6f4de",
        "display_price": {
          "with_tax": {
            "amount": "47500",
            "currency": "USD",
            "formatted": "$475.00",
            "float_price": 475
          },
          "without_tax": {
            "amount": "47500",
            "currency": "USD",
            "formatted": "$475.00",
            "float_price": 475
          }
        },
        "catalog_source": "pim",
        "sale_id": "string",
        "sale_expires": "2025-07-07T14:30:00Z",
        "original_price": {},
        "original_display_price": {
          "with_tax": {
            "amount": "47500",
            "currency": "USD",
            "formatted": "$475.00",
            "float_price": 475
          },
          "without_tax": {
            "amount": "47500",
            "currency": "USD",
            "formatted": "$475.00",
            "float_price": 475
          }
        },
        "bundle_configuration": {
          "selected_options": {
            "games": {
              "p292e1db-c919-4d2f-984a-c2ddc79df024": 2
            },
            "consoles": {
              "759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a": 1
            }
          }
        },
        "component_products": {}
      }
    }
  ],
  "included": {
    "main_images": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "type": "file",
        "file_name": "file_name.jpg",
        "mime_type": "image/jpeg",
        "file_size": 36000,
        "public": true,
        "meta": {
          "timestamps": {
            "created_at": "2023-10-11T13:02:25.293Z"
          },
          "dimensions": {
            "width": 1800,
            "height": 1000
          }
        },
        "links": {
          "self": "https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52"
        },
        "link": {
          "href": "https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png",
          "meta": {
            "results": {
              "total": null
            }
          }
        }
      }
    ],
    "component_products": [
      {
        "attributes": {
          "published_at": "1970-01-01T00:00:00.000",
          "base_product": false,
          "base_product_id": "cdf574bc-e36e-48fc-9eac-01c87839b285",
          "commodity_type": "physical",
          "curated_product": true,
          "upc_ean": "0123456",
          "manufacturer_part_num": "mfn1",
          "tags": [
            "tag-a"
          ],
          "price_modifiers": [
            "modifier-1"
          ],
          "created_at": "1970-01-01T00:00:00.000",
          "description": "This is a product",
          "name": "Blue shirt"
        },
        "id": "8fccaa19-dba9-4621-8d11-31a222a68c7c",
        "relationships": {
          "parent": {
            "data": {
              "id": null,
              "type": null
            }
          },
          "children": {
            "data": [
              null
            ],
            "links": {
              "self": null
            }
          },
          "files": {
            "data": [
              null
            ]
          },
          "main_image": {
            "data": {
              "type": null,
              "id": null
            }
          },
          "component_products": {
            "data": [
              null
            ],
            "links": {
              "self": null
            }
          },
          "custom_relationships": {
            "data": [
              null
            ],
            "links": {}
          }
        },
        "type": "product",
        "meta": {
          "bread_crumbs": {},
          "bread_crumb_nodes": [
            "8dbb35b2-ef04-477e-974d-e5f3abe6faae"
          ],
          "catalog_id": "362a16dc-f7c6-4280-83d6-4fcc152af091",
          "pricebook_id": "f5466169-0037-460c-b181-b02682b6f4de",
          "display_price": {
            "with_tax": {
              "amount": null,
              "currency": null,
              "formatted": null,
              "float_price": null
            },
            "without_tax": {
              "amount": null,
              "currency": null,
              "formatted": null,
              "float_price": null
            }
          },
          "catalog_source": "pim",
          "sale_id": "string",
          "sale_expires": "2025-07-07T14:30:00Z",
          "original_price": {},
          "original_display_price": {
            "with_tax": {
              "amount": null,
              "currency": null,
              "formatted": null,
              "float_price": null
            },
            "without_tax": {
              "amount": null,
              "currency": null,
              "formatted": null,
              "float_price": null
            }
          },
          "bundle_configuration": {
            "selected_options": {
              "games": {
                "p292e1db-c919-4d2f-984a-c2ddc79df024": 2
              },
              "consoles": {
                "759ce0d7-e248-4f57-8ee1-6fd81a1b3c0a": 1
              }
            }
          },
          "component_products": {}
        }
      }
    ],
    "files": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "type": "file",
        "file_name": "file_name.jpg",
        "mime_type": "image/jpeg",
        "file_size": 36000,
        "public": true,
        "meta": {
          "timestamps": {
            "created_at": "2023-10-11T13:02:25.293Z"
          },
          "dimensions": {
            "width": 1800,
            "height": 1000
          }
        },
        "links": {
          "self": "https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52"
        },
        "link": {
          "href": "https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png",
          "meta": {
            "results": {
              "total": null
            }
          }
        }
      }
    ]
  },
  "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?