Serialized Form

Package com.broadleafcommerce.cartoperation.domain

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

serialVersionUID:

1L

Serialized Fields

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>.

attributes

Map<K,V> attributes

Map holding any additional attributes passed in the request not matching any defined properties.

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

serialVersionUID:

1L

Serialized Fields

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().

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.

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.

validationType

String validationType

How the validation from AttributeChoice.getValidationStrategy() should be performed. Only relevant if AttributeChoice.getValidationStrategy() is non-null

See Also:

ValidationType

validationRule

String validationRule

If AttributeChoice.validationType is regex, this is the expression that should execute against the user's value.

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.

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()

allowedValues

List<E> 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.

attributes

Map<K,V> attributes

Map holding any additional attributes passed in the request not matching any defined properties.

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

serialVersionUID:

1L

Serialized Fields

label

String label

What the customer sees for display. For example, text in the case of sizes or a hex value in the case of colors. Can diverge from AttributeChoiceValue.value which is what is added to the cart

value

String value

The value stored as an item attribute or cart attribute based on what the user selects.

attributes

Map<K,V> attributes

Map holding any additional attributes passed in the request not matching any defined properties.

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

serialVersionUID:

1L

Serialized Fields

addItemRequest

AddItemRequest addItemRequest

The initial AddItemRequest to populate the cart.

priceCartRequest

PriceCartRequest priceCartRequest

The initial PriceCartRequest to price the cart.

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

Serialized Fields

cart

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

Deprecated.

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

serialVersionUID:

1L

Serialized Fields

id

String id

The primary id of the category.

name

String name

The name of the category.

url

String url

The url of the category.

attributes

Map<K,V> attributes

Map holding any additional attributes passed in the request not matching any defined properties.

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

serialVersionUID:

1L

Serialized Fields

id

String id

The ID of the enum.

type

String type

Identifies the type of the associated value, this is needed to gather all the enum values based on their types.

For example, if this enum type was to be used for a field representing product's materials, then the type would be "MATERIAL".

value

String value

The value of the associated DataDrivenEnum.type.

For example, the value for type "MATERIAL" could be "COTTON", "LEATHER", "POLYESTER", etc.

displayValue

String displayValue

The display value for the associated DataDrivenEnum.type.

Different from DataDrivenEnum.value, the display value is meant to be more user-friendly and for client-facing usages, such as searching and faceting.

For example, the display value for type "MATERIAL" could be "Cotton", "Leather", "Polyester", etc.

attributes

Map<K,V> attributes

Map holding any additional attributes passed in the request not matching any defined properties.

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

serialVersionUID:

1L

Serialized Fields

value

javax.money.MonetaryAmount value

The value of this flat rate

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

serialVersionUID:

1L

Serialized Fields

type

String type

Describes which of the product or variant fields should be used for this included product.

See Also:

IncludedProductType

label

String label

The user-facing label that describes this included product.

displayOrder

Long displayOrder

Defines the display position of this included product in relation to other included products.

product

Product product

This field contains the specified product if the type is IncludedProductType.PRODUCT.

variant

Variant variant

This field contains the specified variant if the type is IncludedProductType.VARIANT.

See Also:

IncludedProduct.variantParentProductId

variantParentProductId

String variantParentProductId

This field contains the id of the parent product of the specified IncludedProduct.variant if the type is IncludedProductType.VARIANT.

This field is necessary because variants are a sub-resource of product and thus API callers cannot fetch them purely by variant id alone.

See Also:

IncludedProduct.variant

additionalItemPricing

com.broadleafcommerce.cart.client.domain.AdditionalItemPricing additionalItemPricing

discountAllowed

boolean discountAllowed

Dictates whether or not discounts are allowed to be applied to this included product.

quantity

int quantity

The value of the fixed quantity.

attributes

Map<K,V> attributes

Map holding any additional attributes passed in the request not matching any defined properties.

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

Serialized Fields

itemFailureMessages

Map<K,V> itemFailureMessages

Line item error messages to indicate which cart items were unavailable. These are typically identified by CartItem ids.

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

serialVersionUID:

1L

Serialized Fields

choiceKey

String choiceKey

The key to use to relate to this ItemChoice when configuring cart items.

targetType

String targetType

Identifies the type of items that a customer can choose from, whether specific products, specific variants, or products from a specific category.

See Also:

ItemChoiceTargetType

selectionType

String selectionType

Describes restrictions placed on the customer's ability to select items from the targeted set. Generally, this is a restriction on how many choices can be selected for a single add-to-cart request and, potentially, how quantity is distributed among multiple selected choices.

