Product Overview

Overview of a product, with summary information about prices, selected fields, and the product’s default image.
Property Name Type Description Filter Group and Version Available Version
defaultImage Product Media Media representation of the product's default image. Small, 54.0 54.0
error Error Response Error code and error message. Big, 54.0 54.0
fields Map<String, String> Map of fields belonging to the product. Medium, 54.0 54.0
id String ID of the product. Small, 54.0 54.0
isConfiguration​Allowed Boolean Indicates whether the product supports configuration (true) or not (false). For dynamic bundles, this field is always true, and for static bundles, it is false. When true, buyers can configure the bundle by selecting which child components to include or exclude before adding it to the cart. Small, 65.0 65.0
name String Name of the product. Small, 63.0 63.0
prices Pricing Result Line Item Price of the product.

To get pricing information for products in version 58 and later, use Commerce Webstore Pricing Products.

Medium, 54.0 54.0–57.0
productClass String Class of the product. Possible values are:
  • Bundle
  • Set
  • Simple
  • Variation
  • VariationParent
Small, 63.0 63.0
productSelling​Models Product Selling Model[] Product selling models information for the product. Small, 63.0 63.0
purchaseQuantity​Rule Purchase Quantity Rule Purchase quantity rule information for the product. Small, 63.0 63.0
sku String SKU of the product. Small, 54.0 54.0
success Boolean Represents whether execution was successful and product overview information was retrieved without error. Small, 54.0 54.0
urlName String URL name of the product. Small, 63.0 63.0
variationAttribute​Set Product Attribute Set Summary Variation attribute set information for the product. Small, 63.0 63.0
variationInfo Product Variation Info Details of product variation attributes, metadata, and mappings of attribute combinations to variation product IDs. Small, 63.0 63.0