Use the Product Details API to provide customers with product details, such as attributes, hierarchy, or cardinality of individual product records or bundle-based product records, such as price, features, terms, and eligibility rules. The API gets the product details based on a specified product ID. The API takes a product ID as a request and provides the details of catalogs, categories, or products as per the requested resource.
Additional standard or custom fields to include in the response. The supported objects are:
Product2
ProductAttributeDefinition—If the fields defined for the ProductAttributeDefinition object aren’t available for the ProductClassificationAttr object, then the API request fails.
In API version 66.0 and later, you can request proration policy details in the response for each product selling model option through this property.
Optional
61.0
catalogId
String
ID of the catalog. If the catalog ID is specified, then the API returns the list of offers from the catalog with the pricing details related to the catalog.
Optional
60.0
contextDefinition
String
API name of the custom context definition that’s sent for context creation. If this property isn’t specified, then the default context definition is used.
Optional
60.0
contextMapping
String
Default context mapping of the context definition. If a context mapping is specified, then the API checks whether the mapping belongs to the specified context definition to process the details for hydration.
Optional
60.0
correlationId
String
Unique identifier value that’s attached to the requests and messages, and accepts references to a particular transaction or event chain.
Optional
60.0
currencyCode
String
Currency code that’s considered for pricing and filtering request. If multiple currencies are enabled for the org, then the currencyCode property is required.
Optional
60.0
enablePricing
Boolean
Indicates whether to enable pricing for the products (true) or not (false). The default value is true. The Pricing Procedure toggle from the Product Discovery Settings page from Setup overrides this property. For example, if the Pricing Procedure toggle is disabled, then setting the enablePricing property to true has no effect and the prices property in the API response is returned empty.
Optional
60.0
enableQualification
Boolean
Indicates whether to enable qualification rules for the products (true) or not (false). The default value is true. The Qualification Procedure toggle from the Product Discovery Settings page from Setup overrides this property. For example, if the Qualification Procedure toggle is disabled, then setting the enableQualification property to true has no effect and the qualificationContext property in the API response isn’t returned.
Optional
60.0
priceBookId
String
ID of the price book to fetch the prices from. If this property isn’t specified, then the prices from the standard price book are fetched.
Required
60.0
pricingProcedure
String
API name of the custom pricing procedure that’s used for the pricing process. If this property isn’t specified, then the default pricing procedure is executed.
Optional
60.0
productSellingModelId
String
ID of the product selling model.
Optional
60.0
qualificationProcedure
String
API name of the custom qualification procedure that’s used for the product qualification process. If this property isn’t specified, then the default qualification procedure is executed.
j