See Also:

ItemChoiceSelectionType

maximumQuantity

Integer maximumQuantity

The maximum amount of this item that a customer can purchase at a time. If null, this would allow a customer to specify their own quantity for how many of these items they can add to the cart.

minimumQuantity

Integer minimumQuantity

The minimum amount of the item that a customer must purchase. The minimum and maximum should never be the same as this domain would be better represented as an IncludedProduct.

discountAllowed

boolean discountAllowed

Dictates whether or not discounts are allowed to be applied to this add-on.

additionalItemPricing

com.broadleafcommerce.cart.client.domain.AdditionalItemPricing additionalItemPricing

category

Category category

The Category which the add-on will be chosen from by the customer if the selection is ItemChoiceTargetType.CATEGORY.

specificChoices

List<E> specificChoices

If the ItemChoice.selectionType is ItemChoiceTargetType.SPECIFIC_PRODUCTS or ItemChoiceTargetType.SPECIFIC_VARIANTS this holds the manually-curated options that the customer can choose from. This also allows for specific override pricing on an item-by-item basis

specificItemChoice

SpecificItemChoice specificItemChoice

attributes

Map<K,V> attributes

Map holding any additional attributes passed in the request not matching any defined properties.

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

serialVersionUID:

1L

Serialized Fields

offerId

String offerId

The associated offer's id.

campaignCode

String campaignCode

The campaign code string that this audit information is for.

campaignTrackingId

String campaignTrackingId

The tracking ID of the campaign this audit is for.

user

UserTarget user

The identifying info of the user that used the related offer.

orderId

String orderId

The id of the cart upon which the related offer was used.

sharedCode

String sharedCode

The string of the offer code used to apply the related offer.

dateApplied

Instant dateApplied

The date and time when the related offer was applied.

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

serialVersionUID:

1L

Serialized Fields

id

String id

The ID of the Product.

name

String name

The name of the product.

uri

String uri

The navigable uri of this product.

sku

String sku

This uniquely identifies this product in the catalog when it is sold and is used for other contexts like inventory and pricing.

discountable

boolean discountable

Whether or not this product be applied to any offers or promotions.

Defaults to true

priceInfo

com.broadleafcommerce.pricing.client.domain.PriceInfo priceInfo

Summary of the pricing information related to the product.

pricingKey

String pricingKey

System-wide unique identifier to configure specific pricing for the product. Relevant if pricing data is managed in a separate system or data store, like the Broadleaf pricing services.

mergingType

String mergingType

Determines how this Product should merge with other similar items when it gets added to a cart. This will override the global setting on item merging. Out of box supported values are those in DefaultMergingType.

fulfillmentFlatRates

Map<K,V> fulfillmentFlatRates

A map of flat rates for fulfilling (e.g., shipping) this product for a particular fulfillment option type (e.g., standard shipping). Depending on if the option is configured to use flat rates, this flat rate will be used in calculating the cost of fulfilling this product.

The key of the map is the type of the fulfillment option such as FIXED_STANDARD or BANDED_PRICE_EXPRESS.

See Also:

FulfillmentFlatRate

includedProducts

List<E> includedProducts

Additional products that are always included with the product, no matter what. Used to configure "bundles" or "kits".

If some of these items should be optional or the user should decide which additional items are added to their cart, use Product.options instead.

See Also:

IncludedProduct

primaryAsset

com.broadleafcommerce.cart.client.domain.ImageAssetRef primaryAsset

The asset associated with this product marked as primary.

assets

List<E> assets

All ProductAssets for this product.

attributes

Map<K,V> attributes

Dynamic attributes that are a part of the product.

options

List<E> options

Drives additional information that the customer should enter when purchasing this product. this can be in the form of additional variations, additional items that can be bundled with this product or simply more information that the customer needs to enter about what they are purchasing (like a personalized message).

inventoryType

String inventoryType

Describes the product's type of fulfillment - ie is it a physical or virtual item?

availableOnline

boolean availableOnline

Whether or not this product is available online - ie inventory is available somewhere to fulfill this product.

inventoryCheckStrategy

String inventoryCheckStrategy

Describes when the product's inventory should be checked for availability.

inventoryReservationStrategy

String inventoryReservationStrategy

Describes when the product's inventory should be reserved.

tags

List<E> tags

A list of simple labels used to categorize the product

parentCategories

Set<E> parentCategories

All Categories that include the product.

variants

List<E> variants

All Variants for this product.

weight

Weight weight

individuallySold

boolean individuallySold

If this product or any of its variants can be sold individually in the store, or if they must be apart of another product as an add-on.

