Get a Product

GET https://euwest.api.elasticpath.com/catalog/products/:product_id

Returns the specified product from the catalog. The product must be in the live status.

If you have multiple catalog rules defined, the rule that best matches the shoppers context is used to determine which catalog is retrieved. For information about how rules are matched, see Resolving Catalog Rules.

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.

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

Path Parameters

product_id stringrequired

The product ID.

Header Parameters

accept-language string

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

EP-Channel string

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-Tag string

Product tags are used to store or assign a key word against a product. The product tag can then be used to describe or label that product. Using product tags means that you can group your products together, for example, by brand, category, subcategory, colors, types, industries, and so on. You can enhance your product list using tags, enabling you to refine your product list and run targeted promotions. Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the EP-Context-Tag header.

Responses

200
default

The product of a catalog.

application/json

Schema
Example (from schema)

Schema

data object

A product in a catalog with the following attributes.

attributes object

A product's attributes.

published_at date-timenullable

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

base_product boolean

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.

base_product_id string

The unique identifier of a parent product.

commodity_type string

The commodity type, either physical or digital.

curated_product boolean

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.

upc_ean string

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

manufacturer_part_num string

The manufacturer part number of the product.

tags string[]

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_modifiers string[]

A list of price modifier names.

created_at date-time

The date and time a product was created.

description string

A description of the product.

name string

A name of a product.

price object

shopper_attributes object

tiers object

components object

custom_inputs object

sku string

The unique stock keeping unit of the product.

slug string

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.

status string

The status of the product, either live or draft.

external_ref stringnullable

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

updated_at date-time

The date and time a product was updated.

extensions object

id string

A unique identifier for a product.

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

children object

files object

main_image object

component_products object

type string

This represents the type of object being returned. Always 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

bread_crumb_nodes string[]

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_id string

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

pricebook_id stringnullable

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

display_price object

catalog_source string

Possible values: [pim]

The source of a catalog. Always pim.

sale_id string

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_expires date-timenullable

The date and time a sale expires.

original_price object

original_display_price object

bundle_configuration object

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_id string

sale_expires date-timenullable

The date and time a sale expires.

price object

display_price object

original_price object

original_display_price object

pricebook_id stringnullable

price_modifiers object

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

variation_matrix object

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

child_option_ids string[]nullable

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

child_variations object[]nullable

product_types string[]

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.

language string

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

links object

{
  "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"
        }
      }
    },
    "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": {},
      "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"
    }
  },
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}

The unexpected error.

application/json

Schema
Example (from schema)

Schema

errors object[]

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

Authorization: Authorization

name: Authorizationtype: httpin: headerscheme: bearer

CURL

curl -L -X GET 'https://euwest.api.elasticpath.com/catalog/products/:product_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

ResponseClear

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

Get a Product

https://euwest.api.elasticpath.com/catalog/products/:product_id

Request​

Path Parameters

Header Parameters

Responses​

Authorization: Authorization

Request

Responses