@plentymarkets/shop-api / getSearch

Function: getSearch()

getSearch(context, params): Promise<Data<ItemSearchResult>>

Defined in: api/getSearch/index.ts:28

Method getSearch - returns a list of products based on the search term

Parameters

context

PlentysystemsIntegrationContext

params

ItemSearchParams

term: string - The search term

Returns

Promise<Data<ItemSearchResult>>

products: Product[] - The list of products

Remarks

• Calls /rest/io/item/search/
• This method is used to search for products based on the search term.

Example

const { data } = await useSdk().plentysystems.getSearch({ term: 'Drone' });