Retrieves a list of products based on a search query or search term. This API is a composite API for Product Discovery.
1/connect/cpq/products/search1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/cpq/products/search60.0
POST
JSON Example
This example shows a sample request to search products by using a query.
1{
2 "query": {
3 "textQuery": {
4 "searchPhrase": "firstproduct"
5 }
6 },
7 "catalogId": "0ZSxx0000000001GAA",
8 "categoryId": "0ZGT100000000qlOAA",
9 "correlationId": "9cbb9650-48c5-11ed-96d1-0afcf185843b",
10 "limit": 10,
11 "cursor": "MTAwMDAwMDAwNg==",
12 "orderBy": [
13 "name:asc",
14 "id:desc"
15 ],
16 "userContext": {
17 "accountId": "001xx0000000001AAA",
18 "contactId": "003xx00000000D7AAI"
19 },
20 "additionalFields": {
21 "Product2": {
22 "fields": [
23 "CustomField1__c",
24 "CustomField2__c",
25 "StandardField1"
26 ]
27 }
28 }
29}This example shows a sample request to search products by using the searchTerm property.
1{
2 "searchTerm": "Laptop",
3 "catalogId": "0ZSDU0000002Og64AE",
4 "categoryId": "0ZGDU0000002P0A4AU",
5 "correlationId": "d9d8f898-19f5-464a-ba2b-6a070783f6c4",
6 "limit": 10,
7 "cursor": "MTAwMDAwMDAwNw==",
8 "orderBy": [
9 "name:asc",
10 "id:desc"
11 ],
12 "userContext": {
13 "accountId": "001DU000001o2V0YAI"
14 }
15}If a parent category ID is specified in the request body, then the API returns all products associated to all child categories.
This example shows a sample request to search products with eligible promotions. To fetch eligible promotions, specify a value for the query or searchTerm property, and set the usePromotions property to true.
1{
2 "query": {
3 "textQuery": {
4 "searchPhrase": "laptop"
5 }
6 },
7 "catalogId": "0ZSxx0000000001GAA",
8 "categoryId": "0ZGT100000000qlOAA",
9 "correlationId": "9cbb9650-48c5-11ed-96d1-0afcf185843b",
10 "limit": 10,
11 "cursor": "MTAwMDAwMDAwNg==",
12 "orderBy": [
13 "name:asc",
14 "id:desc"
15 ],
16 "userContext": {
17 "accountId": "001xx0000000001AAA",
18 "contactId": "003xx00000000D7AAI"
19 },
20 "additionalFields": {
21 "Product2": {
22 "fields": [
23 "CustomField1__c",
24 "CustomField2__c",
25 "StandardField1"
26 ]
27 }
28 },
29 "usePromotions": true
30}This example shows a sample request to run visibility rules.
1{
2 "enableQualification": true,
3 "enablePricing": true,
4 "includeCatalogDetails": true,
5 "searchTerm": "128GB LRDIMM",
6 "catalogId": "0ZSVW000000AhdC4AS",
7 "limit": 12,
8 "userContext": {
9 "accountId": null
10 },
11 "priceBookId": "01sVW0000024PZlYAM",
12 "currencyCode": "USD",
13 "transactionId": "0Q0VW000001190f0AA",
14 "filter": {
15 "criteria": [
16 {
17 "property": "isActive",
18 "operator": "eq",
19 "value": true
20 },
21 {
22 "property": "UsedFor",
23 "operator": "eq",
24 "value": ""
25 }
26 ]
27 },
28 "orderBy": [
29 "name:asc"
30 ],
31 "executeConfigurationRules": true
32}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 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 | 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 |
categoryId | String | ID of the category. If the category ID isn’t specified, then the API returns the matching query offers from 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 of the request. | Optional | 60.0 |
currencyCode | String | Currency code that’s considered for pricing and filtering request. | Optional | 60.0 |
cursor | String | Unique ID to represent the position of each product in the dataset. | 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 |
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. The supported operators are eq; in; contains; gt—Specifies a greater than criteria. Available from API version 63.0 and later for Number, Date, and Datetime data types only; lt—Specifies a less than criteria. Available from API version 63.0 and later for Number, Date, and Datetime data types only; gte—Specifies a greater than or equal to criteria. Available from API version 63.0 and later for Number, Date, and Datetime data types only; or lte—Specifies a less than or equal to criteria. Available from API version 63.0 and later for Number, Date, and Datetime data types only. If multiple criteria are specified, then the resultant criteria are combined by using the and operator. | Optional | 60.0 |
includeCatalogDetails | Boolean | Indicates whether to include catalog details in the response (true) or not (false). | Optional | 61.0 |
limit | Integer | Number of items to include in the response. The default value is 10. | Optional | 60.0 |
offset | Integer | Reserved for internal use. | Optional | 60.0 |
orderBy | String[] | Sort order of the results, which is either ascending or descending order. The default sort order is ascending order. The default value is asc. | Optional | 60.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. | Optional | 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 |
product ClassificationId | String | ID of the product classification. | 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 |
query | Map<String, Object> | Query to search the products. | Required | 60.0 |
relatedObjectFilter | Related Object Filter Input[] | Filter records based on supported criteria for related objects. The supported object is ProductSpecificationRecType. The supported property is IsCommerical. The supported operator is eq. The supported values are true and false. | Optional | 60.0 |
searchTerm | String | String used to get products with the product name containing the search term. See Search Considerations When Using Indexed Data. | Optional | 62.0 |
transactionContextId | String | ID of the transaction context. | Optional | 66.0 |
transactionId | String | ID of the transaction. | Optional | 66.0 |
usePromotions | Boolean | Indicates whether to retrieve eligible promotions from Global Promotion Management (GPM) for each product in the search results (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 | 60.0 |
j