ProductViewHandler
This class provides RESTful services to get product data for search-based catalog navigation. It performs the service by delegating to the CatalogNavigationView BOD service.
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 Parameters | 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}searchSource={searchSource}&searchType={searchType}&intentSearchTerm={intentSearchTerm}&originalSearchTerm={originalSearchTerm}&categoryId={categoryId}metaData={metaData}&facet={facet}*&facetLimit={facetLimit}*&advancedFacetList={advancedFacetList}&filterFacet={filterFacet}&filterTerm={filterTerm}&filterType={filterType}&manufacturer={manufacture}&minPrice={minPrice}&maxPrice={maxPrice}&physicalStoreId={physicalStoreId}*&pageSize={pageSize}&pageNumber={pageNumber}&orderBy={orderBy}. | Gets matching products for a given search term. It 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 |
| findProductsByIds | GET | store/{storeId}/productview/byIds/ | id={id}&responseFormat={responseFormat}id={productId}*. | 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 unique ID. | No,HTTP | Sample |