Searches WEM's catalogue and its connected retailer sources for products matching a query

Search products by name or identifier (barcode, ASIN, MPN, SKU, WEM ID, wem3.ai/pl URL, or a comma list). catalogMatch gives a held product's offers. Weak matches are withheld and counted in filtered.

post/api/agent/products/search_products

Request

  • Base URL: https://wem3.ai
  • URL: https://wem3.ai/api/agent/products/search_products
  • Auth: none declared

Request body

querystring required

A product name, or an identifier: barcode (EAN/UPC/GTIN), ASIN, MPN, merchant SKU, WEM ID or wem3.ai/pl URL. Several identifiers may be comma-separated.

categorystring

Optional. Keeps only live retailer listings whose own category name matches this text exactly; catalogue matches ignore it. Leave it out unless the shopper names a retailer's category.

min_pricenumber

Lowest price to include, in currency. Applies to retailer listings, not to catalogMatch.

max_pricenumber

Highest price to include, in currency. Applies to retailer listings, not to catalogMatch.

sort_by'relevance' | 'price_asc' | 'price_desc' | 'rating'

Order of the live retailer listings (default relevance). Not applied when the query identifies a product.

providersstring[]

Retailer sources to search live, e.g. ["amazon", "awin"]. Omit for all. Catalogue matches are not limited by it.

limitnumber

How many listings to request from each retailer source (default 10, max 30). The combined list can hold more.

gtinstring

A product barcode (EAN/UPC/GTIN) the host already has. When given, retailer sources are searched by this barcode instead of by the query words.

currencystring

ISO 4217 code for the shopper's market. Default GBP. Results and price filters use this currency.

Response

Tool result. success: false means the tool ran and reported a problem.

successboolean required
dataobject

Shape depends on the tool. Search-style results carry products, an optional catalogMatch of identity-resolved offers, and filtered, a count by reason of the weak matches withheld — report that count rather than implying the search was exhaustive.

errorstring

Changes

No recorded changes to this operation across all 1 revision of this API.