Serialized Form (Broadleaf Cart Operation Services 1.7.2-SNAPSHOT API)

Package com.broadleafcommerce.cartoperation.domain
- Class com.broadleafcommerce.cartoperation.domain.AdvancedTag extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - attributes
      
      Map<String,Object> attributes
      
      Map holding any additional attributes passed in the request not matching any defined properties.
    - id
      
      String id
      
      A unique system identifier.
    - name
      
      String name
      
      A friendly identifier for the tag.
    - position
      
      String position
      
      Defines the position over a display component this tag should be displayed such as the "top-left" of a Product's image on a list or details page. If multiple tags have the same position, then their relative order on a product or their AdvancedTag.priority will determine which is displayed.
    - priority
      
      Long priority
      
      Priority of this tag relative to other tags that may share the same AdvancedTag.position or AdvancedTag.type. This provides a way to pick on tag over another when there is a conflict. This could be overridden in the context of a specific product depending on the ProductTag.getSorting().
    - type
      
      String type
      
      Defines the type of this tag such as "key feature" or "discount". This allows categorizing tags to enhance user's ability to prioritize related tags such as only showing one "discount" tag even if a product has several.
- Class com.broadleafcommerce.cartoperation.domain.Attribute extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - attributes
      
      Map<String,Object> attributes
      
      Map holding any additional attributes passed in the request not matching any defined properties.
    - value
      
      Serializable value
      
      The value represented by this attribute. Attributes are generally placed on domain objects as a map of attribute names to attribute values: Map<String, Attribute>.
- Class com.broadleafcommerce.cartoperation.domain.AttributeChoice extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - allowedValues
      
      List<AttributeChoiceValue> allowedValues
      
      Gives the customer more structured input to fill out their option, which can drive a select field or a color picker with particular colors. This restricts the available values that the user can use to complete this option.
      When used to distinguish variants, a value in this list should correspond to the value in a variant's Variant.getOptionValues() map for the AttributeChoice.attributeName key.
    - attributeName
      
      String attributeName
      
      The order or item attribute that this choice is stored in when the user adds to their cart
      When used to distinguish variants, this field corresponds to a key in Variant.getOptionValues().
    - attributes
      
      Map<String,Object> attributes
      
      Map holding any additional attributes passed in the request not matching any defined properties.
    - errorCode
      
      String errorCode
      
      In case of a validation failure in conjunction with a AttributeChoice.getValidationStrategy() this is the error code that should be shown to customers. This could map into a special message key on the frontend or provide additional information to the user in addition to AttributeChoice.getErrorMessage().
      
      See Also:
      
      AttributeChoice.getErrorMessage()
    - errorMessage
      
      String errorMessage
      
      In case of a validation failure in conjunction with a AttributeChoice.getValidationStrategy() this is the message that should be shown to customers. Intended to be displayed directly on the page when the AttributeChoice.getValidationStrategy() fails validation.
    - required
      
      boolean required
      
      Whether or not the user is required to fill out this option in order to add the product to their cart. This is always validated on cart add.
    - validationRule
      
      String validationRule
      
      If AttributeChoice.validationType is regex, this is the expression that should execute against the user's value.
    - validationStrategy
      
      String validationStrategy
      
      The strategy used to determine when this product option is validated. For example, validation can be done when a product is added to a cart, when an order is submitted, or never (null). Regardless of this strategy, AttributeChoice.required and AttributeChoice.allowedValues are always validated.

Package com.broadleafcommerce.cartoperation.domain.enums

Package com.broadleafcommerce.cartoperation.domain.payment

Class com.broadleafcommerce.cartoperation.domain.payment.CheckoutPaymentMethodOption extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

paymentMethodGatewayType

String paymentMethodGatewayType

The gateway configured for this payment method.

paymentMethodType

String paymentMethodType

The type of this payment like Credit Card or Gift Card.

Class com.broadleafcommerce.cartoperation.domain.payment.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".

amountAwaiting3DSResult

javax.money.MonetaryAmount amountAwaiting3DSResult

The total amount of Authorize or AuthorizeAndCapture transactions that require 3DS verification. Note: this excludes transactions that previously required 3DS verification, but we now have transaction results for.
This value should only be present for payment gateways that support 3DS verification.

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.

