query

Search Products

Query to search the catalog for products matching a term, with optional filters and pagination.

Query
GET/search/products

Overview

SearchProducts is handled by the Search APISearch APIServicev1.0.0Public-facing API that serves fast, relevant product search to the rest of the business, reading from the search index. Subscribessearch-productsAPIsOpenAPIOwnersearch-platformMapRepoView docs. It runs a full-text search over the Search IndexSearch IndexContainerv1.0.0The denormalised, search-optimised index of products that powers product search.MapView docs and returns a paginated list of matching products. Use this whenever you need to find products across the catalog, rather than fetching a single product by id with Get ProductGet ProductQueryv1.0.0Query to fetch a single product by its identifier. Ownerproduct-platformSchemaMapView docs.

Architecture diagram

Schema

Event-driven architecture documentation: Acme Inc

JSON Schema

21 properties

Query to search the catalog for products, and the paginated result returned

requestobject
required

Search parameters

responseobject
required

Paginated search results