Skip to content
On this page

searchProducts ​

Definition ​

Search for products based on criteria. From: Shopware 6.4

Signature ​

ts
export async function searchProducts(
  criteria?: ShopwareSearchParams & { query?: string },
  contextInstance: ShopwareApiInstance = defaultInstance,
): Promise<ProductListingResult> 

Parameters ​

NameTypeDescription
criteria
search criteria for products
contextInstance
ShopwareApiInstance
instance of the api client (by default it's an Axios instance)

Return type ​

ts
Promise<ProductListingResult>

Usage example ​

WARNING

Example is generated automatically. Sometimes it's required to be adjusted to your needs.

Open in StackBlitz

searchProducts has loaded