Package com.broadleafcommerce.promotion.offer.service.provider.external

Interface ExternalOfferProvider

public interface ExternalOfferProvider
Provider for interfacing with operations around offer related entities. Typically utilizes the WebClient to make requests to an external REST API.
Since:
Offer Service 3.1.0, Release Train 2.2.0
Author:
Julia Lopez-Pozas (jlopezpozas)

  • Method Summary

    Modifier and Type
    Method
    Description
    EnhancedOrder
    provideItemOffers(EnhancedOrder enhancedOrder, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Retrieves item-level offer data and modifies the order's items by adding external item offer data (in the form of ItemResponseDetail) to EnhancedLineItem.externalOfferDetails.
    EnhancedOrder
    provideOrderOffers(EnhancedOrder enhancedOrder, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Retrieves order-level offer data and modifies the order by adding external order offer data (in the form of OrderOfferAdjustment) to EnhancedOrder.externalOrdersAdjustments.

  • Method Details

    • provideItemOffers

      EnhancedOrder provideItemOffers(EnhancedOrder enhancedOrder, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Retrieves item-level offer data and modifies the order's items by adding external item offer data (in the form of ItemResponseDetail) to EnhancedLineItem.externalOfferDetails.
      Parameters:
      enhancedOrder - the order to populate with external offer data
      contextInfo - context information around the sandbox and multitenant state
      Returns:
      the order populated with external item-level offer data

    • provideOrderOffers

      EnhancedOrder provideOrderOffers(EnhancedOrder enhancedOrder, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Retrieves order-level offer data and modifies the order by adding external order offer data (in the form of OrderOfferAdjustment) to EnhancedOrder.externalOrdersAdjustments.
      Parameters:
      enhancedOrder - the order to populate with external offer data
      contextInfo - context information around the sandbox and multitenant state
      Returns:
      the order populated with external order-level offer data