The product search output. Contains Configure, Price, Quote (CPQ) search results enhanced with order specification metadata and optional category hierarchies.
JSON example
{
"searchOutput": {
"correlationId": "req-0001",
"catalogId": "0ZSRM0000000Abc4AA",
"contextId": "ctx-0001",
"result": [
{
"id": "01tRM000000P9UuYAK",
"name": "Premium Widget",
"productCode": "WIDGET-001"
}
],
"total": 1,
"limit": 25,
"apiStatus": {
"statusCode": 200,
"messages": []
}
},
"categoryHierarchies": [],
"isSuccess": true,
"errors": []
}
Properties
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
categoryHierarchies |
Category Hierarchy Output[] | The list of category hierarchies for all categories in the search results. Populated only when includeCategoryHierarchies is true. | Small, 68.0 | 68.0 |
errors |
Assortment 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.0 | 68.0 |
isSuccess |
Boolean | Indicates whether the operation was successful (true) or not (false). | Small, 68.0 | 68.0 |
searchOutput |
Object | The Configure, Price, Quote (CPQ) product search output that contains products, facets, and pagination information. | Small, 68.0 | 68.0 |