Elastic Path Product Relationships API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Product Relationships. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
7 operations
across 3 paths,
and defines 22 schemas.
It is described by OpenAPI 3.1.0, at version 25.1126.6886238.
Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.
7 operations3 paths22 schemas2 DELETE3 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Elastic Path Product Relationships API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerToken).
By default, every request must be authenticated.
Paths & Operations 7
Across 3 paths, the API surfaces 7 operations — 2 DELETE, 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are elastic_path_file (9 properties), req_attributes_custom_relationship (7 properties), product_response (5 properties), multi_links (5 properties). Each schema is shown below with its type and property counts.
product_association_delete_request
object
1 property1 required
multi_links_cr
object
Links are used to allow you to move between requests.
4 properties
product_build_rules
object
You can build a combination of child products associated with a product, based on build rules that you specify. This is useful, for example, if you have a vari…
3 properties
custom_relationship
object
4 properties4 required
error
object
1 property1 required
product_association_response
object
1 property
req_attributes_custom_relationship
object
7 properties2 required
attach_custom_relationship_request
object
1 property1 required
multi_meta
object
1 property
admin_attributes
object
adminattributes are not displayed in catalogs. This means adminattributes can only be viewed by administrators. If you want a custom attribute to be displayed…
elastic_path_file
object
9 properties
multi_links
object
Links allow you to navigate between pages of results. :::caution Planned pagination changes — on or after 1 September 2026 The pagination behaviour of PIM list…
5 properties
multi_product_response
object
4 properties
shopper_attributes
object
shopperattributes are displayed in catalogs. This means shopperattributes can be viewed by both shoppers and administrators. If you do not want a custom attrib…
included_response
object
Included is an array of resources that are included in the response.
3 properties
product_association_list_product_ids_response
object
1 property1 required
multi_custom_relationships
object
3 properties2 required
product_locales
object
Product Experience Manager supports localization of products and hierarchies. If your store supports multiple languages, you can localize product names and des…
product_association_request
object
1 property1 required
product_response
object
5 properties
product_bundle_components
object
With Product Experience Manager, you can create and manage bundles. A bundle is a purchasable product, consisting of one or more products that you want to sell…
product_custom_inputs
object
You use the custominputs attribute to allow your shoppers to add custom text to a product when adding product items to their carts. This is useful, for example…
Specification
The full machine-readable OpenAPI contract behind this narrative.