Package com.broadleafcommerce.cartoperation.exception

Class com.broadleafcommerce.cartoperation.exception.AddCodeException extends RuntimeException implements Serializable

Serialized Fields

reasonType

String reasonType

The reason type for why the code could not be added.

Class com.broadleafcommerce.cartoperation.exception.AddPaymentException extends RuntimeException implements Serializable

Class com.broadleafcommerce.cartoperation.exception.CartFinalizationException extends CheckoutException implements Serializable

Class com.broadleafcommerce.cartoperation.exception.CartItemValidationException extends RuntimeException implements Serializable

Serialized Fields

cartItem

com.broadleafcommerce.cart.client.domain.CartItem cartItem

The invalid CartItem with the errors.

Class com.broadleafcommerce.cartoperation.exception.CartValidationException extends RuntimeException implements Serializable

serialVersionUID:

1L

Class com.broadleafcommerce.cartoperation.exception.CartVersionRequiredException extends RuntimeException implements Serializable

Class com.broadleafcommerce.cartoperation.exception.CheckoutCompletionMessageException extends CheckoutException implements Serializable

Class com.broadleafcommerce.cartoperation.exception.CheckoutException extends RuntimeException implements Serializable

Serialized Fields

additionalInfo

Map<String,Object> additionalInfo

The map that can be used to specify the additional info for this exception.

cart

com.broadleafcommerce.cart.client.domain.Cart cart

The cart whose checkout is being finalized.

failureType

String failureType

The category of workflow failure that caused this exception.

See Also:

CheckoutFailureType

Class com.broadleafcommerce.cartoperation.exception.CheckoutWorkflowActivityException extends RuntimeException implements Serializable

Serialized Fields

additionalInfo

Map<String,Object> additionalInfo

The map that can be used to specify the additional info for this exception.

cart

com.broadleafcommerce.cart.client.domain.Cart cart

The cart whose checkout is being processed in the activity.

failureType

String failureType

The category of workflow failure that caused this exception.

See Also:

CheckoutFailureType

itemFailureMessages

Map<String,String> itemFailureMessages

Line item error messages used to describe issues with individual fields, cart items, etc. For example, this may consist of map entries where the key is a cart item id (or name) & the value is an explanation of why the item is misconfigured.

paymentTransactionFailureDetails

List<PaymentTransactionFailureDetail> paymentTransactionFailureDetails

A collection of PaymentTransactionFailureDetails describing how the transaction(s) failed.

Class com.broadleafcommerce.cartoperation.exception.CheckoutWorkflowException extends CheckoutException implements Serializable

Serialized Fields

itemFailureMessages

Map<String,String> itemFailureMessages

Line item error messages used to describe issues with individual fields, cart items, etc. For example, this may consist of map entries where the key is a cart item id (or name) & the value is an explanation of why the item is misconfigured.

paymentTransactionFailureDetails

List<PaymentTransactionFailureDetail> paymentTransactionFailureDetails

A collection of PaymentTransactionFailureDetails describing how the transaction(s) failed.

Class com.broadleafcommerce.cartoperation.exception.CheckoutWorkflowRollbackException extends RuntimeException implements Serializable

Class com.broadleafcommerce.cartoperation.exception.CheckoutWorkflowRollbackMessageException extends RuntimeException implements Serializable

Class com.broadleafcommerce.cartoperation.exception.GuestTokenValidationException extends RuntimeException implements Serializable

Class com.broadleafcommerce.cartoperation.exception.InvalidAddPaymentRequestException extends RuntimeException implements Serializable

Class com.broadleafcommerce.cartoperation.exception.InvalidUpdatePaymentRequestException extends RuntimeException implements Serializable

Class com.broadleafcommerce.cartoperation.exception.OverridePriceException extends RuntimeException implements Serializable

Class com.broadleafcommerce.cartoperation.exception.PaymentLockException extends RuntimeException implements Serializable

serialVersionUID:

1L

Class com.broadleafcommerce.cartoperation.exception.PaymentTransactionFailureException extends RuntimeException implements Serializable

serialVersionUID:

1L

Serialized Fields

cart

com.broadleafcommerce.cart.client.domain.Cart cart

The cart whose payment is being processed.

paymentTransactionFailureDetails

