Get all Related Products of a Product

GET 
https://euwest.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/products/:product_id/relationships/:custom_relationship_slug/products

Returns related products of the provided product ID from a published catalog.

Request

Path Parameters

catalog_id stringrequired

The catalog ID.

release_id stringrequired

The unique identifier of a published release of the catalog or latestPublished for the most recently published version.

product_id stringrequired

The product ID.

custom_relationship_slug stringrequired

The custom relationship slug.

Query Parameters

filter string

This endpoints support filtering. See Filtering.

page[limit] int64

Possible values: >= 1

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 store setting is used.

page[offset] int64

Possible values: <= 10000

The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the page length store setting is used.

Header Parameters

accept-language string

The language and locale your storefront prefers. See Accept-Language.

Responses

200

The related products of a catalog.

application/json

Schema

Schema

meta object

Contains the results for the entire collection.

results object

Total number of results for the entire collection.

totalint64

Total number of results for the entire collection.

page object

limitint64

The maximum number of records for all pages.

offsetint64

The current offset by number of pages.

currentint64

The current number of pages.

totalint64

The total number of records for the entire collection.

data object[]

Array [

attributes object

A product's attributes.

published_atdate-timenullable

The date and time a product was published in a catalog.

Example: 1970-01-01T00:00:00.000

base_productboolean

If this product is a parent product. A parent product is a product that has child products that have been built using the build child products endpoint.

Default value: false

Example: false

base_product_idstring

The unique identifier of a parent product.

Example: cdf574bc-e36e-48fc-9eac-01c87839b285

commodity_typestring

The commodity type, either physical or digital.

Example: physical

curated_productboolean

If a product is curated, then the curated_product attribute with a value of true is displayed. If a product is not curated, the curated_product attribute is not displayed.

Example: true

upc_eanstring

The universal product code or european article number of the product.

Example: 0123456

manufacturer_part_numstring

The manufacturer part number of the product.

Example: mfn1

tagsstring[]

A list of tags associated with the product. A tag must be HTML compatible characters excluding commas and will be stored in lowercase letters.

price_modifiersstring[]

A list of price modifier names.

created_atdate-time

The date and time a product was created.

Example: 1970-01-01T00:00:00.000

descriptionstring

A description of the product.

Example: This is a product

namestring

A name of a product.

Example: Blue shirt

price object

A collection of one or more currencies objects that consists of the three-letter ISO code of the currencies associated with this price and the amount. This is the product's price.

property name* Amount

The three-letter ISO code for the currency associated with this price.

amountint64

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 100

includes_taxboolean

Whether this price includes tax.

Default value: false

Example: false

shopper_attributes object

A collection of key-value string pairs, viewable by shoppers.

property name*string

tiers object

The price tier that an item is eligible for based on the quantity purchased. You cannot have conflicting tiers within the same currencies block.

property name* Tier

The name of the tier, for example, Pencils.

minimum_quantityinteger

The minimum quantity of 1 or more defined for the specified price. If a minimum quantity is not specified, an error is returned.

Example: 5

price object

A collection of one or more currencies objects that consists of the three-letter ISO code of the currencies associated with this price and the amount. This is the product's price.

property name* Amount

The three-letter ISO code for the currency associated with this price.

amountint64

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 100

includes_taxboolean

Whether this price includes tax.

Default value: false

Example: false

components object

A bundle is a purchasable product, comprising of one or more products that you want to sell together. You can create multiple components within a bundle. Each component must have at least one or more options. Each option is a product and a quantity.

property name* Component Product

The unique identifier of the component, for example, games.

namestring

The component name is the name that is displayed in your storefront.

minintegernullable

The minimum number of product options a shopper can select from this component.

maxintegernullable

The maximum number of product options a shopper can select from this component.

sort_orderintegernullable

The sort order of the components. The create a bundle and update a bundle endpoints do not sort the components. You can use the sort_order attribute when programming your storefront to display the components in the order that you want.

options object[]

The product options included in a component. This can be the ID of another bundle.

Array [

iduuid

A unique identifier of the product you want to add to a component.

typestring

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

Possible values: [product]

Default value: product

Example: product

quantityinteger

The number of this product option that a shopper must purchase.

Example: 2

sort_orderintegernullable

The sort order of the options. The create a bundle and update a bundle endpoints do not sort the options. You can use the sort_order attribute when programming your storefront to display the options in the order that you want.

Example: 15

defaultbooleannullable

The boolean indicates whether the current option is a default option for the component.

Default value: false

Example: true

product_should_be_substituted_with_childbooleannullable

Indicates that the parent product added to a bundle is not directly purchasable. When set to true, the child products of the parent product should be displayed as options for selection in the bundle.

Example: true

excluded_childrenstring[]

Merchants can exclude specific child products from a parent product when configuring a bundle.

Example: ["2d491d1c-729d-43d7-a2d2-e0a56edab43d"]

]

custom_inputs object

You can allow your shoppers to add custom text to a product when adding product items to their carts. This is useful, for example, if you have a product like a T-shirt that can be personalized or you sell greetings cards that can be printed with your shoppers personalized messages. You can do this using the custom_inputs attribute.

• You can rename input to something more representative of the input that shoppers are adding, for example, message or front.
• name is the name that is displayed in your storefront.
• You can add validation rules. For example, the input field must be a string and/or up to 255 characters in length. The limit is 255 characters.

property name* Custom Input

The name of the custom input. You can rename the input to something more representative of the input that shoppers are adding, for example, message or front.

namestring

The name for the custom text field that is displayed in your storefront.

Example: Message

validation_rules object[]

The validation rules for the custom text.

Array [

typestring

This represents the type of object being returned. Must be string.

Possible values: [string]

Default value: string

Example: string

options object

The length of the custom input text field.

max_lengthinteger

The number of characters the custom text field can be. You can specify a maximum length up to 255 characters, as the limit is 255 characters.

Example: 255

]

requiredbooleannullable

This is true or false depending on whether the custom text is required.

Default value: false

Example: false

skustring

The unique stock keeping unit of the product.

Example: blue-shirt

slugstring

A label for the product that is used in the URL paths. A slug can contain A to Z, a to z, 0 to 9, hyphen, underscore, and period. Spaces or other special characters like ^, [], *, and $ are not allowed. By default, the product name is used as the slug.

Example: blue-shirt

statusstring

The status of the product, either live or draft.

Example: live

external_refstringnullable

The unique attribute associated with the product. This could be an external reference from a separate company system, for example.

updated_atdate-time

The date and time a product was updated.

Example: 1970-01-01T00:00:00.000

extensions object

With extension templates, you can attach a specific set of custom fields to your products in Product Experience Manager. For example, a Book template might contain the attributes, such as ISBN, Author, Number of pages, Year Published, or Condition (New/Used).

property name* Extension

The name of the product template.

property name*object

The product attributes available for this template.

idstring

A unique identifier for a product.

Example: 8fccaa19-dba9-4621-8d11-31a222a68c7c

relationships object

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.

parent object

The details of a parent product. A parent product is a product that has child products that have been built using the Build Child Products endpoint.

data object

A product identifier.

iduuid

A unique identifier for a product.

typestring

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

Possible values: [product]

Example: product

children object

The details of a child product. When you configure product variations and variation options for parent products, the child products derived from the parent products are automatically created in Commerce.

data object[]

A list of product identifiers.

Array [

iduuid

A unique identifier for a product.

typestring

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

Possible values: [product]

Example: product

]

links object

Links are used to allow you to move between requests.

selfstringrequired

Single entities use a self parameter with a link to that specific resource.

files object

In Product Experience Manager, products can have associated rich media assets, such as product images or a file containing additional product details.

data object[]

Array [

typestring

This represents the type of object being returned. Always file.

Possible values: [file]

Example: file

iduuid

A unique identifier for a file.

created_atdate-time

The date and time a file is created.

Example: 1970-01-01T00:00:00.000

]

main_image object

In Product Experience Manager, products can also have associated product images.

data object

The images associated with a product.

typestring

This represents the type of object being returned. Always main_image.

Possible values: [main_image]

Example: main_image

iduuid

A unique identifier for an image.

component_products object

A bundle is a purchasable product, comprising of one or more products that you want to sell together. You can create multiple components within a bundle. Each component must have at least one or more options. Each option is a product and a quantity. You can link to the products that make up your bundle components.

data object[]

A list of product identifiers.

Array [

iduuid

A unique identifier for a product.

typestring

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

Possible values: [product]

Example: product

]

links object

Links are used to allow you to move between requests.

selfstringrequired

Single entities use a self parameter with a link to that specific resource.

custom_relationships object

A product can have custom relationships added that link to other products. These can be used for Parent/Child relationships as well as products that you want to Cross Sell/Promote.

data object[]

A list of product identifiers.

Array [

iduuid

A unique identifier for a product.

typestring

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

Possible values: [product]

Example: product

]

linksobject

For each custom relationship in use on the product, there will be a link to follow.

typestring

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

Example: product

meta object

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.

bread_crumbs object

The relationship among the array of nodes a product is associated with, demonstrating the linking of the children nodes with the parent nodes. Up to 10 levels of parent nodes are displayed, depending on the number of levels of parent nodes you have.

property name* string[]

Array [

string

Example: 8dbb35b2-ef04-477e-974d-e5f3abe6faae

]

bread_crumb_nodesstring[]

An array of parent node IDs that a product is associated with. Up to 10 levels of parent nodes are displayed, depending on the number of levels of parent nodes you have.

catalog_idstring

A unique identifier of the catalog a product is associated with.

Example: 362a16dc-f7c6-4280-83d6-4fcc152af091

pricebook_idstringnullable

The unique identifier of the price book a product is associated with.

Example: f5466169-0037-460c-b181-b02682b6f4de

display_price object

A price formatted for display.

with_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

without_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

catalog_sourcestring

The source of a catalog. Always pim.

Possible values: [pim]

Example: pim

sale_idstring

With sales pricing, a store can optionally add a sale price to a product price. For example, a store can schedule seasonal pricing on products without creating a new price book and catalog ruleset. Optionally, a store can schedule the date ranges for the sale products. This is the unique identifier of a sale.

sale_expiresdate-timenullable

The date and time a sale expires.

Example: 1970-01-01T00:00:00.000

original_price object

A collection of one or more currencies objects that consists of the three-letter ISO code of the currencies associated with this price and the amount. This is the product's price.

property name* Amount

The three-letter ISO code for the currency associated with this price.

amountint64

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 100

includes_taxboolean

Whether this price includes tax.

Default value: false

Example: false

original_display_price object

A price formatted for display.

with_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

without_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

bundle_configuration object

A bundle is a purchasable product, comprising of one or more products that you want to sell together. You can create multiple components within a bundle. Each component must have at least one or more options. Each option is a product and a quantity.

selected_options objectrequired

The product options included in a component. This can be the ID of another bundle.

property name* object

The unique identifier of the component, for example, games.

property name*int64

The number of this product option that a shopper must purchase.

component_products object

A bundle is a purchasable product, comprising of one or more products that you want to sell together. You can create multiple components within a bundle. Each component must have at least one or more options. Each option is a product and a quantity.

property name* object

sale_idstring

With sales pricing, a store can optionally add a sale price to a product price. For example, a store can schedule seasonal pricing on products without creating a new price book and catalog ruleset. Optionally, a store can schedule the date ranges for the sale products. This is the unique identifier of a sale.

sale_expiresdate-timenullable

The date and time a sale expires.

Example: 1970-01-01T00:00:00.000

price object

A collection of one or more currencies objects that consists of the three-letter ISO code of the currencies associated with this price and the amount. This is the product's price.

property name* Amount

The three-letter ISO code for the currency associated with this price.

amountint64

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 100

includes_taxboolean

Whether this price includes tax.

Default value: false

Example: false

display_price object

A price formatted for display.

with_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

without_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

original_price object

A collection of one or more currencies objects that consists of the three-letter ISO code of the currencies associated with this price and the amount. This is the product's price.

property name* Amount

The three-letter ISO code for the currency associated with this price.

amountint64

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 100

includes_taxboolean

Whether this price includes tax.

Default value: false

Example: false

original_display_price object

A price formatted for display.

with_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

without_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

pricebook_idstringnullable

Example: f5466169-0037-460c-b181-b02682b6f4de

component_product_data object

This will contain the component product details (with bundle specific pricing) in the configure bundle response for the selected options.

price_modifiers object

You can use price modifiers to change the price property of child products. By default, child products inherit the same price as their base products. Using price modifiers, you can enable child products to inherit a different price.

property name* object

A name for the modifier. The name must be unique and is case-sensitive.

modifier_typestring

There are three modifier types.

• The price_increment type increases the prices of a product.
• The price_decrement type decreases the price of a product.
• The price_equals type sets the price of a product to an amount you specify.

Example: price_equals

currencies object

A collection of one or more currencies objects that consists of the three-letter ISO code of the currencies associated with this price and the amount. This is the product's price.

property name* Amount

The three-letter ISO code for the currency associated with this price.

amountint64

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 100

includes_taxboolean

Whether this price includes tax.

Default value: false

Example: false

tiers object

You can use tiers to allow your store to offer different pricing for minimum quantities of items that your shoppers purchase.

property name* object

The name of the tier, such as Pencils.

sale_idstring

The unique identifier of a sale.

sale_expiresdate-timenullable

The date and time a sale expires.

Example: 1970-01-01T00:00:00.000

display_price object

A price formatted for display.

with_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

without_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

original_price object

A collection of one or more currencies objects that consists of the three-letter ISO code of the currencies associated with this price and the amount. This is the product's price.

property name* Amount

The three-letter ISO code for the currency associated with this price.

amountint64

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 100

includes_taxboolean

Whether this price includes tax.

Default value: false

Example: false

original_display_price object

A price formatted for display.

with_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

without_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

variation_matrixobject

The variation_matrix object lists the variation IDs and variation option IDs and their corresponding product IDs that are generated when the variation and variation options are built with a product. If no variations are available, the variation_matrix is empty.

variations object[]

If you specified build_rules for a product, the variations object lists the variation option IDs that you specified to include when building your child products. If no build_rules are specified, all the variation and variation options available for a product are displayed. If a product does not have any variations, then the variations object is not displayed.

Array [

iduuid

A unique identifier of a variation.

namestring

The name of a variation.

sort_orderintegernullable

If you specified a sort_order when creating your variations and variation options, then use the sort_order value to program your storefront to display the variations and variation options in the order that you want.

option object

The options available for a variation.

iduuid

A unique identifier for an option.

namestring

The name of the option.

sort_orderintegernullable

If you specified a sort_order when creating your variations and variation options, then use the sort_order value to program your storefront to display the variations and variation options in the order that you want.

descriptionstring

The option description to display to customers.

options object[]

The options available for this variation.

Array [

iduuid

A unique identifier for an option.

namestring

The name of the option.

sort_orderintegernullable

If you specified a sort_order when creating your variations and variation options, then use the sort_order value to program your storefront to display the variations and variation options in the order that you want.

descriptionstring

The option description to display to customers.

]

]

child_option_idsstring[]nullable

An array of variation options IDs that a child product has.

child_variations object[]nullable

If this is a child product, the child_variations object lists the variation option IDs that define this child product.

Array [

iduuid

A unique identifier of a variation.

namestring

The name of a variation.

sort_orderintegernullable

If you specified a sort_order when creating your variations and variation options, then use the sort_order value to program your storefront to display the variations and variation options in the order that you want.

option object

The options available for a variation.

iduuid

A unique identifier for an option.

namestring

The name of the option.

sort_orderintegernullable

If you specified a sort_order when creating your variations and variation options, then use the sort_order value to program your storefront to display the variations and variation options in the order that you want.

descriptionstring

The option description to display to customers.

options object[]

The options available for this variation.

Array [

iduuid

A unique identifier for an option.

namestring

The name of the option.

sort_orderintegernullable

If you specified a sort_order when creating your variations and variation options, then use the sort_order value to program your storefront to display the variations and variation options in the order that you want.

descriptionstring

The option description to display to customers.

]

]

product_typesstring[]

Commerce automatically assigns types to the products you create. In Commerce Manager, you can see at a glance the product types in a list of a products. In addition, you can filter on product types in both the API and Commerce Manager.

Product types can also be used in catalogs. For example, in your catalog, you can filter on parent so that only your parent products are displayed in your storefront.

Products have one of the following types:

• standard - Standard products are a standalone products.
• parent - A parent product is a product that has child products that have been built using the Build Child Products endpoint.
• child - When you configure product variations and variation options for parent products, the child products derived from the parent products are automatically created in Commerce.
• bundle - A bundle is a purchasable product, comprising two or more standalone products (in other words, components) to be sold together.

languagestring

If you storefront supports multiple languages, your storefront's preferred language and locale.

Example: en-GB

custom_relationshipsstring[]

In Commerce Manager you can define Custom Relationships for Products. These allow Merchandisers to set up Cross Sell/Parent Child Relationships between products for display to shoppers. This field will list the slugs(identifiers) of Custom Relationships that have been associated with this product. This will allow conditional rendering of related product sections if needed and provides the slug(s) needed to list the related products for the Product

]

