ProductViewHandler
This class provides RESTful services to retrieve product data for search-based catalog navigation. It delegates to the CatalogNavigationView noun to perform the operations.
Note: The hostname
used in the
resourceId element in the response is
determined by the HostName attribute in the WebServer element
of the WebSphere
Commerce configuration file.| Method Name | HTTP Method | URL | Query Params | Description | Authentication | Example |
|---|---|---|---|---|---|---|
| findProductsBySearchTerm | GET | store/{storeId}/productview/bySearchTerm/{searchTerm} | pageNumber={pageNumber}&pageSize={pageSize}&intentSearchTerm={intentSearchTerm}&originalSearchTerm={originalSearchTerm}&categoryId={categoryId}&searchType={searchType}&filterTerm={filterTerm}&filterType={filterType}&manufacturer={manufacturer}&minPrice={minPrice}&maxPrice={maxPrice}&facet={facet}&advancedFacetList={advancedFacetList}&filterFacet={filterFacet}&orderBy={orderBy}&metaData={metaData}&searchSource={searchSource}&responseFormat={responseFormat} | Gets matching products for a given search term. Supports specifying conditions to filter the search results. | No,HTTP | Sample |
| findProductById | GET | store/{storeId}/productview/byId/{productId} | responseFormat={responseFormat} | Gets product details based on the product ID. | No,HTTP | Sample |
| findProductByPartNumber | GET | store/{storeId}/productview/{partNumber} | responseFormat={responseFormat} | Gets product details based on the part number. | No,HTTP | Sample |
| findProductsByCategory | GET | store/{storeId}/productview/byCategory/{categoryId} | pageNumber={pageNumber}&pageSize={pageSize}&orderBy={orderBy}&responseFormat={responseFormat} | Gets all products belonging to a category based on the category's unique ID. | No,HTTP | Sample |