|
count
|
Number of product offerings in the `response` array.Data type: Number
|
|
leafCategoryList
|
A comma-separated string of eligible leaf category sys\_ids used to filter product offerings, derived from the selected catalog and category hierarchy. Only included in the output when not already provided in the input filter.
Data type: String
|
|
response
|
An array matching the current filter criteria, including search terms, selected category, and eligibility rules.Data type: Array of Objects
```
"response": [
{
"code": {Object},
"description": {Object},
"listPrice": "String",
"name": {Object},
"offerType": {Object},
"offerTypeVariation": "String",
"priceList": "String",
"pricingMethod": "String",
"productOfferingFamily": {Object},
"productOfferingSysId": {Object},
"uom": {Object}
}
]
```
|
|
response.code
|
Product offering code.Data type: Object
```
"code": {
"value": "String",
"displayValue": "String"
}
```
|
|
response.code.displayValue
|
Display value of the field.Data type: String
|
|
response.code.value
|
Stored \(raw\) value of the field.Data type: String
|
|
response.derivedPrice
|
Flag that indicates whether the product's price is calculated dynamically based on related products, product characteristics, or predefined pricing rules rather than having a fixed catalog list price.Valid values:
- true: Product's price is calculated dynamically.
- false: Product's price is calculated using a fixed catalog list price.
Data type: Boolean
|
|
response.description
|
Details about the product offering.Data type: Object
```
"description": {
"value": "String",
"displayValue": "String"
}
```
|
|
response.description.displayValue
|
Display value of the field.Data type: String
|
|
response.description.value
|
Stored \(raw\) value of the field.Data type: String
|
|
response.items.semanticSimilarity
|
Relevance or semantic score assigned to this result by the AI search engine. Field is absent from non-AI Search responses.Data type: Number
|
|
response.listPrice
|
Formatted list price of the product offering \(for example, `"$50.00"`\). May be absent if no price is configured.Data type: String
|
|
response.name
|
Display name of the product offering.Data type: Object
```
"name": {
"value": "String",
"displayValue": "String"
}
```
|
|
response.name.displayValue
|
Display value of the field.Data type: String
|
|
response.name.value
|
Stored \(raw\) value of the field.Data type: String
|
|
response.offerType
|
Type of the product offering \(for example, `simple`, `config`, or `simple_with_spec`\).Data type: Object
```
"offerType": {
"value": "String",
"displayValue": "String"
}
```
|
|
response.offerType.displayValue
|
Display value of the field.Data type: String
|
|
response.offerType.value
|
Stored \(raw\) value of the field.Data type: String
|
|
response.offerTypeVariation
|
Variation type of the offering, typically matching offerType.Data type: String
|
|
response.priceList
|
Sys\_id of the associated price list record. May be absent if no price list is assigned.Data type: String
|
|
response.pricingMethod
|
Pricing method for the offering.Possible values:
- `one_time`
- `recurring`
Data type: String
|
|
response.productOfferingFamily
|
Product offering family to which the offering belongs to.Data type: Object
```
"productOfferingFamily": {
"value": "String",
"displayValue": "String"
}
```
|
|
response.productOfferingFamily.displayValue
|
Display value of the field.Data type: String
|
|
response.productOfferingFamily.value
|
Stored \(raw\) value of the field.Data type: String
|
|
response.productOfferingSysId
|
List containing the sys\_id\(s\) of the product offering record\(s\).Data type: Object
```
"productOfferingSysId": {
"value": "String",
"displayValue": "String"
}
```
|
|
response.productOfferingSysId.displayValue
|
Display value of the field.Data type: String
|
|
response.productOfferingSysId.value
|
Stored \(raw\) value of the field.Data type: String
|
|
response.uom
|
Unit of measure for the offering.Data type: Object
```
"uom": {
"sysId": "String",
"name": "String"
}
```
|
|
response.uom.name
|
Display name of the unit of measure \(for example, `Each`\).Data type: String
|
|
response.uom.sys\_id
|
Sys\_id of the unit-of-measure record.Data type: String
|
|
response.visual
|
URL to the product offering's image/thumbnail, if configured and if sn\_prd\_pm.show\_product\_visuals system property is enabled.Data type: String
|
|
selectedCatalogHierarchy
|
List of all eligible catalog objects when no default catalog is configured and "All Catalogs" is the selected view.Data type: Array of Objects
```
"selectedCatalogHierarchy": [
{
"id": "String",
"label": "String",
"children": []
}
]
```
|
|
selectedCatalogHierarchy.children
|
Child category nodes. Dependent on the value set for **selectedCategory** in the request:
- Value is empty or `showAll` \(default\): Returns an empty array \(`[]`\) when there are no children; the `showAll` node returns an empty object \(`{}`\).
- Value is a sys\_id: Returns the child sys ID, display value, and any nested children associated with the given category sys\_id.
Data type: Object or Array
```
//'selectedCategory' is 'showAll'
{
"id": "showAll",
"label": "Show all",
"children": {}
}
```
```
//'selectedCategory' is sys_id
{
"id": "String",
"label": "String",
"children": [
{
"id": "String",
"label": "String",
"children": [Array]
}
]
}
```
|
|
selectedCatalogHierarchy.id
|
Category identifier. A sys\_id for catalog categories, or the literal `showAll` for the "Show all" option.Data type: String
|
|
selectedCatalogHierarchy.label
|
Display name of the category.Data type: String
|
|
spellCorrectedTerm
|
Spell-corrected version of the search term, returned when AI Search + RAG is enabled and a correction is available. Field is absent from non-AI Search responses.Data type: String
|
|
suggestedRecordDisplayName
|
Display name of a suggested record, returned when AI Search + RAG is enabled and a direct match suggestion exists.Data type: String
|