This defaults to true.

currencyContext

com.broadleafcommerce.money.CurrencyContext currencyContext

Transient ability to have a currency initialized

vendorRef

String vendorRef

Soft reference to the vendor associated with this catalog. This value can be null, in which case, no vendor is associated.

productType

String productType

Defines the type of the product. This value is added to the internalAttributes under the CartItemAttributeConstants.Internal.PRODUCT_TYPE key and used to determine the product type for the CartItem. The default types are defined by DefaultProductType.

See Also:

DefaultProductType

brand

DataDrivenEnum brand

merchandisingType

DataDrivenEnum merchandisingType

targetDemographic

DataDrivenEnum targetDemographic

additionalAttributes

Map<K,V> additionalAttributes

Map holding any additional attributes passed in the request not matching any defined properties.

minimumThreshold

Integer minimumThreshold

The minimum count of this product that must be added in a cart.

maximumThreshold

Integer maximumThreshold

The maximum count of this product that must be added in a cart.

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

serialVersionUID:

1L

Serialized Fields

products

List<E> products

All Products and their details.

productIdsForMissingEntities

Set<E> productIdsForMissingEntities

The list of provided ids for which a Product could not be found

productUrisForMissingEntities

Set<E> productUrisForMissingEntities

The list of provided uris for which a Product could not be found

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

serialVersionUID:

1L

Serialized Fields

type

String type

Controls both how the customer should be inputting values to fill out this option as well as storage of where the value will go once added to the cart.

See Also:

ProductOptionType

label

String label

The label shown to customers when displaying this option. This helps communicate to customers how they should fill out the input

itemChoice

ItemChoice itemChoice

Configuration for the ProductOptionType.ITEM_CHOICE. Drives customer selection of an additional item to add to their cart

attributeChoice

AttributeChoice attributeChoice

Configuration when the ProductOption.type of this option is one of:

1. ProductOptionType.VARIANT_DISTINGUISHING - drives customer further specifying their choices into a specific Variant that contains a unique SKU code, pricing concerns, etc.
2. ProductOptionType.CART_ITEM_ATTRIBUTE - Customer input will flow directly in the item attributes within their cart
3. ProductOptionType.CART_ATTRIBUTE. Customer input will flow directly in the global cart attribute. Any previously-set attribute should be replaced with new values.

attributes

Map<K,V> attributes

Map holding any additional attributes passed in the request not matching any defined properties.

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

serialVersionUID:

1L

Serialized Fields

content

List<E> content

attributes

Map<K,V> attributes

Map holding any additional attributes passed in the request not matching any defined properties.

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

serialVersionUID:

1L

Serialized Fields

skuCode

String skuCode

The value of the SKU reference. This will be one of SKU contextId, SKU external ID, arbitrary SKU code, UPC, EAN, or GTIN.

quantityRequested

Integer quantityRequested

Quantity delta that is being requested (i.e. the number to check). These must always be positive numbers.

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

serialVersionUID:

1L

Serialized Fields

available

boolean available

Indicates if the requested quantity is available.

inventoryLocationId

String inventoryLocationId

The Inventory Location for which this availability is indicated.

skuRef

InventorySkuRef skuRef

Holder of pointer(s) that reference the SKU. The default is skuCode.

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

serialVersionUID:

1L

Serialized Fields

reservationRequestType

String reservationRequestType

Indicates if the Inventory Reservation Request is a HARD or SOFT request. Soft requests are temporary and may be reversed if a HARD reservation is not eventually created. SOFT requests typically happen prior to payment or finalizing checkout. HARD requests are typically done after payment or finalizing checkout.

skuReferenceFieldType

String skuReferenceFieldType

Indicates how we should be looking up SKU Inventory (by which field) with respect to skuReferenceValue. Default allowed values are:

SKU_CONTEXT_ID

SKU_EXTERNAL_ID

SKU_CODE

UPC

EAN

GTIN

reservationRequestGroups

List<E> reservationRequestGroups

Logically separate groups into pickup or ship groups, along with items to be adjusted. Each SkuInventoryReservationRequestGroup is loosely correlated with a Fulfillment Group in the Cart domain.

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

serialVersionUID:

1L

Serialized Fields

token

String token

The token string that is used to authorize that a request has access to transfer the given cart.

expirationTime

Instant expirationTime

The expiration time of the transfer cart token in UTC. This is used to inform clients of when to expect the token to be expired.

author

String author

The username of the author associated with the transfer cart token.

cartId

String cartId

The ID of the cart the token is authorized to transfer.

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

serialVersionUID:

1L