List<PaymentTransactionFailureDetail> paymentTransactionFailureDetails

A collection of PaymentTransactionFailureDetails describing how the transaction(s) failed.

Class com.broadleafcommerce.cartoperation.exception.ProviderApiException extends RuntimeException implements Serializable

Serialized Fields

receivedException

org.springframework.web.reactive.function.client.WebClientResponseException receivedException

The received error.

Class com.broadleafcommerce.cartoperation.exception.RejectedItemMergeException extends RuntimeException implements Serializable

Class com.broadleafcommerce.cartoperation.exception.StaleCartException extends RuntimeException implements Serializable

Serialized Fields

upToDateCart

com.broadleafcommerce.cart.client.domain.Cart upToDateCart

Class com.broadleafcommerce.cartoperation.exception.TransferCartTokenCreationException extends RuntimeException implements Serializable

Class com.broadleafcommerce.cartoperation.exception.TransferCartTokenEncoderException extends Exception implements Serializable

Class com.broadleafcommerce.cartoperation.exception.TransferCartTokenParseException extends Exception implements Serializable

Package com.broadleafcommerce.cartoperation.exception.security

Class com.broadleafcommerce.cartoperation.exception.security.AuthenticationRequiredException extends RuntimeException implements Serializable

Class com.broadleafcommerce.cartoperation.exception.security.NotOwnerException extends RuntimeException implements Serializable

Package com.broadleafcommerce.cartoperation.service.checkout

Class com.broadleafcommerce.cartoperation.service.checkout.DefaultCheckoutMessageRetryPolicyClassifier extends Object implements Serializable

Serialized Fields

retryPolicy

org.springframework.retry.RetryPolicy retryPolicy

Package com.broadleafcommerce.cartoperation.service.messaging.completion

Class com.broadleafcommerce.cartoperation.service.messaging.completion.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

Package com.broadleafcommerce.cartoperation.service.messaging.rollback

Class com.broadleafcommerce.cartoperation.service.messaging.rollback.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.

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

Package com.broadleafcommerce.cartoperation.service.provider.external

Class com.broadleafcommerce.cartoperation.service.provider.external.ExternalCartProvider.CartConflictResponse extends Object implements Serializable

Serialized Fields

newCart

com.broadleafcommerce.cart.client.domain.Cart newCart

Package com.broadleafcommerce.cartoperation.service.provider.external.domain.payment

Class com.broadleafcommerce.cartoperation.service.provider.external.domain.payment.LockPaymentRequest extends Object implements Serializable

Serialized Fields

ownerId

String ownerId

The id of the entity that owns this payment. For example, this may be a cart id, or a subscription billing cycle id.

ownerType

String ownerType

Describes the owner of the payment. For example, the payment could have originated with a cart or a subscription, therefore this value might be CART or SUBSCRIPTION.

Class com.broadleafcommerce.cartoperation.service.provider.external.domain.payment.TransactionExecutionDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

adjustmentsTotal

javax.money.MonetaryAmount adjustmentsTotal

The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.

attributes

Map<String,String> attributes

Map of specific attributes that have been gathered from the raw response. This should be used for data points that are to be used programmatically. For example, a gateway-specific transaction id that can be used to capture or refund the transaction. Note: It's very important that this does not include sensitive payment method data. Doing so will expand the PCI scope to include CartOperationServices and its related services.

dateRecorded

Instant dateRecorded

The timestamp when this transaction response was recorded

declineType

String declineType

The type of transaction failure (hard vs soft failure)

See Also:

PaymentDeclineType

failureType

String failureType

The type of transaction failure

See Also:

DefaultTransactionFailureTypes

fulfillmentTotal

javax.money.MonetaryAmount fulfillmentTotal

The payment's total fulfillment cost

gatewayResponseCode

String gatewayResponseCode

The response code provided by the payment gateway which may represent a success or failure

indeterminateResult

boolean indeterminateResult

