Package com.broadleafcommerce.orderoperation.service

Class OrderOperationServiceProperties

java.lang.Object
com.broadleafcommerce.orderoperation.service.OrderOperationServiceProperties
@ConfigurationProperties("broadleaf.orderoperation.service") public class OrderOperationServiceProperties extends Object

  • Constructor Details

    • OrderOperationServiceProperties

      public OrderOperationServiceProperties()

  • Method Details

    • getOfferServicesVersion

      public String getOfferServicesVersion()
      The offer version enabled for external service calls with OrderOperationService. This is useful for maintaining backwards compatibility. If using the latest version, this property does not have to be supplied.

    • isDistributePaymentTransactionAmountAcrossPayments

      public boolean isDistributePaymentTransactionAmountAcrossPayments()
      Whether or not to distribute a payment transaction amount across the Order's payments proportionally.

      Let's say we have the following order setup:

      Order total - $100

      Paid with 2 payments - payment1: $30, payment2: $70

      Total of 3 items - item1: $10, item2: $50, item3: $40

      With this setup, the payment distribution ratios would be 0.3 (or 30%) for payment1 and 0.7 (or 70%) for payment2.

      With this property enabled, capturing or refunding an item would cause the amount to be distributed across the payments. For example, capturing item1 ($10) would trigger two payment transactions: $3 against payment1 and $7 against payment2.

      Note that enabling this property would potentially create more payment transactions (and network traffic) than necessary, since the amount would always be split across payments rather than executing the amount with a single transaction if possible.

    • setOfferServicesVersion

      public void setOfferServicesVersion(String offerServicesVersion)
      The offer version enabled for external service calls with OrderOperationService. This is useful for maintaining backwards compatibility. If using the latest version, this property does not have to be supplied.

    • setDistributePaymentTransactionAmountAcrossPayments

      public void setDistributePaymentTransactionAmountAcrossPayments(boolean distributePaymentTransactionAmountAcrossPayments)
      Whether or not to distribute a payment transaction amount across the Order's payments proportionally.

      Let's say we have the following order setup:

      Order total - $100

      Paid with 2 payments - payment1: $30, payment2: $70

      Total of 3 items - item1: $10, item2: $50, item3: $40

      With this setup, the payment distribution ratios would be 0.3 (or 30%) for payment1 and 0.7 (or 70%) for payment2.

      With this property enabled, capturing or refunding an item would cause the amount to be distributed across the payments. For example, capturing item1 ($10) would trigger two payment transactions: $3 against payment1 and $7 against payment2.

      Note that enabling this property would potentially create more payment transactions (and network traffic) than necessary, since the amount would always be split across payments rather than executing the amount with a single transaction if possible.