Package com.broadleafcommerce.catalogbrowse.service.provider

Interface OfferProvider

All Known Implementing Classes:
ExternalOfferProvider
public interface OfferProvider
Provider for interfacing with operations around offer related entities. Typically utilizes WebClient to make requests to an external REST API.
Author:
Jon Fleschler (jfleschler)

  • Method Details

    • fetchMarketingMessagesForRequest

      MarketingMessageResponse fetchMarketingMessagesForRequest(MarketingMessageRequest request)
      Retrieves any marketing messages for the request.
      Parameters:
      request - all the relevant information to be used to retrieve marketing messages
      Returns:
      The marketing message for the parameters provided.
      Throws:
      ProviderApiException - if the provider encounters an error with the request.

    • fetchActiveOffersByIds

      List<Offer> fetchActiveOffersByIds(Collection<String> offerIds, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Retrieves all active offers matching the passed ids.
      Parameters:
      offerIds - list of offer ids to fetch
      contextInfo - information derived from the original request containing tenant and sandbox info
      Returns:
      list of active offers matching the passed ids