Product Details (POST)

Get product details, such as attributes, hierarchy, or cardinality, for a specified product ID. This API is a composite API for Product Discovery.

Resource

1/connect/cpq/products/{productId}

Resource Example

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/cpq/products/{01txx0000006j08AAA}

Available Version

60.0

HTTP Methods

POST

Request Body for POST

JSON Example

1{
2  "correlationId": "9cbb9650-48c5-11ed-96d1-0afcf185843b",
3  "catalogId": "0ZSxx0000000001GAA",
4  "priceBookId": "01s26000002ZT71AAG",
5  "productSellingModelId": "0jP1Q000000CaVFUA0",
6  "userContext": {
7    "accountId": "001xx0000000001AAA",
8    "contactId": "003xx00000000D7AAI"
9  },
10  "enablePricing": true,
11  "enableQualification": true,
12  "qualificationProcedure": "QualificationProcedure",
13  "pricingProcedure": "Preview",
14  "contextDefinition": "TestDefinition",
15  "contextMapping": "TestDefinitionNode",
16  "additionalFields": {
17    "ProductSellingModelOption": {
18      "additionalFields": {
19        "ProrationPolicy": {
20          "fields": [
21            "ArePartialPeriodsAllowed",
22            "ProrationPolicyType"
23          ]
24        }
25      }
26    },
27    "Product2": {
28      "fields": [
29        "field1",
30        "field2"
31      ]
32    },
33    "ProductAttributeDefinition": {
34      "fields": [
35        "field3",
36        "field4"
37      ]
38    }
39  },
40  "additionalContextData": [
41    {
42      "nodeName": "Contract",
43      "nodeData": {
44        "id": "xxxxx231",
45        "name": "Contract1"
46      }
47    },
48    {
49      "nodeName": "Lead",
50      "nodeData": {
51        "id": "lllllll31",
52        "name": "Lead1"
53      }
54    }
55  ]
56}

Properties

Name	Type	Description	Required or Optional	Available Version
`additionalContextData`	Context Data Input[]	Additional nodes that are added to the custom or default context definition. The maximum number of supported nodes is 10.	Optional	60.0
`additionalFields`	Map<String, Additional Fields Input>	Additional standard or custom fields to include in the response. The supported objects are Product2 or 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.	Optional	60.0
`userContext`	User Context Input	User context details. For example, account ID or contact ID.	Optional	60.0

Response Body for POST

CPQ Base Details