Serialized Fields

targetValue

String targetValue

An identifying value for the user. Could be an email, username, or some similarly identifying value.

targetType

String targetType

The type of the user.

See Also:

UserTargetType

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

serialVersionUID:

1L

Serialized Fields

id

String id

The unique identifier for this variant.

sku

String sku

Sku code for this particular variant. Overrides the main Product Sku that is set, if any.

name

String name

The name of this particular variant of the product. Generally serves as an overridable field from a product. During option selection when narrowing the specific Sku to order

priceInfo

com.broadleafcommerce.pricing.client.domain.PriceInfo priceInfo

Summary of the pricing information related to the choice.

optionValues

Map<K,V> optionValues

Helper to make this particular variant uniquely identifiable across multiple variants for the same product. Keys correspond to AttributeChoice.getAttributeName() while values correspond to one of the corresponding AttributeChoice.getAttributeName().

inventoryCheckStrategy

String inventoryCheckStrategy

Describes when the variant's inventory should be checked for availability. If not set, defaults to Product.inventoryCheckStrategy.

inventoryReservationStrategy

String inventoryReservationStrategy

Describes when the variant's inventory should be reserved. If not set, defaults to Product.inventoryReservationStrategy.

minimumThreshold

Integer minimumThreshold

The minimum count of this variant that must be added in a cart.

maximumThreshold

Integer maximumThreshold

The maximum count of this variant can be added in a cart.

fulfillmentFlatRates

Map<K,V> fulfillmentFlatRates

A map of flat rates for fulfilling (e.g., shipping) this product for a particular fulfillment option type (e.g., standard shipping). Depending on if the option is configured to use flat rates, this flat rate will be used in calculating the cost of fulfilling this product.

The key of the map is the type of the fulfillment option such as FIXED_STANDARD or BANDED_PRICE_EXPRESS.

See Also:

FulfillmentFlatRate

weight

Weight weight

attributes

Map<K,V> attributes

Dynamic attributes that are a part of the variant.

currencyContext

com.broadleafcommerce.money.CurrencyContext currencyContext

Transient ability to have a currency initialized

additionalAttributes

Map<K,V> additionalAttributes

Map holding any additional attributes passed in the request not matching any defined properties.

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

serialVersionUID:

1L

Serialized Fields

weight

BigDecimal weight

units

String units

See Also:

WeightUnits

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 RuntimeException implements Serializable

Serialized Fields

cart

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

The cart whose checkout is being finalized.

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 RuntimeException implements Serializable

Serialized Fields

cart

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

The cart whose checkout is being finalized.

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

Serialized Fields

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<K,V> 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.

payment3DSVerificationUrls

Map<K,V> payment3DSVerificationUrls

Payment 3DS Verification URLs used to determine payments which require 3DS verification during the checkout workflow. For example, this would consist of map entries where the key is the payment id & the value is the redirect URL for 3DS verification of the payment.

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

Serialized Fields

cart

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

The cart whose checkout is being processed in the workflow.

failureType

String failureType

The category of workflow failure that caused this exception.

See Also:

CheckoutFailureType

itemFailureMessages

Map<K,V> 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.

payment3DSVerificationUrls

Map<K,V> payment3DSVerificationUrls

Payment 3DS Verification URLs used to determine payments which require 3DS verification during the checkout workflow. For example, this would consist of map entries where the key is the payment id & the value is the redirect URL for 3DS verification of the payment.

Class com.broadleafcommerce.cartoperation.exception.CheckoutWorkflowRollbackException 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.PaymentTransactionFailureException extends RuntimeException implements Serializable

serialVersionUID:

1L

Serialized Fields

cart

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

The cart whose payment is being processed.

payment3DSVerificationUrls

Map<K,V> payment3DSVerificationUrls

The 3DS verification URL if the transaction requires a 3DS check

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

Serialized Fields

transactionReferenceId

String transactionReferenceId

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.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

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

contextInfo

com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo

The ContextInfo derived from the original request containing tenant and sandbox info.

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

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

contextInfo

com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo

The ContextInfo derived from the original request containing tenant and sandbox info.

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.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

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.

responseCode

String responseCode

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

See Also:

DefaultAddCodeToCartResponseTypes

message

String message

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

adjustments

List<E> adjustments

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

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

serialVersionUID:

1L

Serialized Fields

itemListIds

Set<E> 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

variantId

String variantId

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

productId

String productId

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

sku

String sku

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

quantity

int quantity

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

currency

javax.money.CurrencyUnit currency

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

locale

Locale locale

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

itemAttributes

Map<K,V> itemAttributes

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