included object

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

main_images object[]

The main images associated with a product.

Array [

iduuid

The unique identifier for this file.

typestring

The type represents the object being returned.

Example: file

file_namestring

The name of the file.

Example: file_name.jpg

mime_typestring

The mime type of the file.

Example: image/jpeg

file_sizeinteger

The size of the file. Required when uploading files.

Example: 36000

publicboolean

DEPRECATED Whether the file public or not. Required when uploading files.

Example: true

meta

timestamps object

The date and time the file was created.

created_atstring

The date and time the file was created.

Example: 2023-10-11T13:02:25.293Z

dimensions object

The file dimensions.

widthinteger

The width of the file.

Example: 1800

heightinteger

The height of the file.

Example: 1000

links object

Links are used to allow you to move between requests.

selfstring

Single entities use a self parameter with a link to that specific resource.

Example: https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52

link object

The publicly available URL for this file.

hrefstring

The publicly available URL for this file.

Example: https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png

meta object

results object

Contains the results for the entire collection.

totalinteger

Total number of results for the entire collection.

Example: 2

]

component_products object[]

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.

Array [

attributes object

A product's attributes.

published_atdate-timenullable

The date and time a product was published in a catalog.

Example: 1970-01-01T00:00:00.000

base_productboolean

If this product is a parent product. A parent product is a product that has child products that have been built using the build child products endpoint.

Default value: false

Example: false

base_product_idstring

The unique identifier of a parent product.

Example: cdf574bc-e36e-48fc-9eac-01c87839b285

commodity_typestring

The commodity type, either physical or digital.

Example: physical

curated_productboolean

If a product is curated, then the curated_product attribute with a value of true is displayed. If a product is not curated, the curated_product attribute is not displayed.

Example: true

upc_eanstring

The universal product code or european article number of the product.

Example: 0123456

manufacturer_part_numstring

The manufacturer part number of the product.

Example: mfn1

tagsstring[]

A list of tags associated with the product. A tag must be HTML compatible characters excluding commas and will be stored in lowercase letters.

price_modifiersstring[]

A list of price modifier names.

created_atdate-time

The date and time a product was created.

Example: 1970-01-01T00:00:00.000

descriptionstring

A description of the product.

Example: This is a product

namestring

A name of a product.

Example: Blue shirt

price object

A collection of one or more currencies objects that consists of the three-letter ISO code of the currencies associated with this price and the amount. This is the product's price.

property name* Amount

The three-letter ISO code for the currency associated with this price.

amountint64

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 100

includes_taxboolean

Whether this price includes tax.

Default value: false

Example: false

shopper_attributes object

A collection of key-value string pairs, viewable by shoppers.

property name*string

tiers object

The price tier that an item is eligible for based on the quantity purchased. You cannot have conflicting tiers within the same currencies block.

property name* Tier

The name of the tier, for example, Pencils.

minimum_quantityinteger

The minimum quantity of 1 or more defined for the specified price. If a minimum quantity is not specified, an error is returned.

Example: 5

price object

A collection of one or more currencies objects that consists of the three-letter ISO code of the currencies associated with this price and the amount. This is the product's price.

property name* Amount

The three-letter ISO code for the currency associated with this price.

amountint64

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 100

includes_taxboolean

Whether this price includes tax.

Default value: false

Example: false

components object

A bundle is a purchasable product, comprising of one or more products that you want to sell together. You can create multiple components within a bundle. Each component must have at least one or more options. Each option is a product and a quantity.

property name* Component Product

The unique identifier of the component, for example, games.

namestring

The component name is the name that is displayed in your storefront.

minintegernullable

The minimum number of product options a shopper can select from this component.

maxintegernullable

The maximum number of product options a shopper can select from this component.

sort_orderintegernullable

The sort order of the components. The create a bundle and update a bundle endpoints do not sort the components. You can use the sort_order attribute when programming your storefront to display the components in the order that you want.

options object[]

The product options included in a component. This can be the ID of another bundle.

Array [

iduuid

A unique identifier of the product you want to add to a component.

typestring

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

Possible values: [product]

Default value: product

Example: product

quantityinteger

The number of this product option that a shopper must purchase.

Example: 2

sort_orderintegernullable

The sort order of the options. The create a bundle and update a bundle endpoints do not sort the options. You can use the sort_order attribute when programming your storefront to display the options in the order that you want.

Example: 15

defaultbooleannullable

The boolean indicates whether the current option is a default option for the component.

Default value: false

Example: true

product_should_be_substituted_with_childbooleannullable

Indicates that the parent product added to a bundle is not directly purchasable. When set to true, the child products of the parent product should be displayed as options for selection in the bundle.

Example: true

excluded_childrenstring[]

Merchants can exclude specific child products from a parent product when configuring a bundle.

Example: ["2d491d1c-729d-43d7-a2d2-e0a56edab43d"]

]

custom_inputs object

You can allow your shoppers to add custom text to a product when adding product items to their carts. This is useful, for example, if you have a product like a T-shirt that can be personalized or you sell greetings cards that can be printed with your shoppers personalized messages. You can do this using the custom_inputs attribute.

• You can rename input to something more representative of the input that shoppers are adding, for example, message or front.
• name is the name that is displayed in your storefront.
• You can add validation rules. For example, the input field must be a string and/or up to 255 characters in length. The limit is 255 characters.

property name* Custom Input

The name of the custom input. You can rename the input to something more representative of the input that shoppers are adding, for example, message or front.

namestring

The name for the custom text field that is displayed in your storefront.

Example: Message

validation_rules object[]

The validation rules for the custom text.

Array [

typestring

This represents the type of object being returned. Must be string.

Possible values: [string]

Default value: string

Example: string

options object

The length of the custom input text field.

max_lengthinteger

The number of characters the custom text field can be. You can specify a maximum length up to 255 characters, as the limit is 255 characters.

Example: 255

]

requiredbooleannullable

This is true or false depending on whether the custom text is required.

Default value: false

Example: false

skustring

The unique stock keeping unit of the product.

Example: blue-shirt

slugstring

A label for the product that is used in the URL paths. A slug can contain A to Z, a to z, 0 to 9, hyphen, underscore, and period. Spaces or other special characters like ^, [], *, and $ are not allowed. By default, the product name is used as the slug.

Example: blue-shirt

statusstring

The status of the product, either live or draft.

Example: live

external_refstringnullable

The unique attribute associated with the product. This could be an external reference from a separate company system, for example.

updated_atdate-time

The date and time a product was updated.

Example: 1970-01-01T00:00:00.000

extensions object

With extension templates, you can attach a specific set of custom fields to your products in Product Experience Manager. For example, a Book template might contain the attributes, such as ISBN, Author, Number of pages, Year Published, or Condition (New/Used).

property name* Extension

The name of the product template.

property name*object

The product attributes available for this template.

idstring

A unique identifier for a product.

Example: 8fccaa19-dba9-4621-8d11-31a222a68c7c

relationships object

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.

parent object

The details of a parent product. A parent product is a product that has child products that have been built using the Build Child Products endpoint.

data object

A product identifier.

iduuid

A unique identifier for a product.

typestring

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

Possible values: [product]

Example: product

children object

The details of a child product. When you configure product variations and variation options for parent products, the child products derived from the parent products are automatically created in Commerce.

data object[]

A list of product identifiers.

Array [

iduuid

A unique identifier for a product.

typestring

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

Possible values: [product]

Example: product

]

links object

Links are used to allow you to move between requests.

selfstringrequired

Single entities use a self parameter with a link to that specific resource.

files object

In Product Experience Manager, products can have associated rich media assets, such as product images or a file containing additional product details.

data object[]

Array [

typestring

This represents the type of object being returned. Always file.

Possible values: [file]

Example: file

iduuid

A unique identifier for a file.

created_atdate-time

The date and time a file is created.

Example: 1970-01-01T00:00:00.000

]

main_image object

In Product Experience Manager, products can also have associated product images.

data object

The images associated with a product.

typestring

This represents the type of object being returned. Always main_image.

Possible values: [main_image]

Example: main_image

iduuid

A unique identifier for an image.

component_products object

A bundle is a purchasable product, comprising of one or more products that you want to sell together. You can create multiple components within a bundle. Each component must have at least one or more options. Each option is a product and a quantity. You can link to the products that make up your bundle components.

data object[]

A list of product identifiers.

Array [

iduuid

A unique identifier for a product.

typestring

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

Possible values: [product]

Example: product

]

links object

Links are used to allow you to move between requests.

selfstringrequired

Single entities use a self parameter with a link to that specific resource.

custom_relationships object

A product can have custom relationships added that link to other products. These can be used for Parent/Child relationships as well as products that you want to Cross Sell/Promote.

data object[]

A list of product identifiers.

Array [

iduuid

A unique identifier for a product.

typestring

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

Possible values: [product]

Example: product

]

linksobject

For each custom relationship in use on the product, there will be a link to follow.

typestring

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

Example: product

meta object

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.

bread_crumbs object

The relationship among the array of nodes a product is associated with, demonstrating the linking of the children nodes with the parent nodes. Up to 10 levels of parent nodes are displayed, depending on the number of levels of parent nodes you have.

property name* string[]

Array [

string

Example: 8dbb35b2-ef04-477e-974d-e5f3abe6faae

]

bread_crumb_nodesstring[]

An array of parent node IDs that a product is associated with. Up to 10 levels of parent nodes are displayed, depending on the number of levels of parent nodes you have.

catalog_idstring

A unique identifier of the catalog a product is associated with.

Example: 362a16dc-f7c6-4280-83d6-4fcc152af091

pricebook_idstringnullable

The unique identifier of the price book a product is associated with.

Example: f5466169-0037-460c-b181-b02682b6f4de

display_price object

A price formatted for display.

with_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

without_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

catalog_sourcestring

The source of a catalog. Always pim.

Possible values: [pim]

Example: pim

sale_idstring

With sales pricing, a store can optionally add a sale price to a product price. For example, a store can schedule seasonal pricing on products without creating a new price book and catalog ruleset. Optionally, a store can schedule the date ranges for the sale products. This is the unique identifier of a sale.

sale_expiresdate-timenullable

The date and time a sale expires.

Example: 1970-01-01T00:00:00.000

original_price object

A collection of one or more currencies objects that consists of the three-letter ISO code of the currencies associated with this price and the amount. This is the product's price.

property name* Amount

The three-letter ISO code for the currency associated with this price.

amountint64

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 100

includes_taxboolean

Whether this price includes tax.

Default value: false

Example: false

original_display_price object

A price formatted for display.

with_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

without_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

bundle_configuration object

A bundle is a purchasable product, comprising of one or more products that you want to sell together. You can create multiple components within a bundle. Each component must have at least one or more options. Each option is a product and a quantity.

selected_options objectrequired

The product options included in a component. This can be the ID of another bundle.

property name* object

The unique identifier of the component, for example, games.

property name*int64

The number of this product option that a shopper must purchase.

component_products object

A bundle is a purchasable product, comprising of one or more products that you want to sell together. You can create multiple components within a bundle. Each component must have at least one or more options. Each option is a product and a quantity.

property name* object

sale_idstring

With sales pricing, a store can optionally add a sale price to a product price. For example, a store can schedule seasonal pricing on products without creating a new price book and catalog ruleset. Optionally, a store can schedule the date ranges for the sale products. This is the unique identifier of a sale.

sale_expiresdate-timenullable

The date and time a sale expires.

Example: 1970-01-01T00:00:00.000

price object

A collection of one or more currencies objects that consists of the three-letter ISO code of the currencies associated with this price and the amount. This is the product's price.

property name* Amount

The three-letter ISO code for the currency associated with this price.

amountint64

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 100

includes_taxboolean

Whether this price includes tax.

Default value: false

Example: false

display_price object

A price formatted for display.

with_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

without_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

original_price object

A collection of one or more currencies objects that consists of the three-letter ISO code of the currencies associated with this price and the amount. This is the product's price.

property name* Amount

The three-letter ISO code for the currency associated with this price.

amountint64

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 100

includes_taxboolean

Whether this price includes tax.

Default value: false

Example: false

original_display_price object

A price formatted for display.

with_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

without_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

pricebook_idstringnullable

Example: f5466169-0037-460c-b181-b02682b6f4de

component_product_data object

This will contain the component product details (with bundle specific pricing) in the configure bundle response for the selected options.

price_modifiers object

You can use price modifiers to change the price property of child products. By default, child products inherit the same price as their base products. Using price modifiers, you can enable child products to inherit a different price.

property name* object

A name for the modifier. The name must be unique and is case-sensitive.

modifier_typestring

There are three modifier types.

• The price_increment type increases the prices of a product.
• The price_decrement type decreases the price of a product.
• The price_equals type sets the price of a product to an amount you specify.

Example: price_equals

currencies object

A collection of one or more currencies objects that consists of the three-letter ISO code of the currencies associated with this price and the amount. This is the product's price.

property name* Amount

The three-letter ISO code for the currency associated with this price.

amountint64

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 100

includes_taxboolean

Whether this price includes tax.

Default value: false

Example: false

tiers object

You can use tiers to allow your store to offer different pricing for minimum quantities of items that your shoppers purchase.

property name* object

The name of the tier, such as Pencils.

sale_idstring

The unique identifier of a sale.

sale_expiresdate-timenullable

The date and time a sale expires.

Example: 1970-01-01T00:00:00.000

display_price object

A price formatted for display.

with_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

without_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

original_price object

A collection of one or more currencies objects that consists of the three-letter ISO code of the currencies associated with this price and the amount. This is the product's price.

property name* Amount

The three-letter ISO code for the currency associated with this price.

amountint64

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 100

includes_taxboolean

Whether this price includes tax.

Default value: false

Example: false

original_display_price object

A price formatted for display.

with_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

without_tax object

A price formatted for display.

amountinteger

The price in the lowest denomination for the specified currency. This is a product's list price.

Example: 47500

currencystring

The three-letter ISO code of the currencies associated with this price and the amount.

Example: USD

formattedstring

The format of the price for display.

Example: $475.00

variation_matrixobject

The variation_matrix object lists the variation IDs and variation option IDs and their corresponding product IDs that are generated when the variation and variation options are built with a product. If no variations are available, the variation_matrix is empty.

variations object[]

If you specified build_rules for a product, the variations object lists the variation option IDs that you specified to include when building your child products. If no build_rules are specified, all the variation and variation options available for a product are displayed. If a product does not have any variations, then the variations object is not displayed.

Array [

iduuid

A unique identifier of a variation.

namestring

The name of a variation.

sort_orderintegernullable

If you specified a sort_order when creating your variations and variation options, then use the sort_order value to program your storefront to display the variations and variation options in the order that you want.

option object

The options available for a variation.

iduuid

A unique identifier for an option.

namestring

The name of the option.

sort_orderintegernullable

If you specified a sort_order when creating your variations and variation options, then use the sort_order value to program your storefront to display the variations and variation options in the order that you want.

descriptionstring

The option description to display to customers.

options object[]

The options available for this variation.

Array [

iduuid

A unique identifier for an option.

namestring

The name of the option.

sort_orderintegernullable

If you specified a sort_order when creating your variations and variation options, then use the sort_order value to program your storefront to display the variations and variation options in the order that you want.

descriptionstring

The option description to display to customers.

]

]

child_option_idsstring[]nullable

An array of variation options IDs that a child product has.

child_variations object[]nullable

If this is a child product, the child_variations object lists the variation option IDs that define this child product.

Array [

iduuid

A unique identifier of a variation.

namestring

The name of a variation.

sort_orderintegernullable

If you specified a sort_order when creating your variations and variation options, then use the sort_order value to program your storefront to display the variations and variation options in the order that you want.

option object

The options available for a variation.

iduuid

A unique identifier for an option.

namestring

The name of the option.

sort_orderintegernullable

If you specified a sort_order when creating your variations and variation options, then use the sort_order value to program your storefront to display the variations and variation options in the order that you want.

descriptionstring

The option description to display to customers.

options object[]

The options available for this variation.

Array [

iduuid

A unique identifier for an option.

namestring

The name of the option.

sort_orderintegernullable

If you specified a sort_order when creating your variations and variation options, then use the sort_order value to program your storefront to display the variations and variation options in the order that you want.

descriptionstring

The option description to display to customers.

]

]

product_typesstring[]

Commerce automatically assigns types to the products you create. In Commerce Manager, you can see at a glance the product types in a list of a products. In addition, you can filter on product types in both the API and Commerce Manager.

Product types can also be used in catalogs. For example, in your catalog, you can filter on parent so that only your parent products are displayed in your storefront.

Products have one of the following types:

• standard - Standard products are a standalone products.
• parent - A parent product is a product that has child products that have been built using the Build Child Products endpoint.
• child - When you configure product variations and variation options for parent products, the child products derived from the parent products are automatically created in Commerce.
• bundle - A bundle is a purchasable product, comprising two or more standalone products (in other words, components) to be sold together.

languagestring

If you storefront supports multiple languages, your storefront's preferred language and locale.

Example: en-GB

custom_relationshipsstring[]

In Commerce Manager you can define Custom Relationships for Products. These allow Merchandisers to set up Cross Sell/Parent Child Relationships between products for display to shoppers. This field will list the slugs(identifiers) of Custom Relationships that have been associated with this product. This will allow conditional rendering of related product sections if needed and provides the slug(s) needed to list the related products for the Product

]

