CPQ Base List

Output representation of the list of catalogs, categories, or products based on the request.

JSON Example

This example shows a sample catalog list.

1{
2  "result": [
3    {
4      "id": "...",
5      "name": "Printer",
6      "productCode": "PRN001"
7    }
8  ],
9  "apiStatus": {
10    "statusCode": "FetchedDetailsSuccessfully"
11  }
12}

This example shows a sample category list.

1{
2  "apiStatus": {
3    "messages": [
4      
5    ],
6    "statusCode": "FetchedDetailsSuccessfully"
7  },
8  "correlationId": "3f2a8f45-e7d2-42ec-bc4c-b981d750e912",
9  "query": {
10    
11  },
12  "result": [
13    {
14      "catalogId": "0ZSxx0000000001GAA",
15      "childCategories": [
16        
17      ],
18      "description": "Category for Apple phones and iPads",
19      "id": "0ZGxx0000000001GAA",
20      "name": "Apple",
21      "sortOrder": 1,
22      "isNavigational": true
23    },
24    {
25      "catalogId": "0ZSxx0000000001GAA",
26      "childCategories": [
27        
28      ],
29      "description": "Category for Samsung phones",
30      "id": "0ZGxx000000004rGAA",
31      "name": "Samsung",
32      "sortOrder": 2,
33      "isNavigational": true
34    },
35    {
36      "catalogId": "0ZSxx0000000001GAA",
37      "childCategories": [
38        
39      ],
40      "description": "Category for Android phones",
41      "id": "0ZGxx000000006TGAQ",
42      "name": "Android",
43      "isNavigational": true
44    }
45  ],
46  "total": 3
47}

This example shows a sample product list.

1{
2  "apiStatus": {
3    "messages": [],
4    "statusCode": "FetchedDetailsSuccessfully"
5  },
6  "contextId": "f36f8e73f1fc338cc4e93c61613cba07a6a0129941d97e5dd6e52a2885776ce4",
7  "correlationId": "eeaa1db2-f371-4227-a886-c77e2f66ce1d",
8  "cursor": "MTAwMDAwMDAwNg==",
9  "query": {},
10  "result": [
11    {
12      "additionalFields": {
13        "DecompositionScope": "OrderLineItem",
14        "ProductCode": "LPB001",
15        "CanRamp": false
16      },
17      "attributeCategories": [],
18      "catalogs": [
19        {
20          "customFields": {},
21          "id": "0ZSDU0000002Og74AE",
22          "name": "Service Catalog",
23          "numberOfCategories": 5
24        }
25      ],
26      "categories": [
27        {
28          "catalogId": "0ZSDU0000002Og74AE",
29          "childCategories": [],
30          "customFields": {},
31          "hasSubCategories": false,
32          "id": "0ZGDU0000002P0H4AU",
33          "name": "Cloud Services",
34          "qualificationContext": {
35            "isQualified": true
36          }
37        }
38      ],
39      "childProducts": [],
40      "configureDuringSale": "Allowed",
41      "description": "The laptop pro bundle includes a Laptop, mouse, warranty for 2 years, premium support and printer bundle",
42      "displayUrl": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcSCrGjPR1fvJqg4yP3RMyqjI0H9eL6tk1fvzw&amp;usqp=CAU",
43      "id": "01tDU000000ExkZYAS",
44      "isActive": true,
45      "isAssetizable": true,
46      "isSoldOnlyWithOtherProds": false,
47      "name": "Laptop Pro Bundle",
48      "nodeType": "bundleProduct",
49      "prices": [],
50      "productClassification": {},
51      "productCode": "LPB001",
52      "productComponentGroups": [],
53      "productSellingModelOptions": [
54        {
55          "id": "0iODU0000002TBN2A2",
56          "productId": "01tDU000000ExkZYAS",
57          "productSellingModel": {
58            "id": "0jPDU0000002OTv2AM",
59            "name": "One Time",
60            "sellingModelType": "OneTime",
61            "status": "Active"
62          },
63          "productSellingModelId": "0jPDU0000002OTv2AM"
64        }
65      ],
66      "productSpecificationType": {
67        "name": "Commercial",
68        "productSpecificationRecordType": {}
69      },
70      "productType": "Bundle",
71      "qualificationContext": {
72        "isQualified": true
73      }
74    }
75  ]
76}

This example shows a sample of the list of products retrieved based on the Laptop search term.

