SearchProductsRequest

SearchProductsRequest is a data structure used by client applications to request product search results from a catalog or search service. It encapsulates user input such as a textual query, filter constraints, and pagination and sorting preferences, enabling the server to return a tailored list of products along with summary metadata.

Common fields typically supported include a query string for the search terms, pageSize indicating the number of results per page, and a pageToken or pageIndex for pagination. Sorting may be controlled with sortBy, while filters allow constraints on attributes such as category, price range, brand, and rating. Optional features may include facets or refinements for result breakdown, includeOutOfStock or inStockOnly flags for availability, locale and currency for localization, and a fields list to specify which response fields to include. In multi-tenant catalogs, context such as storeId or catalogId may be provided to scope the search.

The service processing a SearchProductsRequest usually returns a SearchProductsResponse containing a list of product summaries, the total number of matching results, and a nextPageToken or similar pagination token when more results are available. Additional data may include facet values for the requested facets, and response metadata such as processing time or spell correction suggestions.

Usage and expectations: SearchProductsRequest is typically constructed by client SDKs or API clients and validated by the server. Invalid inputs may yield error responses such as invalid arguments or missing required fields, while valid requests aim to be idempotent and efficient, returning relevant products consistent with the specified query and filters.