Retrieve a list of products based on the response identifier or search terms of a guided selection. Guided selection captures user requirements to show suitable products.
1/connect/cpq/products/guided-selection1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/cpq/products/guided-selection62.0
POST
JSON Example
1{
2 "correlationId": "corrId",
3 "catalogId": "0ZSxx0000000001GAA",
4 "priceBookId": "pricebookId",
5 "limit": 10,
6 "cursor": "MTAwMDAwMDAwNg==",
7 "userContext": {
8 "accountId": "accId"
9 },
10 "guidedSelectionResponseId": "ABCxx0000000001GAA",
11 "searchTerms": [
12 {
13 "term": "IPhone",
14 "tags": [
15 "deviceType",
16 "mobile"
17 ]
18 },
19 {
20 "term": "4GB",
21 "tags": [
22 "RAM"
23 ]
24 },
25 {
26 "term": "64GB",
27 "tags": [
28 "Storage"
29 ]
30 }
31 ],
32 "enableQualification": true,
33 "enablePricing": true,
34 "includeCatalogDetails": false
35}This example shows a sample request to fetch eligible promotions.
1{
2 "correlationId": "corrId",
3 "catalogId": "0ZSxx0000000001GAA",
4 "priceBookId": "pricebookId",
5 "limit": 10,
6 "cursor": "MTAwMDAwMDAwNg==",
7 "userContext": {
8 "accountId": "accId"
9 },
10 "guidedSelectionResponseId": "ABCxx0000000001GAA",
11 "searchTerms": [
12 {
13 "term": "IPhone",
14 "tags": [
15 "deviceType",
16 "mobile"
17 ]
18 },
19 {
20 "term": "4GB",
21 "tags": [
22 "RAM"
23 ]
24 },
25 {
26 "term": "64GB",
27 "tags": [
28 "Storage"
29 ]
30 }
31 ],
32 "enableQualification": true,
33 "enablePricing": true,
34 "includeCatalogDetails": false,
35 "transactionContextId": "context123",
36 "transactionId": "trans456",
37 "usePromotions": true
38}This example shows a sample request to run visibility rules.
1{
2 "catalogId": "0ZSVW000000AhdC4AS",
3 "currencyCode": "USD",
4 "enablePricing": true,
5 "enableQualification": true,
6 "executeConfigurationRules": true,
7 "filter": {
8 "criteria": [
9 {
10 "property": "isActive",
11 "operator": "eq",
12 "value": true
13 },
14 {
15 "property": "UsedFor",
16 "operator": "eq",
17 "value": ""
18 }
19 ]
20 },
21 "guidedSelectionResponseId": "0U3VW0000000a1t0AA",
22 "includeCatalogDetails": true,
23 "limit": 12,
24 "offset": 0,
25 "orderBy": [
26 "name:asc"
27 ],
28 "priceBookId": "01sVW0000024PZlYAM",
29 "transactionId": "0Q0VW000001190f0AA",
30 "userContext": {
31 "accountId": null
32 }
33}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 | 62.0 |
additionalFields | Map<String, Additional Fields Input> | Additional standard or custom fields of the Product2 object to include in the response. If the requested fields are invalid or access to fields isn’t available, then the API throws an error. | Optional | 62.0 |
catalogId | String | ID of the catalog. | Required | 62.0 |
categoryId | String | ID of the category. | Optional | 62.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 | 62.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 | 62.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 | 62.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 | 62.0 |
cursor | String | Unique ID to represent the position of each product in the dataset. | Optional | 62.0 |
enablePricing | Boolean | Indicates whether to enable pricing for the products (true) or not (false). The default value is true. | Optional | 62.0 |
enableQualification | Boolean | Indicates whether to enable qualification rules for the products (true) or not (false). The default value is true. | Optional | 62.0 |
executeConfigurationRules | Boolean | Indicates whether to execute configuration rules (true) or not (false). | Optional | 67.0 |
filter | Filter Input | Filters records based on supported criteria. The supported property is name. If multiple criteria are specified, then the resultant criteria are combined by using the and operator. | Optional | 62.0 |
guidedSelectionResponseId | String | Response identifier of the guided selection. | Required if the searchTerms property isn’t specified. | 62.0 |
includeCatalogDetails | Boolean | Indicates whether to include catalog details in the response (true) or not (false). | Optional | 62.0 |
limit | Integer | Number of items to include in the response. The default value is 10. | Optional | 62.0 |
orderBy | String[] | Sort order of the results, which is either ascending (asc) or descending order (desc). The default sort order is ascending order. The default value is asc. If the Use Indexed Data For Product Listing and Search toggle from the Product Discovery Settings page from Setup is enabled, then you can sort products by using name only. | Optional | 62.0 |
priceBookId | String | ID of the price book to get the prices from. If this property isn’t specified, then prices from the standard price book are fetched. | Required | 62.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 | 62.0 |
productClassificationId | String | ID of the product classification. | Optional | 62.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 | 62.0 |
searchTerms | Guided Selection Search Term Input[] | Search terms of the guided selection. | Required if the guidedSelectionResponseId property isn’t specified. | 62.0 |
transactionContextId | String | ID of the transaction context. | Optional | 67.0 |
transactionId | String | ID of the transaction. | Optional | 67.0 |
usePromotions | Boolean | Indicates whether to fetch applicable promotions from Global Promotion Management (GPM) for the guided selection (true) or not (false). If Promotion feature is enabled in the org and this property isn’t specified, then the default value is true. If the Promotion feature isn’t enabled, the default value is false. | Optional | 66.0 |
userContext | User Context Input | User context details. For example, account ID or contact ID. | Optional | 62.0 |
The supported operators are:
eqincontains—This value isn’t applicable if the Use Indexed Data For Product Listing and Search toggle from the Product Discovery Settings page from Setup is enabled.If both the guidedSelectionResponseId and searchTerms properties are specified, then the searchTerms property is considered in the input request.
j