itemInternalAttributes

Map<K,V> itemInternalAttributes

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

itemAttributeChoices

Map<K,V> itemAttributeChoices

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

cartAttributes

Map<K,V> cartAttributes

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

dependentCartItems

List<E> dependentCartItems

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

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.

merchandisingContext

String merchandisingContext

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

additionalAttributes

Map<K,V> additionalAttributes

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

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

Serialized Fields

name

String name

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

customerPaymentAccountId

String customerPaymentAccountId

The id of the customer's saved payment account that was used to build this payment object. Note: This property is only relevant if the user desires to use a saved payment account to pay for their order. Otherwise, this value should remain unset.

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.

shouldSavePaymentToCustomer

boolean shouldSavePaymentToCustomer

Should the payment method be saved to the customer

type

String type

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

See Also:

DefaultPaymentTypes

gatewayType

String gatewayType

The gateway used to process this payment. Only a SINGLE payment gateway can modify transactions on a particular payment.

See Also:

PaymentGatewayType

amount

javax.money.MonetaryAmount amount

The amount for which the payment is allotted.

subtotal

javax.money.MonetaryAmount subtotal

The payment's total usually excluding adjustments, tax, and shipping.

adjustmentsTotal

javax.money.MonetaryAmount adjustmentsTotal

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

fulfillmentTotal

javax.money.MonetaryAmount fulfillmentTotal

The payment's total fulfillment cost

taxTotal

javax.money.MonetaryAmount taxTotal

The payment's total tax cost

billingAddress

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

The billing address associated with this payment.

paymentGatewayProperties

Map<K,V> paymentGatewayProperties

Map to capture any gateway-specific information needed to perform gateway transactions

displayAttributes

Map<K,V> displayAttributes

General use map to capture any display properties for this Payment

attributes

Map<K,V> attributes

Map to capture any additional information about the payment

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.CheckoutResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

cart

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

The Cart related to the checkout submission.

success

boolean success

Whether or not the checkout submission was successful.

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

failureMessage

String failureMessage

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

itemFailureMessages

Map<K,V> 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.

payment3DSVerificationUrls

Map<K,V> payment3DSVerificationUrls

Payment 3DS Verification URLs used to determine payments which require 3DS verification during the checkout workflow. For example, this would consist of map entries where the key is the payment id & the value is the redirect URL for 3DS verification of the payment.

requestId

String requestId

The id representing the customer's request to checkout

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

valid

boolean valid

token

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

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.

inaccessibleItemListIds

Set<E> 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

failedItemAdditions

Map<K,V> failedItemAdditions

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

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

serialVersionUID:

1L

Serialized Fields

overridePrice

javax.money.MonetaryAmount overridePrice

The new price value.

reason

String reason

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

comment

String comment

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

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

serialVersionUID:

1L

Serialized Fields

locale

Locale locale

The locale to price the cart against.

currency

javax.money.CurrencyUnit currency

The currency 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.

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.

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<E> targets

Describes who this list is being shared with.

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

Serialized Fields

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.

attributes

Map<K,V> 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.

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

serialVersionUID:

1L

Serialized Fields

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

fulfillmentOption

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

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

address

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

The shipping address for this fulfillment group.

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

serialVersionUID:

1L

Serialized Fields

cartItemId

String cartItemId

ID of the CartItem to update.

variantId

String variantId

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

quantity

int quantity

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

itemAttributes

Map<K,V> itemAttributes

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

itemAttributeChoices

Map<K,V> itemAttributeChoices

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

cartAttributes

Map<K,V> cartAttributes

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

dependentItemUpdates

List<E> dependentItemUpdates

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

parentCartItemId

String parentCartItemId

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

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

Serialized Fields

paymentId

String paymentId

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

name

String name

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

shouldSavePaymentToCustomer

boolean shouldSavePaymentToCustomer

Should the payment method be saved to the customer

amount

javax.money.MonetaryAmount amount

The amount for which the payment is allotted.

subtotal

javax.money.MonetaryAmount subtotal

The payment's total usually excluding adjustments, tax, and shipping.

adjustmentsTotal

javax.money.MonetaryAmount adjustmentsTotal

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

fulfillmentTotal

javax.money.MonetaryAmount fulfillmentTotal

The payment's total fulfillment cost

taxTotal

javax.money.MonetaryAmount taxTotal

The payment's total tax cost

billingAddress

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

The billing address associated with this payment.

attributes

Map<K,V> attributes

Map to capture any additional information about the payment

displayAttributes

Map<K,V> displayAttributes

General use map to capture any display properties for this Payment

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