files object[]

The files associated with a product.

Array [

iduuid

The unique identifier for this file.

typestring

The type represents the object being returned.

Example: file

file_namestring

The name of the file.

Example: file_name.jpg

mime_typestring

The mime type of the file.

Example: image/jpeg

file_sizeinteger

The size of the file. Required when uploading files.

Example: 36000

publicboolean

DEPRECATED Whether the file public or not. Required when uploading files.

Example: true

meta

timestamps object

The date and time the file was created.

created_atstring

The date and time the file was created.

Example: 2023-10-11T13:02:25.293Z

dimensions object

The file dimensions.

widthinteger

The width of the file.

Example: 1800

heightinteger

The height of the file.

Example: 1000

links object

Links are used to allow you to move between requests.

selfstring

Single entities use a self parameter with a link to that specific resource.

Example: https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52

link object

The publicly available URL for this file.

hrefstring

The publicly available URL for this file.

Example: https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png

meta object

results object

Contains the results for the entire collection.

totalinteger

Total number of results for the entire collection.

Example: 2

]

links object

Links allow you to move between requests.

selfurinullable

Single entities use a self parameter with a link the specific resource.

firsturinullable

Always the first page.

lasturinullable

This is null if there is only one page.

prevurinullable

This is null if there is only one page.

nexturinullable

