Poq.SDK.Node

Home > @poq/sdk-sfcc > SearchSuggestionClient > getSearchSuggestion

SearchSuggestionClient.getSearchSuggestion() method

Provides keyword search functionality for products, categories, content, brands and custom suggestions. Returns suggested products, suggested categories, suggested content, suggested brands and custom suggestions for the given search phrase.

Signature:

getSearchSuggestion(q: string, count?: number, currency?: string, locale?: string, options?: RequestOptions): Promise<PoqResponse<SuggestionResult>>;

Parameters

Parameter	Type	Description
q	string	The query phrase to search for.
count	number	(Optional) The maximum number of suggestions per request. Default value is 5. This affects all types of suggestions (category, product, content, brand, custom suggestions).
currency	string	(Optional) The currency mnemonic specified for price. This parameter is effective only for product suggestions.
locale	string	(Optional)
options	RequestOptions	(Optional) Override http request option.

Returns:

Promise<PoqResponse<SuggestionResult>>