1{
2  "apiStatus": {
3    "messages": [],
4    "statusCode": "FetchedDetailsSuccessfully"
5  },
6  "correlationId": "d9d8f898-19f5-464a-ba2b-6a070783f6c4",
7  "cursor": "MTAwMDAwMDAwMw==",
8  "facets": [
9    {
10      "attributeType": "ProductStandard",
11      "displayName": "Product Type",
12      "displayRank": 2,
13      "nameOrId": "Type",
14      "values": [
15        {
16          "displayName": "Bundle",
17          "nameOrId": "Bundle"
18        }
19      ]
20    },
21    {
22      "attributeType": "ProductDynamicAttribute",
23      "displayName": "Display",
24      "displayRank": 3,
25      "nameOrId": "0tjDU0000003K5BYAU",
26      "values": [
27        {
28          "displayName": "1080p Built-in Display",
29          "nameOrId": "1080p Built-in Display"
30        },
31        {
32          "displayName": "2k Built-in Display",
33          "nameOrId": "2k Built-in Display"
34        },
35        {
36          "displayName": "4k Built-in Display",
37          "nameOrId": "4k Built-in Display"
38        }
39      ]
40    }
41  ],
42  "limit": 10,
43  "query": {},
44  "result": [
45    {
46      "additionalFields": {},
47      "attributeCategories": [],
48      "catalogs": [],
49      "categories": [
50        {
51          "catalogId": "0ZSDU0000002Og64AE",
52          "childCategories": [],
53          "customFields": {},
54          "hasSubCategories": false,
55          "id": "0ZGDU0000002P0A4AU",
56          "name": "Laptops",
57          "qualificationContext": {
58            "isQualified": true
59          }
60        }
61      ],
62      "configureDuringSale": "Allowed",
63      "description": "Battery- or AC-powered personal computer (PC) smaller than a briefcase",
64      "displayUrl": "https://media.istockphoto.com/id/1023428598/photo/3d-illustration-laptop-isolated-on-white-background-laptop-with-empty-space-screen-laptop-at.jpg?s=612x612&amp;w=0&amp;k=20&amp;c=ssK6er5v1fGpSghGiqySwoD8tn5blC7xgefQJI2xU38=",
65      "id": "01tDU000000ExkWYAS",
66      "isActive": true,
67      "isAssetizable": true,
68      "isSoldOnlyWithOtherProds": false,
69      "name": "Laptop",
70      "nodeType": "simpleProduct",
71      "prices": [],
72      "productClassification": {
73        "id": "11BDU0000002TCD2A2"
74      },
75      "productCode": "LP001",
76      "productComponentGroups": [],
77      "productSellingModelOptions": [
78        {
79          "id": "0iODU0000002TBF2A2",
80          "productId": "01tDU000000ExkWYAS",
81          "productSellingModel": {
82            "id": "0jPDU0000002OTv2AM",
83            "name": "One Time",
84            "sellingModelType": "OneTime",
85            "status": "Active"
86          },
87          "productSellingModelId": "0jPDU0000002OTv2AM"
88        }
89      ],
90      "productSpecificationType": {
91        "name": "Commercial",
92        "productSpecificationRecordType": {}
93      },
94      "qualificationContext": {
95        "isQualified": true
96      }
97    },
98    {
99      "additionalFields": {},
100      "attributeCategories": [],
101      "catalogs": [],
102      "categories": [
103        {
104          "catalogId": "0ZSDU0000002Og64AE",
105          "childCategories": [],
106          "customFields": {},
107          "hasSubCategories": false,
108          "id": "0ZGDU0000002P0A4AU",
109          "name": "Laptops",
110          "qualificationContext": {
111            "isQualified": true
112          }
113        }
114      ],
115      "configureDuringSale": "Allowed",
116      "description": "The laptop basic bundle includes a Laptop, mouse, and warranty for 1 year.",
117      "displayUrl": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTbf49JG4zZogCmZMJuXU38qOkR9X36MN4bSw&amp;usqp=CAU",
118      "id": "01tDU000000ExkXYAS",
119      "isActive": true,
120      "isAssetizable": true,
121      "isSoldOnlyWithOtherProds": false,
122      "name": "Laptop Basic Bundle",
123      "nodeType": "bundleProduct",
124      "prices": [],
125      "productClassification": {},
126      "productCode": "LB001",
127      "productComponentGroups": [],
128      "productSellingModelOptions": [
129        {
130          "id": "0iODU0000002TBD2A2",
131          "productId": "01tDU000000ExkXYAS",
132          "productSellingModel": {
133            "id": "0jPDU0000002OTv2AM",
134            "name": "One Time",
135            "sellingModelType": "OneTime",
136            "status": "Active"
137          },
138          "productSellingModelId": "0jPDU0000002OTv2AM"
139        }
140      ],
141      "productSpecificationType": {
142        "name": "Commercial",
143        "productSpecificationRecordType": {}
144      },
145      "productType": "Bundle",
146      "qualificationContext": {
147        "isQualified": true
148      }
149    },
150    {
151      "additionalFields": {},
152      "attributeCategories": [],
153      "catalogs": [],
154      "categories": [
155        {
156          "catalogId": "0ZSDU0000002Og64AE",
157          "childCategories": [],
158          "customFields": {},
159          "hasSubCategories": false,
160          "id": "0ZGDU0000002P0A4AU",
161          "name": "Laptops",
162          "qualificationContext": {
163            "isQualified": true
164          }
165        }
166      ],
167      "configureDuringSale": "Allowed",
168      "description": "The laptop pro bundle includes a Laptop, mouse, warranty for 2 years, premium support and printer bundle",
169      "displayUrl": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcSCrGjPR1fvJqg4yP3RMyqjI0H9eL6tk1fvzw&amp;usqp=CAU",
170      "id": "01tDU000000ExkZYAS",
171      "isActive": true,
172      "isAssetizable": true,
173      "isSoldOnlyWithOtherProds": false,
174      "name": "Laptop Pro Bundle",
175      "nodeType": "bundleProduct",
176      "prices": [],
177      "productClassification": {},
178      "productCode": "LPB001",
179      "productComponentGroups": [],
180      "productSellingModelOptions": [
181        {
182          "id": "0iODU0000002TBN2A2",
183          "productId": "01tDU000000ExkZYAS",
184          "productSellingModel": {
185            "id": "0jPDU0000002OTv2AM",
186            "name": "One Time",
187            "sellingModelType": "OneTime",
188            "status": "Active"
189          },
190          "productSellingModelId": "0jPDU0000002OTv2AM"
191        }
192      ],
193      "productSpecificationType": {
194        "name": "Commercial",
195        "productSpecificationRecordType": {}
196      },
197      "productType": "Bundle",
198      "qualificationContext": {
199        "isQualified": true
200      }
201    },
202    {
203      "additionalFields": {},
204      "attributeCategories": [],
205      "catalogs": [],
206      "categories": [
207        {
208          "catalogId": "0ZSDU0000002Og64AE",
209          "childCategories": [],
210          "customFields": {},
211          "hasSubCategories": false,
212          "id": "0ZGDU0000002P0A4AU",
213          "name": "Laptops",
214          "qualificationContext": {
215            "isQualified": true
216          }
217        }
218      ],
219      "configureDuringSale": "Allowed",
220      "description": "Laptop, Laptop Bag, Laptop stand, Mouse, Keyboard, USB-C Hub,External Hard Drive, Noise Cancelling Headphones, office 365",
221      "displayUrl": "https://m.media-amazon.com/images/I/613Fno-NLYL._AC_SL1000_.jpg",
222      "id": "01tDU000000ExlAYAS",
223      "isActive": true,
224      "isAssetizable": true,
225      "isSoldOnlyWithOtherProds": false,
226      "name": "Laptop Productivity Bundle",
227      "nodeType": "bundleProduct",
228      "prices": [],
229      "productClassification": {},
230      "productCode": "LPB001",
231      "productComponentGroups": [],
232      "productSellingModelOptions": [
233        {
234          "id": "0iODU0000002TBq2AM",
235          "productId": "01tDU000000ExlAYAS",
236          "productSellingModel": {
237            "id": "0jPDU0000002OTv2AM",
238            "name": "One Time",
239            "sellingModelType": "OneTime",
240            "status": "Active"
241          },
242          "productSellingModelId": "0jPDU0000002OTv2AM"
243        }
244      ],
245      "productSpecificationType": {
246        "name": "Commercial",
247        "productSpecificationRecordType": {}
248      },
249      "productType": "Bundle",
250      "qualificationContext": {
251        "isQualified": true
252      }
253    }
254  ],
255  "total": 4
256}

