@plentymarkets/shop-api / getItemSearchAutocomplete

Function: getItemSearchAutocomplete()

getItemSearchAutocomplete(context, params): Promise<Data<ItemSearchAutocompleteResult>>

Defined in: api/getItemSearchAutocomplete/index.ts:33

Method getItemSearchAutocomplete - returns autocomplete suggestions based on a search query

Parameters

context

PlentysystemsIntegrationContext

params

ItemSearchAutocompleteParams

query: string - The search query (optional, max 80 characters) types: array - Types of suggestions to return: 'category' and/or 'suggestion' (optional)

Returns

Promise<Data<ItemSearchAutocompleteResult>>

categories: ItemSearchAutocompleteCategory[] - Category suggestions items: ItemSearchAutocompleteItem[] - Item suggestions with price information suggestions: ItemSearchAutocompleteSuggestion[] - Search term suggestions total: number - Total number of results

Remarks

• Calls /rest/storefront/item/search/autocomplete
• This method is used to get autocomplete suggestions for categories and search terms.

Example

const { data } = await useSdk().boilerplate.getItemSearchAutocomplete({
  query: 'sofa',
  types: ['category', 'suggestion']
});