This is null if there is only one page.

Example (auto)

{
  "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",
        "price": {},
        "shopper_attributes": {},
        "tiers": {},
        "components": {},
        "custom_inputs": {},
        "sku": "blue-shirt",
        "slug": "blue-shirt",
        "status": "live",
        "external_ref": "string",
        "updated_at": "1970-01-01T00:00:00.000",
        "extensions": {}
      },
      "id": "8fccaa19-dba9-4621-8d11-31a222a68c7c",
      "relationships": {
        "parent": {
          "data": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "type": "product"
          }
        },
        "children": {
          "data": [
            {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "type": "product"
            }
          ],
          "links": {
            "self": "string"
          }
        },
        "files": {
          "data": [
            {
              "type": "file",
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "created_at": "1970-01-01T00:00:00.000"
            }
          ]
        },
        "main_image": {
          "data": {
            "type": "main_image",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
        },
        "component_products": {
          "data": [
            {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "type": "product"
            }
          ],
          "links": {
            "self": "string"
          }
        },
        "custom_relationships": {
          "data": [
            {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "type": "product"
            }
          ],
          "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"
          },
          "without_tax": {
            "amount": "47500",
            "currency": "USD",
            "formatted": "$475.00"
          }
        },
        "catalog_source": "pim",
        "sale_id": "string",
        "sale_expires": "1970-01-01T00:00:00.000",
        "original_price": {},
        "original_display_price": {
          "with_tax": {
            "amount": "47500",
            "currency": "USD",
            "formatted": "$475.00"
          },
          "without_tax": {
            "amount": "47500",
            "currency": "USD",
            "formatted": "$475.00"
          }
        },
        "bundle_configuration": {
          "selected_options": {}
        },
        "component_products": {},
        "component_product_data": {},
        "price_modifiers": {},
        "tiers": {},
        "variation_matrix": {},
        "variations": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "string",
            "sort_order": 0,
            "option": {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "name": "string",
              "sort_order": 0,
              "description": "string"
            },
            "options": [
              {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "name": "string",
                "sort_order": 0,
                "description": "string"
              }
            ]
          }
        ],
        "child_option_ids": [
          [
            "8dbb35b2-ef04-477e-974d-e5f3abe6faae",
            "6ddf2a66-d805-449c-a0e1-8e81335e31a6"
          ]
        ],
        "child_variations": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "string",
            "sort_order": 0,
            "option": {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "name": "string",
              "sort_order": 0,
              "description": "string"
            },
            "options": [
              {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "name": "string",
                "sort_order": 0,
                "description": "string"
              }
            ]
          }
        ],
        "product_types": [
          "string"
        ],
        "language": "en-GB",
        "custom_relationships": [
          [
            "CRP-Cross-Sell-Products",
            "CRP-Frequently-Bought-Together-Products"
          ]
        ]
      }
    }
  ],
  "included": {
    "main_images": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "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": 2
            }
          }
        }
      }
    ],
    "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",
          "price": {},
          "shopper_attributes": {},
          "tiers": {},
          "components": {},
          "custom_inputs": {},
          "sku": "blue-shirt",
          "slug": "blue-shirt",
          "status": "live",
          "external_ref": "string",
          "updated_at": "1970-01-01T00:00:00.000",
          "extensions": {}
        },
        "id": "8fccaa19-dba9-4621-8d11-31a222a68c7c",
        "relationships": {
          "parent": {
            "data": {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "type": "product"
            }
          },
          "children": {
            "data": [
              {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "type": "product"
              }
            ],
            "links": {
              "self": "string"
            }
          },
          "files": {
            "data": [
              {
                "type": "file",
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "created_at": "1970-01-01T00:00:00.000"
              }
            ]
          },
          "main_image": {
            "data": {
              "type": "main_image",
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
            }
          },
          "component_products": {
            "data": [
              {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "type": "product"
              }
            ],
            "links": {
              "self": "string"
            }
          },
          "custom_relationships": {
            "data": [
              {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "type": "product"
              }
            ],
            "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"
            },
            "without_tax": {
              "amount": "47500",
              "currency": "USD",
              "formatted": "$475.00"
            }
          },
          "catalog_source": "pim",
          "sale_id": "string",
          "sale_expires": "1970-01-01T00:00:00.000",
          "original_price": {},
          "original_display_price": {
            "with_tax": {
              "amount": "47500",
              "currency": "USD",
              "formatted": "$475.00"
            },
            "without_tax": {
              "amount": "47500",
              "currency": "USD",
              "formatted": "$475.00"
            }
          },
          "bundle_configuration": {
            "selected_options": {}
          },
          "component_products": {},
          "component_product_data": {},
          "price_modifiers": {},
          "tiers": {},
          "variation_matrix": {},
          "variations": [
            {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "name": "string",
              "sort_order": 0,
              "option": {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "name": "string",
                "sort_order": 0,
                "description": "string"
              },
              "options": [
                {
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "name": "string",
                  "sort_order": 0,
                  "description": "string"
                }
              ]
            }
          ],
          "child_option_ids": [
            [
              "8dbb35b2-ef04-477e-974d-e5f3abe6faae",
              "6ddf2a66-d805-449c-a0e1-8e81335e31a6"
            ]
          ],
          "child_variations": [
            {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "name": "string",
              "sort_order": 0,
              "option": {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "name": "string",
                "sort_order": 0,
                "description": "string"
              },
              "options": [
                {
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "name": "string",
                  "sort_order": 0,
                  "description": "string"
                }
              ]
            }
          ],
          "product_types": [
            "string"
          ],
          "language": "en-GB",
          "custom_relationships": [
            [
              "CRP-Cross-Sell-Products",
              "CRP-Frequently-Bought-Together-Products"
            ]
          ]
        }
      }
    ],
    "files": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "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": 2
            }
          }
        }
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}

default

The unexpected error.

application/json

Schema

Schema

errors object[]
Array [
detailstring
Example: not processable
statusstring
Example: 422
titlestring
Example: There was a problem processing your request.
]

Example (auto)

{
  "errors": [
    {
      "detail": "not processable",
      "status": "422",
      "title": "There was a problem processing your request."
    }
  ]
}

Authorization: Authorization

name: Authorizationtype: httpin: headerscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://euwest.api.elasticpath.com/catalogs/:catalog_id/releases/:release_id/products/:product_id/relationships/:custom_relationship_slug/products");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <Authorization>");
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

Bearer Token

Parameters

catalog_id — pathrequired

release_id — pathrequired

product_id — pathrequired

custom_relationship_slug — pathrequired

filter — query

page[limit] — query

page[offset] — query

accept-language — header

ResponseClear

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