Tells if this transaction has an indeterminate result.
Having an indeterminate result means that the true outcome of the transaction is not known. For example, if a transaction is sent to the payment processor but a network error occurred, it is not known to us whether the user was actually charged or not (thus, the result is indeterminate).
Transactions should be marked as indeterminate when sending to the payment processor, and then unmarked once a response is received, understood, and recorded. This means that a transaction in an indeterminate result state is expected during the sending to processor phase. However, if the transaction remains in that state for an excessive amount of time, something likely went wrong and the transaction will need to be reconciled. If the transaction changes from the sending to processor status but remains indeterminate, the transaction will also require reconciliation in that scenario.
Some situations which may lead to an indeterminate result:

A transaction is sent to the processor, but a network error prevents us from receiving the response

A transaction is sent to the processor, but the processor returns an unexpected error (e.g. 500 internal server error)

A transaction is sent to the processor and a response is received, but cannot be recorded because Cart Services is down

A transaction is sent to the processor and a response is received, but cannot be recorded because the database is down

message

String message

Message describing the result of the transaction

parentTransactionId

String parentTransactionId

The id of the parent payment transaction. Necessary for operations on a payment that require something to have happened beforehand. For instance, an authorize transaction would not have a parent but a capture must have an authorize parent transaction and a refund must have a capture parent transaction. The full set of expected parent-child transaction relationships are as follows:

Child Transaction -> Parent Transaction

Reverse Authorize -> Authorize

Capture -> Authorize

Refund -> Capture

Refund -> AuthorizeAndCapture

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

threeDSecureVerificationUrl

String threeDSecureVerificationUrl

The gateway-provided url where the customer must verify that they are in fact the owner of the payment method. 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.

transactionAmount

javax.money.MonetaryAmount transactionAmount

The transaction amount that was executed against the PaymentSummary.

transactionId

String transactionId

The id of the executed transaction.

transactionReferenceId

String transactionReferenceId

The transaction id known by the payment gateway. This reference can be used to link the request to the gateway's record of the transaction in the case that the calling application does not receive a response from the gateway.

transactionStatus

String transactionStatus

The status of the transaction.

See Also:

TransactionStatus

Class com.broadleafcommerce.cartoperation.service.provider.external.domain.payment.TransactionExecutionRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

adjustmentsTotal

javax.money.MonetaryAmount adjustmentsTotal

The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.

allowAutomaticReversal

boolean allowAutomaticReversal

Whether to allow this transaction to be automatically reversed by payment system's scheduled jobs.
Set this field to false if this transaction should only be allowed to be reversed by Order Operation Service.

fulfillmentTotal

javax.money.MonetaryAmount fulfillmentTotal

The payment's total fulfillment cost.

parentTransactionId

String parentTransactionId

The id of the payment transaction that proceeded this transaction. Typically this is used when the execution of a transaction requires knowledge of the proceeding transaction, like the need to reference an DefaultTransactionTypes.AUTHORIZE transaction to execute a DefaultTransactionTypes.CAPTURE transaction.

paymentId

String paymentId

The id of the related PaymentSummary that is meant to be used for the transaction.

requestId

String requestId

The id representing the customer's request to execute one or more transactions.

securityCode

String securityCode

The payment method security code that may be required to execute the transaction. Typically, this value is required to execute transactions against multi-use payment methods to validate that the user is the owner of the payment method.

source

String source

A simple description of the system that initiated this transaction execution request.

sourceEntityId

String sourceEntityId

The ID of the source entity associated with the transaction.
For example, if TransactionExecutionRequest.getSourceEntityType() is CHECKOUT_REQUEST, this would be the ID of the checkout request.

See Also:

TransactionExecutionRequest.getSourceEntityType()

sourceEntityType

String sourceEntityType

The type of the source entity associated with the transaction. For example, "CHECKOUT_REQUEST".

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.

transactionAmount

javax.money.MonetaryAmount transactionAmount

The transaction amount that we're expecting to execute against the PaymentSummary. This amount must be valid according to what's available for the PaymentSummary. If specified, the amount details (TransactionExecutionRequest.subtotal, TransactionExecutionRequest.adjustmentsTotal, TransactionExecutionRequest.fulfillmentTotal, & TransactionExecutionRequest.taxTotal) should sum together to equal this amount.

transactionType

String transactionType

The type of transaction that is to be executed.

See Also:

TransactionType

Class com.broadleafcommerce.cartoperation.service.provider.external.domain.payment.TransactionExecutionResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

adjustmentsTotal

javax.money.MonetaryAmount adjustmentsTotal

