Get a Product
GET/catalogs/:catalog_id/releases/:release_id/products/:product_id
Returns a product from a published catalog. The product must be in live
status. Currently, published catalogs are limited to the current release and two releases prior to the current release.
Product and Node Associations in Breadcrumb Metadata
You can see the parent nodes a product is associated with in the bread_crumbs
and bread_crumb_nodes
metadata for each product. This is useful if you want to improve how your shoppers search your store, for example. See Product and Node Associations in Breadcrumb Metadata.
Product Variations
The variations
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. The variations
object can then be added to your catalogs. By default, variations and variation options are sorted randomly. You can use the sort_order
attribute to sort the order of your variation and variation options in variations
. Once a parent product is published in a catalog, the get a product in a catalog release response displays the sorted variations and variation options. Variations and variation options are displayed in descending order according to their sort_order
values.
Including Resources
Using the include
parameter, you can retrieve top-level resources, such as, files or main image, bundle component products and product attributes, such as SKU or slug.
Parameter | Required | Description |
---|---|---|
component_products | Optional | The component product data and key attribute data, such as SKU or slug, to return for component products in a product bundle. |
main_image | Optional | The main images associated with a product. |
files | Optional | Any files associated with a product. |
See Including Resources.
Request
Responses
- 200
- default