Advanced Order Product Search Output

The product search output. Contains Configure, Price, Quote (CPQ) search results enhanced with order specification metadata and optional category hierarchies.

JSON example 

1{
2  "searchOutput": {
3    "correlationId": "req-0001",
4    "catalogId": "0ZSRM0000000Abc4AA",
5    "contextId": "ctx-0001",
6    "result": [
7      {
8        "id": "01tRM000000P9UuYAK",
9        "name": "Premium Widget",
10        "productCode": "WIDGET-001"
11      }
12    ],
13    "total": 1,
14    "limit": 25,
15    "apiStatus": {
16      "statusCode": 200,
17      "messages": []
18    }
19  },
20  "categoryHierarchies": [],
21  "isSuccess": true,
22  "errors": []
23}

Properties 

Property NameTypeDescriptionFilter Group and VersionAvailable Version
categoryHierarchiesCategory Hierarchy Output[]The list of category hierarchies for all categories in the search results. Populated only when includeCategoryHierarchies is true.Small, 68.068.0
errorsAssortment Error[]The list of errors returned if the operation failed. Each error contains an error code and an error message. The list is empty when the operation is successful.Small, 68.068.0
isSuccessBooleanIndicates whether the operation was successful (true) or not (false).Small, 68.068.0
searchOutputObjectThe Configure, Price, Quote (CPQ) product search output that contains products, facets, and pagination information.Small, 68.068.0