The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.

expectedTotalAmount

javax.money.MonetaryAmount expectedTotalAmount

The total amount that we're expecting to be executed against the payment, spread across the TransactionExecutionResponse.transactionExecutionDetails. This amount must be valid according to what's available for the payment. If specified, the amount details (TransactionExecutionResponse.subtotal, TransactionExecutionResponse.adjustmentsTotal, TransactionExecutionResponse.fulfillmentTotal, & TransactionExecutionResponse.taxTotal) should sum together to equal this amount.

fulfillmentTotal

javax.money.MonetaryAmount fulfillmentTotal

The payment's total fulfillment cost

paymentSummary

PaymentSummary paymentSummary

The updated PaymentSummary representation.
This can be null if the payment is archived as a result of a failed transaction.

requestId

String requestId

The id representing the customer's request to execute one or more transactions.

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

transactionExecutionDetails

List<TransactionExecutionDetail> transactionExecutionDetails

A list of TransactionExecutionDetails describing the transactions executed.

transactionType

String transactionType

The type of transactions that were executed.

See Also:

TransactionType

Class com.broadleafcommerce.cartoperation.service.provider.external.domain.payment.UnlockPaymentRequest extends Object implements Serializable

Serialized Fields

lockTokens

Collection<String> lockTokens

List of tokens that can be used to release payment locks.

Class com.broadleafcommerce.cartoperation.service.provider.external.domain.payment.UpdatePaymentsResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

failedPayments

List<PaymentSummary> failedPayments

List of payments that failed during processing.

failureMessages

Map<String,String> failureMessages

Map of payment ids to failures messages detailing what failed during processing.

successfulPayments

List<PaymentSummary> successfulPayments

List of payments that were successfully processed.

Package com.broadleafcommerce.cartoperation.web.endpoint.domain

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.AddAttributeRequest extends CartModifyingRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

key

String key

The attribute's key.

value

Object value

The attribute's value.

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.AddCodeRequest extends CartModifyingRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

The code to add.

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.AddCodeToCartResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

adjustments

List<com.broadleafcommerce.order.common.domain.Adjustment> adjustments

The list of adjustments that were added to the cart because of the code's application.

cart

com.broadleafcommerce.cart.client.domain.Cart cart

The updated Cart, including the code and applicable adjustments (discounts).

code

String code

The added offer or campaign code.

message

String message

A message describing the results of adding the code to the cart.

responseCode

String responseCode

A simple code describing the results of the add code to cart request.

See Also:

DefaultAddCodeToCartResponseTypes

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.AddItemListToCartRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

itemListIds

Set<String> itemListIds

Set of ids representing the ItemLists that are to be added to cart

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.AddItemRequest extends CartModifyingRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

additionalAttributes

Map<String,Object> additionalAttributes

Miscellaneous attributes that can be set to this request in order to inform business logic for adding a CartItem.

cartAttributes

Map<String,Object> cartAttributes

Attributes that should be copied to the Cart.getAttributes() for this request.

currency

javax.money.CurrencyUnit currency

Deprecated.
in favor of using PriceCartRequest for creating or pricing a cart.

dependentCartItems

List<AddItemRequest> dependentCartItems

A list of additional AddItemRequests that should be processed as dependent items of the resulting parent item of this current AddItemRequest.

itemAttributeChoices

Map<String,String> itemAttributeChoices

Attribute choices that should be copied to CartItem.getAttributeChoices() for this request.

itemAttributes

Map<String,Object> itemAttributes

Miscellaneous attributes that should be copied to the CartItem.getAttributes() for this request.

itemChoiceKey

String itemChoiceKey

If this AddItemRequest is one within AddItemRequest.getDependentCartItems(), this is the key to use to relate to this CartItem to a configured product item choice.

itemInternalAttributes

Map<String,Object> itemInternalAttributes

Miscellaneous internal attributes that should be copied to the CartItem.getInternalAttributes() for this request.

locale

Locale locale

Deprecated.
in favor of using PriceCartRequest for creating or pricing a cart.

merchandisingContext

String merchandisingContext

The value that should be mapped to CartItem.getMerchandisingContext(). This holds the selector or merchandising product's id.

productId

String productId

