Home > @vsf-enterprise/sapcc-api > ProductSearchProps

ProductSearchProps interface

Properties passed to searchProduct API function.


export interface ProductSearchProps extends BaseProps 

Extends: BaseProps


Property Type Description
currentPage? number (Optional) The current result page requested.
filters? Record<string, unknown[]> (Optional) Facet names and their values to filter the returned results by.
pageSize? number (Optional) The number of results returned per page.
query? string (Optional) Parameter allowing us to pass on a raw query string expected by SAP OCC API.
searchQueryContext? string (Optional) The context to be used in the search query.
searchTerm? string (Optional) A string to search product suggestions by. A query-building parameter.
sort? string (Optional) Sorting method applied to the return results.