This example shows a sample of the results of a qualification procedure that’s executed on a list of product IDs.

1{
2  "apiStatus": {
3    "messages": [
4      
5    ],
6    "statusCode": "FetchedDetailsSuccessfully"
7  },
8  "contextId": "e055bb18-d4e8-41c3-881e-0132b9561708",
9  "correlationId": "c280c1b0-fd3f-4eac-9b08-075bdf1cbefc",
10  "query": {
11    
12  },
13  "result": [
14    {
15      "productId": "01txx0000006i7PAAQ",
16      "qualificationContext": {
17        "isQualified": true
18      }
19    },
20    {
21      "productId": "01txx0000006i7QAAQ",
22      "qualificationContext": {
23        "isQualified": true
24      }
25    },
26    {
27      "productId": "01txx0000006i7IAAQ",
28      "qualificationContext": {
29        "isQualified": true
30      }
31    }
32  ]
33}

Property Name	Type	Description	Filter Group and Version	Available Version
`apiStatus`	API Status	Status of the API request.	Small, 60.0	60.0
`contextId`	String	ID of the context.	Small, 60.0	60.0
`correlationId`	String	Unique ID of the request.	Small, 60.0	60.0
`cursor`	String	Unique ID to represent the position of each product in the dataset.	Small, 60.0	60.0
`facets`	Search Products Facet	Details of the faceted search.	Small, 63.0	63.0
`limit`	Integer	Number of items fetched in the response.	Small, 60.0	60.0
`offSet`	Integer	Offset size from which the item count is fetched.	Small, 60.0	60.0
`query`	Map<String, Object>>	Query that was used for the search request.	Small, 60.0	60.0
`result`	Any response body	Result that contains the list of catalogs, categories, or products as per the requested resource.	Small, 60.0	60.0
`total`	Integer	Number of fetched records.	Small, 60.0	60.0
`userContext`	User Context	User context details. For example, account ID or contact ID.	Small, 60.0	60.0