The id of the product for this add item request. Used to retrieve product information for the cart item.

quantity

int quantity

The amount of this item to be added to the Cart.

sku

String sku

The SKU code for the item (e.g., Product or Variant).

variantId

String variantId

The id of the variant for this add item request. Used to retrieve variant information for the cart item.

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.CartItemModifyingRequest extends Object implements Serializable

Serialized Fields

cartVersion

Integer cartVersion

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.CartModifyingRequest extends Object implements Serializable

Serialized Fields

version

Integer version

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.CartRequest extends com.broadleafcommerce.cart.client.domain.Cart implements Serializable

Serialized Fields

requestId

String requestId

A unique id used to represent the request. This value can be used to link various persisted entities/values to the originating request.

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.ContactInfoRequest extends CartModifyingRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

emailAddress

String emailAddress

Email addresses that should be used as a point of contact for the cart.

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.GuestTokenResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

cart

com.broadleafcommerce.cart.client.domain.Cart cart

token

com.broadleafcommerce.cart.client.domain.GuestToken token

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.GuestTokenValidationResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

token

com.broadleafcommerce.cart.client.domain.GuestToken token

valid

boolean valid

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.ItemListAddToCartResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

cart

com.broadleafcommerce.cart.client.domain.Cart cart

The Cart related to the checkout submission.

failedItemAdditions

Map<String,List<String>> failedItemAdditions

Map of ItemList ids to a collection of ItemListItem ids that could not be added to cart

inaccessibleItemListIds

Set<String> inaccessibleItemListIds

From the list of ids that the user attempted to add to cart, this represents the set of ItemList ids that the user does not have access to

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.OverridePriceRequest extends CartItemModifyingRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

comment

String comment

The optional, long-form comment explaining any extra context for the override.

overridePrice

javax.money.MonetaryAmount overridePrice

The new price value.

reason

String reason

The reason the override was performed, for example, "Price Match".

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.PriceCartRequest extends CartModifyingRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

currency

javax.money.CurrencyUnit currency

The currency to price the cart against.

locale

Locale locale

The locale to price the cart against.

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.ShareItemListRequest extends Object implements Serializable

Serialized Fields

listId

String listId

The ID of the item list being shared. This will be populated from the request path.

role

String role

The role that the targets this item list is being shared with will be granted. See ItemListAccessRule.getRole() for how this is used. See DefaultItemListAccessRuleRole for the default supported values.

targets

Set<ShareItemListRequest.Target> targets

Describes who this list is being shared with.

valueType

String valueType

The type of values that this list will be shared with (e.g email address, customer ID, etc.). This corresponds to ShareItemListRequest.Target.value. See ItemListAccessRule.getType() for how this is used. See DefaultItemListAccessRuleType for the default supported values.

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.ShareItemListRequest.Target extends Object implements Serializable

Serialized Fields

attributes

Map<String,Object> attributes

Any additional attributes that identify this target/share request. Might be used for something like the target's name if they were to be included in an email.

value

String value

The value that identifies who this list is to be shared with. This should be of the value type ShareItemListRequest.valueType. An example may be an email address or a customer ID.

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.UpdateFulfillmentGroupRequest extends CartModifyingRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

address

com.broadleafcommerce.order.common.domain.Address address

The shipping address for this fulfillment group.

fulfillmentOption

com.broadleafcommerce.order.common.domain.FulfillmentOption fulfillmentOption

The fulfillment option chosen for the UpdateFulfillmentGroupRequest.getType().

type

String type

The type of means by which this fulfillment group is fulfilled. This could be SHIP, PICKUP, or VIRTUAL, for example.

See Also:

FulfillmentType

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.UpdateItemRequest extends CartItemModifyingRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

cartAttributes

Map<String,Object> cartAttributes

Attributes that should be copied to the Cart.getAttributes() for this request.

cartItemId

String cartItemId

ID of the CartItem to update.

dependentItemUpdates

List<UpdateItemRequest> dependentItemUpdates

A list of additional AddItemRequests that should be processed as children items of the resulting parent item of this current UpdateItemRequest.

itemAttributeChoices

Map<String,String> itemAttributeChoices

Attribute choices that should be copied to CartItem.getAttributeChoices() for this request.

itemAttributes

Map<String,Object> itemAttributes

