Home > @vsf-enterprise/sap-commerce-webservices-sdk > ProductsApi > getSuggestions

ProductsApi.getSuggestions() method

Returns a list of all available suggestions related to a given term and limits the results to a specific value of the max parameter. Get a list of available suggestions

Signature:

getSuggestions(baseSiteId: string, term: string, fields?: string, max?: number, options?: any): Promise<import("axios").AxiosResponse<SuggestionList>>;

Parameters

Parameter	Type	Description
baseSiteId	string	Base site identifier
term	string	Specified term
fields	string	Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL
max	number	Specifies the limit of results.
options	any	Override http request option.

Returns:

Promise<import("axios").AxiosResponse<SuggestionList>>

Exceptions

{RequiredError} ProductsApi