Document Tree
Document Properties
Last Modified
Added to KB
Public Access
Doc Type
ICM 7.10
Guide - Rest API ProductHandler Rework

Table of Contents


To improve the performance and maintainability of the product Rest API, the ProductHandler got a new java-based implementation. Therefore, some customizations of the former pipeline-based implementation may not work anymore.


The following artifacts are (partially) not used anymore:

  • ProductHandlerImpl defined by app_sf_rest:implementations.component
  • ProcessSearchREST.pipeline of cartridge app_sf_rest
  • ProcessCatalogREST.pipeline of cartridge app_sf_rest

If there are any customizations related to these files, it is possible to still use the ProductHandlerImpl via the component framework. However, this is not recommend, because the ProductHandlerImpl is deprecated and will be removed in the near future.

The new implementation of the ProductHandler is called ProductSearchHandlerImpl. It will handle both search index and query based searches for products. Therefore, two new Interfaces were added:


They both are implemented by default with our query and search index based product search and bound via Google Guice. If customizations are existent in ProcessSearchREST or ProcessCatalogREST, own implementation of these interfaces are possible.

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.
The Intershop Knowledge Portal uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Please find further information on privacy in the Intershop Privacy Policy and Legal Notice.
Knowledge Base
Product Releases
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to if you experience login issues,
or if you want to register as customer.