Attributes that should be copied to the CartItem.getAttributes() for this request.

parentCartItemId

String parentCartItemId

The id of the parent CartItem for this add item request. This would create a child CartItem of the parent.

quantity

int quantity

The amount of this item to be added to the Cart.

variantId

String variantId

The id of the variant for this add item request. Used to retrieve variant information for the cart item.

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.UpdatePaymentRequest extends Object implements Serializable

Serialized Fields

accessRestrictions

List<String> accessRestrictions

The list of restrictions that apply to payment access.

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 the payment is allotted.

attributes

Map<String,String> attributes

Map to capture any additional information about the payment

billingAddress

com.broadleafcommerce.order.common.domain.Address billingAddress

The billing address associated with this payment.

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

markTransactionsIneligibleForAutomaticReversal

boolean markTransactionsIneligibleForAutomaticReversal

Declares whether the payment's transactions should be marked ineligible for automatic reversal.

name

String name

The name of this payment. This name is typically something like "Visa ending in 1234".

paymentId

String paymentId

The ID of the payment to update. Will be pre-populated in Cart Operations from the request.

shouldSavePaymentForFutureUse

boolean shouldSavePaymentForFutureUse

Should the payment method be saved to the owning user.

shouldSavePaymentToCustomer

Boolean shouldSavePaymentToCustomer

Deprecated, for removal: This API element is subject to removal in a future version.
since 1.7.2, in favor of UpdatePaymentRequest.shouldSavePaymentForFutureUse to support owning user types other than a customer (i.e. account).

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

Package com.broadleafcommerce.cartoperation.web.endpoint.domain.checkout

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.checkout.CheckoutResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

cart

com.broadleafcommerce.cart.client.domain.Cart cart

The Cart related to the checkout submission.

failureMessage

String failureMessage

Message intended to inform why the checkout submission failed if CheckoutResponse.isSuccess() is false.

failureType

String failureType

The type of checkout failure which can be used programmatically by the client application to react to the failure. Note: This should only be populated if CheckoutResponse.isSuccess() is false.

See Also:

CheckoutFailureType

itemFailureMessages

Map<String,String> itemFailureMessages

Line item error messages used to describe issues with individual fields, cart items, etc. For example, this may consist of map entries where the key is a cart item id (or name) & the value is an explanation of why the item is misconfigured.

paymentSummaries

List<PaymentSummary> paymentSummaries

A collection of PaymentSummaries related to the Cart.

paymentTransactionFailureDetails

List<PaymentTransactionFailureDetail> paymentTransactionFailureDetails

A collection of PaymentTransactionFailureDetails describing how the transaction(s) failed.

requestId

String requestId

The id representing the customer's request to checkout

success

boolean success

Whether or not the checkout submission was successful.

Class com.broadleafcommerce.cartoperation.web.endpoint.domain.checkout.PaymentTransactionFailureDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,String> attributes

Map of specific attributes that have been gathered from the raw response. This should be used for data points that are to be used programmatically. For example, a gateway-specific transaction id that can be used to capture or refund the transaction. Note: It's very important that this does not include sensitive payment method data. Doing so will expand the PCI scope to include CartOperationServices and its related services.

dateRecorded

Instant dateRecorded

The timestamp when this transaction response was recorded

declineType

String declineType

The type of transaction failure (hard vs soft failure)

See Also:

PaymentDeclineType

failureType

String failureType

The type of transaction failure

See Also:

DefaultTransactionFailureTypes

gatewayResponseCode

String gatewayResponseCode

The response code provided by the payment gateway which may represent a success or failure

indeterminateResult

boolean indeterminateResult

Tells if this transaction has an indeterminate result.
Having an indeterminate result means that the true outcome of the transaction is not known. For example, if a transaction is sent to the payment processor but a network error occurred, it is not known to us whether the user was actually charged or not (thus, the result is indeterminate).
Transactions should be marked as indeterminate when sending to the payment processor, and then unmarked once a response is received, understood, and recorded. This means that a transaction in an indeterminate result state is expected during the sending to processor phase. However, if the transaction remains in that state for an excessive amount of time, something likely went wrong and the transaction will need to be reconciled. If the transaction changes from the sending to processor status but remains indeterminate, the transaction will also require reconciliation in that scenario.
Some situations which may lead to an indeterminate result:

