Serialized Form

  • Package com.broadleafcommerce.cart.domain

    • Class com.broadleafcommerce.cart.domain.StoredCartItem

      class StoredCartItem extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • adjustmentsTotal
          BigDecimal adjustmentsTotal
          See Also:
          • CartItem.getAdjustmentsTotal()
        • attributeChoices
          Map<String,com.broadleafcommerce.order.common.domain.AttributeChoiceValue> attributeChoices
          See Also:
          • CartItem.getAttributeChoices()
        • attributeConfigErrors
          Map<String,List<com.broadleafcommerce.cart.client.domain.ConfigError>> attributeConfigErrors
          See Also:
          • CartItem.getAttributeConfigErrors()
        • attributes
          Map<String,Object> attributes
          See Also:
          • CartItem.getAttributes()
        • brandId
          String brandId
          See Also:
          • CartItem.getBrandId()
        • categoryIds
          Set<String> categoryIds
          See Also:
          • CartItem.getCategoryIds()
        • contextId
          String contextId
          See Also:
          • CartItem.getId()
        • dependentCartItems
          List<com.broadleafcommerce.cart.client.domain.CartItem> dependentCartItems
          See Also:
          • CartItem.getDependentCartItems()
        • dependentItemDetails
          com.broadleafcommerce.cart.client.domain.DependentItemDetails dependentItemDetails
          See Also:
          • CartItem.getDependentItemDetails()
        • discountable
          boolean discountable
          See Also:
          • CartItem.isDiscountable()
        • imageAsset
          com.broadleafcommerce.cart.client.domain.ImageAssetRef imageAsset
          See Also:
          • CartItem.getImageAsset()
        • internalAttributes
          Map<String,Object> internalAttributes
          See Also:
          • CartItem.getInternalAttributes()
        • isPriced
          boolean isPriced
          See Also:
          • CartItem.isPriced()
        • itemAdjustments
          List<com.broadleafcommerce.order.common.domain.Adjustment> itemAdjustments
          See Also:
          • CartItem.getItemAdjustments()
        • itemConfigErrors
          List<com.broadleafcommerce.cart.client.domain.ConfigError> itemConfigErrors
          See Also:
          • CartItem.getDependentItemConfigErrors()
        • merchandisingContext
          String merchandisingContext
          See Also:
          • CartItem.getMerchandisingContext()
        • merchandisingTypeId
          String merchandisingTypeId
          See Also:
          • CartItem.getMerchandisingTypeId()
        • name
          String name
          See Also:
          • CartItem.getName()
        • overrideDetails
          List<com.broadleafcommerce.order.common.domain.OverrideDetail> overrideDetails
          See Also:
          • CartItem.getOverrideDetails()
        • overridePriceFlag
          boolean overridePriceFlag
          See Also:
          • CartItem.getOverrideDetails()
        • priceListId
          String priceListId
          See Also:
          • CartItem.getPriceListId()
        • pricingKey
          String pricingKey
          See Also:
          • CartItem.getPricingKey()
        • pricingStrategy
          String pricingStrategy
          See Also:
          • CartItem.getPricingStrategy()
        • productId
          String productId
          See Also:
          • CartItem.getProductId()
        • productTags
          List<String> productTags
          See Also:
          • CartItem.getProductTags()
        • proratedOrderOfferAdjustments
          List<com.broadleafcommerce.order.common.domain.ProratedOfferAdjustment> proratedOrderOfferAdjustments
          See Also:
          • CartItem.getProratedOrderOfferAdjustments()
        • quantity
          int quantity
          See Also:
          • CartItem.getQuantity()
        • recurringPrice
          com.broadleafcommerce.order.common.domain.RecurringPriceDetail recurringPrice
          See Also:
          • CartItem.getRecurringPrice()
        • sku
          String sku
          See Also:
          • CartItem.getSku()
        • subtotal
          BigDecimal subtotal
          See Also:
          • CartItem.getSubtotal()
        • targetDemographicId
          String targetDemographicId
          See Also:
          • CartItem.getTargetDemographicId()
        • taxable
          boolean taxable
          See Also:
          • CartItem.isTaxable()
        • termDurationLength
          Integer termDurationLength
          See Also:
          • CartItem.getTermDurationLength()
        • termDurationType
          String termDurationType
          See Also:
          • CartItem.getTermDurationType()
        • total
          BigDecimal total
          See Also:
          • CartItem.getTotal()
        • totalTax
          BigDecimal totalTax
        • type
          String type
          See Also:
          • CartItem.getType()
        • unitPrice
          BigDecimal unitPrice
          See Also:
          • CartItem.getUnitPrice()
        • unitPriceType
          String unitPriceType
          See Also:
          • CartItem.getUnitPriceType()
        • uri
          String uri
          See Also:
          • CartItem.getUri()
        • usagePrice
          com.broadleafcommerce.order.common.domain.UsagePriceDetail usagePrice
          See Also:
          • CartItem.getUsagePrice()
        • variantId
          String variantId
          See Also:
          • CartItem.getVariantId()
        • vendorRef
          String vendorRef
          See Also:
          • CartItem.getVendorRef()

  • Package com.broadleafcommerce.cart.provider.jpa.domain

  • Package com.broadleafcommerce.cart.provider.jpa.repository.util

  • Package com.broadleafcommerce.cart.service.exception

  • Package com.broadleafcommerce.cart.service.messaging.event

    • Class com.broadleafcommerce.cart.service.messaging.event.CartApprovalRequestEvent

      class CartApprovalRequestEvent extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • accountId
          String accountId
          ID of the account the submitter belongs to.
        • additionalAttributes
          Map<String,Object> additionalAttributes
          A map of additional attributes that provides flexibility for a more extensive usage of this event.
        • cartActionAudit
          com.broadleafcommerce.cart.client.domain.CartActionAudit cartActionAudit
          The CartActionAudit object generated to record this submission.
        • cartId
          String cartId
          The id of the cart that was requested to be approved. The cart's id can be used to reference other related objects, such as previous CartActionAudits.
        • contextInfo
          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo
          The ContextInfo containing tenant and sandbox info.
        • submitterEmail
          String submitterEmail
          The email address of the customer whose cart was submitted.
        • submitterFullName
          String submitterFullName
          The full name of the customer whose cart was submitted.

    • Class com.broadleafcommerce.cart.service.messaging.event.CartAwaitingPaymentResultsEvent

      class CartAwaitingPaymentResultsEvent extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalAttributes
          Map<String,Object> additionalAttributes
          Any extra properties needed for this event
        • cart
          com.broadleafcommerce.cart.client.domain.CheckoutCart cart
          The cart that is being processed as part of a checkout attempt
        • contextInfo
          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo
          The ContextInfo derived from the original request containing tenant and sandbox info.
        • paymentNextActions
          List<PaymentNextAction> paymentNextActions
          A collection of PaymentNextActions describing the required next steps for the payment.
        • paymentSummaries
          List<PaymentSummary> paymentSummaries
          A collection of the cart's PaymentSummaries

    • Class com.broadleafcommerce.cart.service.messaging.event.CartPendingPaymentFailedEvent

      class CartPendingPaymentFailedEvent extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalAttributes
          Map<String,Object> additionalAttributes
          Any extra properties needed for this event
        • cart
          com.broadleafcommerce.cart.client.domain.CheckoutCart cart
          The cart that is being processed as part of a checkout attempt
        • contextInfo
          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo
          The ContextInfo derived from the original request containing tenant and sandbox info.

    • Class com.broadleafcommerce.cart.service.messaging.event.CartRejectionEvent

      class CartRejectionEvent extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • accountId
          String accountId
          ID of the B2B account the cart belongs to.
        • additionalAttributes
          Map<String,Object> additionalAttributes
          A map of additional attributes that provides flexibility for a more extensive usage of this event
        • cartActionAudit
          com.broadleafcommerce.cart.client.domain.CartActionAudit cartActionAudit
          The CartActionAudit object generated to record this rejection
        • cartId
          String cartId
          The id of the cart that was rejected The cart's id can be used to reference other related objects, such as previous CartActionAudits.
        • contextInfo
          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo
          The ContextInfo containing tenant and sandbox info.
        • customerFullName
          String customerFullName
          The full name of the customer whose cart was rejected
        • emailAddress
          String emailAddress
          The email address of the customer whose cart was rejected
        • rootAccountId
          String rootAccountId
          The root B2B account's Id. This could be an ancestor of the current account.

    • Class com.broadleafcommerce.cart.service.messaging.event.CheckoutCompletionEvent

      class CheckoutCompletionEvent extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • cart
          com.broadleafcommerce.cart.client.domain.CheckoutCart cart
          The cart object that completed the checkout workflow
        • contextInfo
          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo
          The ContextInfo derived from the original request containing tenant and sandbox info.
        • paymentSummaries
          List<PaymentSummary> paymentSummaries
          The payments for the cart that completed the checkout workflow
        • requestId
          String requestId
          The id representing this request to checkout This value can be used to identify entities that were produced due to this request and therefore need to be rolled back

    • Class com.broadleafcommerce.cart.service.messaging.event.CheckoutRollbackEvent

      class CheckoutRollbackEvent extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • cartId
          String cartId
          The id of the cart that was submitted for checkout
        • contextInfo
          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo
          The ContextInfo derived from the original request containing tenant and sandbox info.
        • failureType
          String failureType
          The failureType indicating the cause of rollback
        • requestId
          String requestId
          The id representing this request to checkout This value can be used to identify entities that were produced due to this request and therefore need to be rolled back

    • Class com.broadleafcommerce.cart.service.messaging.event.ExternalPaymentTransactionCartFinalizationEvent

      class ExternalPaymentTransactionCartFinalizationEvent extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalAttributes
          Map<String,Object> additionalAttributes
          A map of additional attributes that provides flexibility for a more extensive usage of this event.
        • cartId
          String cartId
          The cart that is being processed as part of a checkout attempt
        • contextInfo
          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo
          The ContextInfo derived from the original request containing tenant and sandbox info.

    • Class com.broadleafcommerce.cart.service.messaging.event.NextAction

      class NextAction extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • actionType
          String actionType
          The type of action that must be taken.
        • attributes
          Map<String,Object> attributes
          Map holding any additional attributes not matching any defined properties.
        • redirectUrl
          String redirectUrl
          The gateway-provided url that can redirect to the next action the customer must take. This URL can be used for redirecting to hosted payments page, displaying a 3D Secure form, etc. The customer is typically redirected to this location, but the page can also be rendered within an iframe if this is supported by the gateway.

    • Class com.broadleafcommerce.cart.service.messaging.event.PaymentNextAction

      class PaymentNextAction extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • nextAction
          NextAction nextAction
          The next step required for the payment gateway to continue processing this payment.
        • paymentId
          String paymentId
          The id of the payment.

    • Class com.broadleafcommerce.cart.service.messaging.event.PaymentSummary

      class PaymentSummary extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • accessRestrictions
          List<String> accessRestrictions
          The list of restrictions that apply to payment access.
        • addressByType
          Map<String,com.broadleafcommerce.order.common.domain.Address> addressByType
          The collection of related addresses that may include billing or shipping addresses
        • adjustmentsTotal
          javax.money.MonetaryAmount adjustmentsTotal
          The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.
        • amount
          javax.money.MonetaryAmount amount
          The amount for which this payment is allotted. The summation of all of the payments for a particular cart should equal the cart's total. If specified, the amount details (PaymentSummary.subtotal, PaymentSummary.adjustmentsTotal, PaymentSummary.fulfillmentTotal, & PaymentSummary.taxTotal) should sum together to equal this amount.
        • amountAuthorized
          javax.money.MonetaryAmount amountAuthorized
          The total authorized amount for capture. This value is calculated as "total authorized - total reverse-authed".
        • amountCaptured
          javax.money.MonetaryAmount amountCaptured
          The total captured amount. This value is calculated as "total captured - total refunded - total voided".
        • amountCredited
          javax.money.MonetaryAmount amountCredited
          The total detached credit amount.
        • amountRefunded
          javax.money.MonetaryAmount amountRefunded
          The total refunded amount.
        • attributes
          Map<String,String> attributes
          General use map to capture any additional attributes needed for this Payment
        • captureAmountAwaitingResult
          javax.money.MonetaryAmount captureAmountAwaitingResult
          The total amount sent to the payment gateway for capture, and is waiting for a response about the transaction result.

          This value should only be present for payment gateways that support asynchronous transaction executions.

        • displayAttributes
          Map<String,String> displayAttributes
          General use map to capture any display properties for this Payment
        • fulfillmentTotal
          javax.money.MonetaryAmount fulfillmentTotal
          The payment's total fulfillment cost
        • gatewayType
          String gatewayType
          The gateway used to process this payment. Only a SINGLE payment gateway can modify transactions on a particular payment.
        • isSingleUsePaymentMethod
          boolean isSingleUsePaymentMethod
          Whether or not the underlying payment method can only be used once. In most cases, we're managing a single-use token that represents a credit card. This flag is especially important for managing payments with successful transactions. In those cases, the token has already been used and cannot be reused. If we need modify the payment's amount, then we may actually need to archive the existing payment, and create a new payment, with a new underlying token. Additionally, this flag is helpful when needing to re-authorize an expired authorization transaction. In that case, if the payment represents a single-use payment method, then the re-authorization may not be possible, and you'll need to seek an alternative form of payment.
        • name
          String name
          The name of this payment. This name is typically something like "Visa ending in 1234".
        • paymentId
          String paymentId
          The id of this payment.
        • subtotal
          javax.money.MonetaryAmount subtotal
          The payment's total usually excluding adjustments, tax, and shipping.
        • taxTotal
          javax.money.MonetaryAmount taxTotal
          The payment's total tax cost
        • type
          String type
          The type of this payment like Credit Card or Gift Card.
        • version
          Integer version
          The version of this payment. Used for checking that the requested version of the payment is up-to-date before saving changes. Required for any request which results in an update being made to the payment. This should never be manually incremented/decremented.

    • Class com.broadleafcommerce.cart.service.messaging.event.QuoteStatusChangedEvent

      class QuoteStatusChangedEvent extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalAttributes
          Map<String,Object> additionalAttributes
          A map of additional attributes that provides flexibility for a more extensive usage of this event
        • cartActionAudit
          com.broadleafcommerce.cart.client.domain.CartActionAudit cartActionAudit
          The CartActionAudit object generated to record this status change
        • contextInfo
          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo
          The ContextInfo containing tenant and sandbox info.
        • customerEmail
          String customerEmail
          The email address of the customer whose quote's status was changed
        • customerRef
          com.broadleafcommerce.order.common.domain.CustomerRef customerRef
          The CustomerRef representing the owner of the quote.
        • quoteId
          String quoteId
          The id of the quote that was rejected
        • salesRepEmail
          String salesRepEmail
          The email of the sales rep assigned to this quote

          If not assigned to a certain sales rep, defaults to a configured sales email.

        • salesRepName
          String salesRepName
          The name of the sales rep assigned to this quote

          May be null if not assigned in certain statuses, e.g. quote requested

        • salesRepUserId
          String salesRepUserId
          The user id of the sales rep assigned to this quote.

          May be null if not assigned in certain statuses, e.g. quote requested

  • Package com.broadleafcommerce.cart.web.endpoint.domain

    • Class com.broadleafcommerce.cart.web.endpoint.domain.UpdateCartRequest

      class UpdateCartRequest extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • cart
          com.broadleafcommerce.cart.client.domain.Cart cart
          An updated Cart object.
        • cartActionAuditToCreate
          com.broadleafcommerce.cart.client.domain.CartActionAudit cartActionAuditToCreate
          A CartActionAudit to create along with the cart update.

          This is typically for B2B use cases where a CartActionAudit needs to be created when an action is performed on an account cart.

  • Package com.broadleafcommerce.cart.web.endpoint.domain.audit