Home > widget-integration > SuggestionResponse
SuggestionResponse interface
Response from the suggestion search API.
**Legacy**: Untyped object returned from getSuggestionSearch() **New**: Fully typed interface with JSDoc comments
Signature:
export interface SuggestionResponse
Properties
|
Property |
Modifiers |
Type |
Description |
|---|---|---|---|
|
boolean |
Whether all result categories are empty | ||
|
(Optional) Bundle data (if any) | |||
|
Matching collections | |||
|
string |
Corrected query (spell correction) | ||
|
string[] |
"Did you mean" suggestions | ||
|
{ rid: string; } |
Response metadata | ||
|
Matching pages | |||
|
ProductItem[] |
Matching products | ||
|
string |
Original search query | ||
|
string[] |
Search term suggestions | ||
|
number |
Total product count |