A transaction is sent to the processor, but a network error prevents us from receiving the response

A transaction is sent to the processor, but the processor returns an unexpected error (e.g. 500 internal server error)

A transaction is sent to the processor and a response is received, but cannot be recorded because Cart Services is down

A transaction is sent to the processor and a response is received, but cannot be recorded because the database is down

message

String message

Message describing the result of the transaction

paymentId

String paymentId

The id of the payment.

requestId

String requestId

The id representing the customer's request to execute the transaction.

threeDSecureVerificationUrl

String threeDSecureVerificationUrl

The gateway-provided url where the customer must verify that they are in fact the owner of the payment method. 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.

transactionAmount

javax.money.MonetaryAmount transactionAmount

The transaction amount that was executed against the PaymentSummary.

transactionId

String transactionId

The id of the executed transaction.

transactionReferenceId

String transactionReferenceId

The transaction id known by the payment gateway. This reference can be used to link the request to the gateway's record of the transaction in the case that the calling application does not receive a response from the gateway.

transactionStatus

String transactionStatus

The status of the transaction.

See Also:

TransactionStatus

transactionType

String transactionType

The type of transactions that were executed.

See Also:

TransactionType

Package com.broadleafcommerce.cartoperation.web.endpoint.exception

Class com.broadleafcommerce.cartoperation.web.endpoint.exception.BulkAddToCartLimitExceededException extends RuntimeException implements Serializable

Class com.broadleafcommerce.cartoperation.web.endpoint.exception.CartNotFoundException extends RuntimeException implements Serializable

Class com.broadleafcommerce.cartoperation.web.endpoint.exception.GuestCartOnlyException extends RuntimeException implements Serializable

Class com.broadleafcommerce.cartoperation.web.endpoint.exception.GuestTokenDisabledException extends RuntimeException implements Serializable

Package com.broadleafcommerce.cartoperation.web.validator.exception

Class com.broadleafcommerce.cartoperation.web.validator.exception.GuestTokenRequiredException extends RuntimeException implements Serializable

Serialized Form

Package com.broadleafcommerce.cartoperation.domain

Class com.broadleafcommerce.cartoperation.domain.AdvancedTag extends Object implements Serializable

Serialized Fields

attributes

id

name

position

priority

type

Class com.broadleafcommerce.cartoperation.domain.Attribute extends Object implements Serializable

Serialized Fields

attributes

value

Class com.broadleafcommerce.cartoperation.domain.AttributeChoice extends Object implements Serializable

Serialized Fields

allowedValues

attributeName

attributes

errorCode

errorMessage

required

validationRule

validationStrategy

validationType

Class com.broadleafcommerce.cartoperation.domain.AttributeChoiceValue extends Object implements Serializable

Serialized Fields

attributes

label

value

Class com.broadleafcommerce.cartoperation.domain.CartCreationRequest extends Object implements Serializable

Serialized Fields

addItemRequest

priceCartRequest

Class com.broadleafcommerce.cartoperation.domain.CartHolder extends Object implements Serializable

Serialized Fields

cart

Class com.broadleafcommerce.cartoperation.domain.Category extends Object implements Serializable

Serialized Fields

attributes

id

name

url

Class com.broadleafcommerce.cartoperation.domain.DataDrivenEnum extends Object implements Serializable

Serialized Fields

attributes

displayValue

id

type

value

Class com.broadleafcommerce.cartoperation.domain.FulfillmentFlatRate extends Object implements Serializable

Serialized Fields

value

Class com.broadleafcommerce.cartoperation.domain.IncludedProduct extends Object implements Serializable

Serialized Fields

additionalItemPricing

attributes

discountAllowed

displayOrder

label

product

quantity

type

variant

variantParentProductId

Class com.broadleafcommerce.cartoperation.domain.InventoryUnavailableException extends RuntimeException implements Serializable

Serialized Fields

itemFailureMessages

Class com.broadleafcommerce.cartoperation.domain.ItemChoice extends Object implements Serializable

Serialized Fields

additionalItemPricing

attributes

category

choiceKey

discountAllowed

maximumQuantity

minimumQuantity

selectionType

specificChoices

specificItemChoice