Package com.broadleafcommerce.catalogbrowse.service.provider

Interface RecommendationProvider

All Known Implementing Classes:
ExternalRecommendationProvider
public interface RecommendationProvider
Provider for interfacing with operations that utilize a recommendation engine. Typically utilizes WebClient to make requests to an external REST API.

  • Method Details

    • fetchRecommendationsForCustomer

      UserRecommendation fetchRecommendationsForCustomer(RecommendationRequest recommendationRequest, CustomerRef customerRef, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Retrieves any recommendations for the user based on context.
      Parameters:
      recommendationRequest - all the relevant information to be used to retrieve recommendations
      customerRef - the customer for which recommendations should be returned
      contextInfo - additional context info needed to query appropriate recommendations
      Returns:
      Recommendations for the user provided.
      Throws:
      ProviderApiException - if the provider encounters an error with the request.