Serialized Form

  • Package com.broadleafcommerce.cart.client.domain

    • Class com.broadleafcommerce.cart.client.domain.AdditionalItemPricing

      class AdditionalItemPricing extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • overridePrice
          javax.money.MonetaryAmount overridePrice

          The price of this choice, only relevant when the pricing model of this choice is ADD_TO_PARENT. If no pricing is specified here, the price of the target product, variant, or selected product from the target category will be used.

          If this is a SPECIFIC_PRODUCTS or SPECIFIC_VARIANTS typed item choice, then any price set here will override any item pricing set in the specific choice.

        • pricingKey
          String pricingKey
          System-wide unique identifier to configure specific pricing for the choice. Relevant if pricing data is managed in a separate system or data store, like the Broadleaf pricing services. Only relevant if the pricing model is ADD_TO_PARENT.
        • pricingTargetType
          String pricingTargetType
          The type of the item to which this pricing belongs, for example SKU or PRICING_KEY.

    • Class com.broadleafcommerce.cart.client.domain.Cart

      class Cart extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • adjustments
          List<com.broadleafcommerce.order.common.domain.Adjustment> adjustments
          Adjustments to order pricing that should be applied to CartPricing.getSubtotal().
        • approvalRequestedDate
          Instant approvalRequestedDate
          The time this cart was submitted for approval.

          This field is only needed for B2B carts to represent the cart approval process. For B2C carts, we don't expect a value to be provided for this field.

        • approverEmail
          String approverEmail
          The cart approver's email address.

          This field is only needed for B2B carts to represent the cart approver's email address. For B2C carts, we don't expect a value to be provided for this field.

        • assignedSalesRepEmail
          String assignedSalesRepEmail
          The email of the assigned sales rep.

          This is field is only used for quotes for the sales rep review process.

        • assignedSalesRepId
          String assignedSalesRepId
          The id of the assigned sales rep.

          This is field is only used for quotes for the sales rep review process.

        • attributeChoices
          Map<String,com.broadleafcommerce.order.common.domain.AttributeChoiceValue> attributeChoices
          Attribute choices for this cart driven by its items' product options, where each key is the attributeName from an attribute choice.
        • attributes
          Map<String,Object> attributes
          Miscellaneous attributes for this cart.
        • campaignRefs
          List<com.broadleafcommerce.order.common.domain.CampaignRef> campaignRefs
          A list of campaign references that are attached to this cart. Similar to Cart.getOfferCodes(), the CampaignRef.getCampaignTrackingId() can be used to apply Adjustments to different aspects of the order. The difference is that these items need to be validated against a valid "Campaign" before being added to this list.
        • cartAlerts
          List<CartAlert> cartAlerts
          The list of the alerts for this Cart. NOTE: This is a transient property that is not persisted in the database.
        • cartItems
          List<CartItem> cartItems
          Items that are contained within this cart. Typically represents a good or service that the customer is purchasing.
        • cartPricing
          CartPricing cartPricing
          Embedded container for all pricing information on this cart.
        • checkoutSubmissions
          Map<String,Instant> checkoutSubmissions
          The checkout submissions made for this cart where each key is the request ID of a checkout and the value is an Instant timestamp of when the checkout was made.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • createDate
          Instant createDate
          The date that this cart was first created.
        • customerRef
          com.broadleafcommerce.order.common.domain.CustomerRef customerRef
          A reference to the customer that owns this cart.
        • emailAddress
          String emailAddress
          The customer's email address.
        • expirationDate
          Instant expirationDate
          The expiration date of the cart. This is typically only used for DefaultCartTypes.QUOTE-typed carts.
        • fulfillmentGroups
          List<FulfillmentGroup> fulfillmentGroups
          A list of fulfillment information for this cart. A cart can have many fulfillment groups associated with it in order to support multi-address and multi-type shipping.
        • id
          String id
          The context ID of the cart.
        • internalAttributes
          Map<String,Object> internalAttributes
          Miscellaneous internal attributes for this item. Distinguished from Cart.getAttributes() in that this map is used for attributes that assist in the internal working of Broadleaf MicroServices. For example, attributes to help with processing the cart's checkout.
        • isPriced
          boolean isPriced
          Flag to indicate whether this cart has been fully priced. This means totalling of items, adjustments, shipping and tax.
        • isTaxEstimated
          boolean isTaxEstimated
          Flag to indicate whether the taxes on the cart are estimates.
        • lastCatalogReprice
          Instant lastCatalogReprice
          The last time the cart was fully repriced with the most updated catalog pricing.
        • lastUpdatedAudit
          CartActionAudit lastUpdatedAudit
          The id of this cart's most recent audit.
        • locale
          Locale locale
          The locale for this cart. Used to determine what locale this cart was in for translations and other location-based functionality.
        • name
          String name
          A unique name for the cart, used for retrieval. This field is not displayed anywhere.
        • offerCodes
          List<String> offerCodes
          A list of offer codes that a user has added to their cart. Can be used to apply Adjustments to different aspects of the order.
        • orderNumber
          String orderNumber
          The unique number associated with this Cart. Typically, this is generated and set on cart submission. Used for record keeping and communicating with the customer instead of just using Cart.getId() since that exposes unwanted information about your database.
        • status
          String status
          The status of this cart.
          See Also:
        • submitDate
          Instant submitDate
          The date that this cart was submitted. Only set if the cart status is DefaultCartStatuses.SUBMITTED, otherwise null.
          See Also:
        • type
          String type
          The type of cart.
          See Also:
        • version
          Integer version
          The version of this cart. Used for checking that the requested version of the cart is up-to-date before saving changes. Required for any request which results in an update being made to the cart. This should never be manually incremented/decremented.
        • vouchers
          List<com.broadleafcommerce.order.common.domain.Voucher> vouchers
          A list of Vouchers that this Cart is qualifier for.

          This mainly serves as a temporary storage and for UI display, the Vouchers will not be processed until the order is completed.

    • Class com.broadleafcommerce.cart.client.domain.CartActionAudit

      class CartActionAudit extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • actionType
          String actionType
          The action type of this audit.
          See Also:
        • cartId
          String cartId
          The ID of the cart this cart action audit was created after.
        • comment
          String comment
          A comment related to the audit
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • data
          Map<String,Object> data
          Additional or custom audit information
        • id
          String id
          The context ID of the cart action audit.
        • newStatus
          String newStatus
          The new Cart.getStatus() after the cart action in which this audit was created for.

          For example, this field would be DefaultCartStatuses.REJECTED if the Cart was rejected.

          See Also:
        • oldStatus
          String oldStatus
          The old Cart.getStatus() prior the cart action in which this audit was created for.
          See Also:
        • timestamp
          Instant timestamp
          The time at which the CartActionAudit was created
        • userEmail
          String userEmail
          The email of the user who performed the cart action.

          For example, this would be the email of the account approver who rejected the cart.

        • userId
          String userId
          The id of the user who performed the cart action.

          For example, this would be the id of the account approver who rejected the cart.

        • userType
          String userType
          The type of user who performed the cart action.

          For example, this could be an account approver.

          See Also:

    • Class com.broadleafcommerce.cart.client.domain.CartAlert

      class CartAlert extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

    • Class com.broadleafcommerce.cart.client.domain.CartItem

      class CartItem extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • adjustmentsTotal
          javax.money.MonetaryAmount adjustmentsTotal
          The total adjustment price for all adjustments of a CartItem.
        • attributeChoices
          Map<String,com.broadleafcommerce.order.common.domain.AttributeChoiceValue> attributeChoices
          Attribute choices for this item driven by product options, where each key is the attributeName from an attribute choice.
        • attributeConfigErrors
          Map<String,List<ConfigError>> attributeConfigErrors
          Map of configuration errors for related to this item's CartItem.attributeChoices that are derived from ProductOptions where the key is the attribute name.
        • attributes
          Map<String,Object> attributes
          Miscellaneous attributes for this item.
        • brandId
          String brandId
          The id to the corresponding data driven enum for this item's product's brand. Used for validating offers.
        • cart
          Cart cart
          The owning cart of this item.
        • cartVersion
          Integer cartVersion
          The Cart's version. Used for version checking when the cart is not part of the request. See Cart.getVersion().
        • categoryIds
          Set<String> categoryIds
          The ids to the corresponding categories for this item's product. Used for validating item choice configuration and offers.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • currency
          javax.money.CurrencyUnit currency
        • dependentCartItems
          List<CartItem> dependentCartItems
          CartItems that depend on this CartItem. Also could be called "child items".
        • dependentItemConfigErrors
          Map<String,List<ConfigError>> dependentItemConfigErrors
          Map of configuration errors for related to this item's CartItem.dependentCartItems where the key is the item's identifier such as ProductOption choiceKey.
        • dependentItemDetails
          DependentItemDetails dependentItemDetails
          If this CartItem is a dependent cart item, this contains additional details about the dependent CartItem's dependency on its parent.

          This should always be populated for items within CartItem.getDependentCartItems(), and should never be populated for non-dependent items.

        • discountable
          boolean discountable

          Whether or not this item can be applied to any offers or promotions.

          Defaults to true

        • globalConfigErrors
          List<ConfigError> globalConfigErrors
          List of global configuration errors. API users and auditors can use this to see configuration errors.
        • id
          String id
          The context ID of the cart.
        • imageAsset
          ImageAssetRef imageAsset
          The image asset for this item, usually sourced from the product.
        • internalAttributes
          Map<String,Object> internalAttributes
          Miscellaneous internal attributes for this item. Distinguished from CartItem.getAttributes() in that this map is used for attributes that assist in the internal working of Broadleaf MicroServices. For example, attributes to help with pricing of dependent items.
        • isPriced
          boolean isPriced
          Flag to indicate whether this item has been priced.
        • itemAdjustments
          List<com.broadleafcommerce.order.common.domain.Adjustment> itemAdjustments
          Adjustments to item pricing that should be applied to CartItem.getSubtotal().
        • merchandisingContext
          String merchandisingContext
          Defines the merchandising context of the item to signify where it is added from.

          This field is intended to be used for items added from SELECTOR products, which allows for the possibility of targeting the items for discounts based on the fact that they came from the SELECTOR product.

        • merchandisingTypeId
          String merchandisingTypeId
          The id to the corresponding data driven enum for this item's product's merchandising type. Used for validating offers.
        • name
          String name
          The name of this item. Typically derived from the product or sku name.
        • overrideDetails
          List<com.broadleafcommerce.order.common.domain.OverrideDetail> overrideDetails
          List of details about any price overrides which have been performed on this item.
        • overridePriceFlag
          boolean overridePriceFlag
          Whether the price of this CartItem was specifically overridden, whether from a CSR or an automatic process.
        • priceListId
          String priceListId
          The id of the price list used to get the pricing for this CartItem.
        • pricingKey
          String pricingKey
          System-wide unique identifier to configure specific pricing for this cart item. Relevant if pricing data is managed in a separate system or data store, like the Broadleaf pricing services.
        • pricingStrategy
          String pricingStrategy
          For dependent cart items, this strategy is used to indicate how the price should be incorporated into the overall cart subtotal - i.e. whether this cart item's price should be added to the subtotal (the ADD_TO_PARENT strategy) or if the parent cart item's price already includes this item's price (the INCLUDED_IN_PARENT strategy). By default, the ADD_TO_PARENT strategy is used. Note: Regardless of this strategy, if the dependent cart item has a related FulfillmentItem, then there will likely be a tax amount related to the item which be included in the cart's overall price.
          See Also:
        • productId
          String productId
          The id to the corresponding product for this item.
        • productTags
          List<String> productTags
          The list of simple labels used to categorize the corresponding product for this item.
        • proratedOrderOfferAdjustments
          List<com.broadleafcommerce.order.common.domain.ProratedOfferAdjustment> proratedOrderOfferAdjustments
          Prorated adjustments for this item from order-level offers.

          This information is only needed for downstream services for uses like refund calculation, etc. Order-level offers are still applied at the cart level.

        • quantity
          Integer quantity
          The number of this item in the Cart.
        • recurringPrice
          com.broadleafcommerce.order.common.domain.RecurringPriceDetail recurringPrice
          This is the recurring price if any from the same source as the CartItem.unitPrice. The recurring price is used for subscriptions and is not expected to be charged at checkout typically.
          Since:
          Cart Client 2.0.4
          See Also:
          • CartItem.termDurationType
          • CartItem.termDurationLength
        • recurringPriceTypeOverride
          String recurringPriceTypeOverride
          Overrides CartItem.unitPriceType for the CartItem.recurringPrice in cases where they must diverge. Usually only in Offer use cases where an offer cannot apply to a sale recurring price but can apply to the standard recurring price and we need to leave the upfront price as the sale price—or vice versa.
          Since:
          Cart Client 2.0.4
        • sku
          String sku
          Represents a SKU code, similar to productId or variantId, except this is a unified, unique concept across both products and variants.
        • subtotal
          javax.money.MonetaryAmount subtotal
          The subtotal price of this CartItem. Typically calculated from CartItem.getUnitPrice() * CartItem.getQuantity().
        • targetDemographicId
          String targetDemographicId
          The id to the corresponding data driven enum for this item's product's target demographic. Used for validating offers.
        • taxable
          boolean taxable
          Whether this item is taxable.
        • termDurationLength
          Integer termDurationLength
          The length of the terms, e.g., if this is 36 and CartItem.termDurationType is MONTHS, then the CartItem.recurringPrice should be charged for 36 months.
          Since:
          Cart Client 2.0.4
          See Also:
          • CartItem.termDurationType
          • CartItem.recurringPrice
        • termDurationType
          String termDurationType
          The term duration type, e.g. DAYS, WEEKS, MONTHS, YEARS.
          Since:
          Cart Client 2.0.4
          See Also:
          • CartItem.termDurationLength
          • CartItem.recurringPrice
        • total
          javax.money.MonetaryAmount total
          The total price of this CartItem. Typically calculated from CartItem.getSubtotal() - CartItem.getAdjustmentsTotal().
        • type
          String type
          The type of this cart item. See DefaultCartItemTypes.
        • unitPrice
          javax.money.MonetaryAmount unitPrice
          The individual unit price for a CartItem.
        • unitPriceType
          String unitPriceType
          The type of the unit price for a CartItem. Typically "salePrice", "standardPrice", or "basePrice".
        • uri
          String uri
          The navigable uri of the corresponding catalog entry for this cart item.
        • usagePrice
          com.broadleafcommerce.order.common.domain.UsagePriceDetail usagePrice
          This is the usage price if any from the same source as the CartItem.unitPrice. The usage price represents a charge when an item is used, e.g., when using minutes above the base allowance. This is generally just information from a Cart's perspective.
          Since:
          Cart Client 2.0.4
        • variantId
          String variantId
          The id to the corresponding variant for this item.
        • vendorRef
          String vendorRef
          A reference to the corresponding vendor for this item.

    • Class com.broadleafcommerce.cart.client.domain.CartNote

      class CartNote extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalData
          Map<String,Object> additionalData
          Map to hold additional data.
        • authorEmail
          String authorEmail
          The email of the user that created this note.
        • authorId
          String authorId
          The id of the user that created this note.
        • authorType
          String authorType
          The type of the user that created this note.
          See Also:
        • cartId
          String cartId
          The Cart.getId() that this note belongs to.
        • cartItemId
          String cartItemId
          The CartItem.getId() that this note belongs to, this field is only relevant for CartItem-level notes.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • dateCreated
          Instant dateCreated
          When this note was created.
        • id
          String id
          The context ID of the note.
        • internalOnly
          boolean internalOnly
          Whether this note is for internal view only. Internal notes are only visible to sellers.
        • note
          String note
          The content of the note
        • replies
          List<CartNote> replies
          A list of notes representing the replies.

    • Class com.broadleafcommerce.cart.client.domain.CartPricing

      class CartPricing extends Object implements Serializable
      serialVersionUID:
      1L

    • Class com.broadleafcommerce.cart.client.domain.CheckoutCart

      class CheckoutCart extends Cart implements Serializable

      • Serialized Fields

        • cart
          Cart cart
        • fulfillmentGroupAdjustments
          List<com.broadleafcommerce.order.common.domain.Adjustment> fulfillmentGroupAdjustments
          A list of fulfillment group Adjustments.
        • fulfillmentItemAdjustments
          List<com.broadleafcommerce.order.common.domain.Adjustment> fulfillmentItemAdjustments
          A list of fulfillment item Adjustments.
        • itemAdjustments
          List<com.broadleafcommerce.order.common.domain.Adjustment> itemAdjustments
          A list of cart item Adjustments.
        • links
          Map<String,CartLink> links
          A map of CartLink by a link key.

    • Class com.broadleafcommerce.cart.client.domain.ConfigError

      class ConfigError extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • errorCode
          String errorCode
          The error code for this configuration error. Intended to be used with auditing or mapping to a human readable explanation.
        • errorMessage
          String errorMessage
          The error message for this configuration error. Intended to be shown to the customer as a human readable explanation.

    • Class com.broadleafcommerce.cart.client.domain.DependentItemDetails

      class DependentItemDetails extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalItemPricing
          AdditionalItemPricing additionalItemPricing
          Dictates how the dependent item should be priced.
        • itemChoiceKey
          String itemChoiceKey
          The key to use to relate to this CartItem to a configured product ItemChoice.
        • itemChoiceOverridePrice
          javax.money.MonetaryAmount itemChoiceOverridePrice
          In the case of a SpecificItemChoice, this will be populated with the override price of the parent ItemChoice.
        • itemChoicePricingKey
          String itemChoicePricingKey
          In the case of a SpecificItemChoice, this will be populated with the pricing key of the parent ItemChoice.
        • variantPricing
          Map<String,SpecificItemChoiceVariantPricingOverride> variantPricing
          Pricing overrides if specific variants of the main product this item belongs to are added to the cart.

    • Class com.broadleafcommerce.cart.client.domain.FulfillmentGroup

      class FulfillmentGroup extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • address
          com.broadleafcommerce.order.common.domain.Address address
          The shipping address for this fulfillment group.
        • adjustments
          List<com.broadleafcommerce.order.common.domain.Adjustment> adjustments
          Adjustments to fulfillment pricing that should be applied to FulfillmentGroup.getGroupFulfillmentPriceBeforeAdjustments().
        • attributes
          Map<String,Object> attributes
          Attributes for this fulfillment group.
        • fulfillmentAdjustmentsTotal
          javax.money.MonetaryAmount fulfillmentAdjustmentsTotal
          Sum of the group's adjustments.
        • fulfillmentItems
          List<FulfillmentItem> fulfillmentItems
          Items for fulfillment within this group, each of which should relate back to a cart item.
        • fulfillmentItemsSubtotal
          javax.money.MonetaryAmount fulfillmentItemsSubtotal
          The total shipping price of this fulfillment group's FulfillmentItems. This does not include taxes on the item shipping price.
        • fulfillmentOption
          com.broadleafcommerce.order.common.domain.FulfillmentOption fulfillmentOption
          The fulfillment option chosen for the FulfillmentGroup.getType().
        • fulfillmentTaxableAmount
          javax.money.MonetaryAmount fulfillmentTaxableAmount
          The amount of the total fulfillment price that can be taxed, including item shipping prices.
        • groupFulfillmentPriceBeforeAdjustments
          javax.money.MonetaryAmount groupFulfillmentPriceBeforeAdjustments
          The shipping price of this fulfillment group before adjustments are applied. This is pricing specifically at the group level and does not include pricing from FulfillmentItems.
        • inventoryLocationReference
          String inventoryLocationReference
          This is an optional field where the ID or reference number of the expected InventoryLocation is stored. Specifically, this is required in situations where a customer will pick up this FulfillmentGroup (i.e. type == FulfillmentType.PICKUP). This could also be provided as a hint in the case that this is a SHIP location and the application knows from where this FulfillmentGroup should be fulfilled.
        • isPriced
          boolean isPriced
          Flag to indicate whether this group has been priced.
        • overrideDetails
          List<com.broadleafcommerce.order.common.domain.OverrideDetail> overrideDetails
          List of details about any price overrides which have been performed on this group.
        • overrideFulfillmentPriceFlag
          boolean overrideFulfillmentPriceFlag
          Whether the total fulfillment price of this FulfillmentGroup was specifically overridden, whether from a CSR or an automatic process.
        • pricedFulfillmentOption
          com.broadleafcommerce.order.common.domain.PricedFulfillmentOption pricedFulfillmentOption
        • proratedFulfillmentAdjustments
          javax.money.MonetaryAmount proratedFulfillmentAdjustments
          Prorated amount of the fulfillment adjustments that applies to the FulfillmentGroup.groupFulfillmentPriceBeforeAdjustments. Fulfillment-level adjustments are prorated between the charges of the group and those of the individual items.
        • referenceNumber
          String referenceNumber
          The reference number for this fulfillment group.
        • taxAddressSource
          String taxAddressSource
          Where to find the address to be used for tax calculation on this fulfillment group. Defaults to the shipping address for this fulfillment group.
        • totalFulfillmentPrice
          javax.money.MonetaryAmount totalFulfillmentPrice
          The total shipping price of this fulfillment group, including adjustments and item shipping prices. This does not include taxes on the fulfillment price. This does not include taxes.
        • totalTax
          javax.money.MonetaryAmount totalTax
          The total tax of this fulfillment group, including merchandise and fulfillment tax.
        • 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.cart.client.domain.FulfillmentItem

      class FulfillmentItem extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • attributes
          Map<String,Object> attributes
          Miscellaneous attributes for this fulfillment 1tem.
        • availableOnline
          boolean availableOnline
          Whether or not this item is available online - ie inventory is available somewhere to fulfill this item.
        • cartItemId
          String cartItemId
          A reference id to the CartItem to be represented by this fulfillment item.
        • fulfillmentAdjustments
          List<com.broadleafcommerce.order.common.domain.Adjustment> fulfillmentAdjustments
          Adjustments to item fulfillment pricing that should be applied to FulfillmentItem.getFulfillmentPriceBeforeAdjustments().
        • fulfillmentAdjustmentsTotal
          javax.money.MonetaryAmount fulfillmentAdjustmentsTotal
          The total fulfillment adjustment amount for this fulfillment item. Used along with FulfillmentItem.getFulfillmentPriceBeforeAdjustments() to determine FulfillmentItem.getFulfillmentTotal().
        • fulfillmentItemTaxDetails
          List<FulfillmentItemTaxDetail> fulfillmentItemTaxDetails
          The tax details associated with this item.
        • fulfillmentPriceBeforeAdjustments
          javax.money.MonetaryAmount fulfillmentPriceBeforeAdjustments
          The fulfillment price of the corresponding CartItem before adjustments are applied.
        • fulfillmentTotal
          javax.money.MonetaryAmount fulfillmentTotal
          The total fulfillment price of this item, including adjustments. This does not include taxes.
        • internalAttributes
          Map<String,Object> internalAttributes
          Internal attributes for this fulfillment item. Distinguished from FulfillmentItem.getAttributes() in that this map is used for attributes that assist in the internal working of Broadleaf Microservices. For example, attributes to help with returning free gift items.
        • inventoryCheckStrategy
          String inventoryCheckStrategy
          The inventory check strategy of the item. This value helps to determine when an inventory check is required.
        • inventoryReservationStrategy
          String inventoryReservationStrategy
          The reservation strategy of the item. This value helps to determine when an inventory reservation is required.
        • isCartItemDiscountable
          boolean isCartItemDiscountable

          Whether or not any offers or promotions can be applied to the cart item.

          Defaults to true

        • merchandiseTaxableAmount
          javax.money.MonetaryAmount merchandiseTaxableAmount
          The amount that can be taxed based on the CartItem price and usually less any prorated order-adjustments.
        • merchandiseTotalAmount
          javax.money.MonetaryAmount merchandiseTotalAmount
          This represents the subtotal for the fulfillment item. In most cases, this value is determined by multiplying the unit price of the related CartItem by its quantity. In the case of a product bundle, the bundle declares an overall price, which is then prorated down to each bundle item. A fulfillment item is created for each of the bundle's dependent cart items and the prorated price is used to populate this field.

          For example, if the bundle price is $30 and it contains 2 included products with the price $10 and $15, and quantity 2 and 1 accordingly, the first fulfillment item's quantity will be 2 and merchandiseTotalAmount will be $17.14 (i.e. 30 * (10 * 2 / (20 + 15))). The second item's quantity will be 1 and merchandiseTotalAmount will be $12.86 (i.e. 30 * (15 * 1 / (20 + 15))). The sum of 2 fulfillment items should be $30 (i.e. $17.14 + $12.86)

        • merchandiseTotalTax
          javax.money.MonetaryAmount merchandiseTotalTax
          The total tax of the item merchandise based on the price of the related CartItem.
        • pricedFulfillmentOption
          com.broadleafcommerce.order.common.domain.PricedFulfillmentOption pricedFulfillmentOption
        • proratedFulfillmentCharge
          javax.money.MonetaryAmount proratedFulfillmentCharge
          The prorated shipping charge for this fulfillment item before adjustments are applied, derived from the FulfillmentGroup.getGroupFulfillmentPriceBeforeAdjustments(). This does not include additional shipping charges specific to the item.
        • proratedFulfillmentGroupAdjustments
          javax.money.MonetaryAmount proratedFulfillmentGroupAdjustments
          The amount prorated to this item from group adjustments.
        • proratedOrderAdjustments
          javax.money.MonetaryAmount proratedOrderAdjustments
          The amount prorated to this item from order adjustments. This is primarily for calculating FulfillmentItem.merchandiseTotalTax.
        • quantity
          int quantity
          The quantity to be fulfilled by this item. This isn't necessarily going to equal CartItem.getQuantity() since a CartItem can be split across multiple FulfillmentGroups.
        • referenceNumber
          String referenceNumber
          The reference number for this fulfillment item.

    • Class com.broadleafcommerce.cart.client.domain.FulfillmentItemTaxDetail

      class FulfillmentItemTaxDetail extends Object implements Serializable

      • Serialized Fields

        • country
          String country
          The 2 digit country code.
        • isVat
          boolean isVat
          Declares whether the taxes were included in the provided subtotal. Note: this is a known misnomer.
        • jurisdictionName
          String jurisdictionName
          The tax jurisdiction name. This may be a state, city, county, etc. For example, "California", "New York City", etc.
        • jurisdictionType
          String jurisdictionType
          The jurisdiction type, e.g. city, state, county, etc.
        • rate
          BigDecimal rate
          The tax rate
        • region
          String region
          The region that this tax was calculated.
        • taxableAmount
          javax.money.MonetaryAmount taxableAmount
          The amount that was taxable to determine the calculated tax.
        • taxCalculated
          javax.money.MonetaryAmount taxCalculated
          The amount of taxes calculated.
        • taxName
          String taxName
          The tax name for this tax detail. Describes the tax (e.g. TX STATE TAX)
        • transactionId
          String transactionId
          The transaction ID for this tax detail. Used to reconcile this tax detail with a specific transaction when using an external tax provider.

    • Class com.broadleafcommerce.cart.client.domain.GuestToken

      class GuestToken extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

    • Class com.broadleafcommerce.cart.client.domain.ImageAssetRef

      class ImageAssetRef extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • altText
          String altText
          Text that corresponds to the HTML alt attribute that should be used when this asset is rendered in a browser. This is used as an alternative for screen-readers and as an SEO enhancement describing the asset.
        • contentUrl
          String contentUrl
          The fully-resolvable content-URL to the binary data of the asset. It should be possible for a browser to hit this URL to retrieve the binary data.
        • tags
          LinkedHashSet<String> tags
          Descriptive or identifying labels.
        • title
          String title
          Text that corresponds to the HTML title attribute that should be used when this asset is rendered in a browser. This is used a tooltip or caption.

    • Class com.broadleafcommerce.cart.client.domain.ItemList

      class ItemList extends Object implements Serializable

      • Serialized Fields

        • attributes
          Map<String,Object> attributes
          Miscellaneous attributes for this item list.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • id
          String id
          The ID of this item list.
        • items
          List<ItemListItem> items
          The list of items this item list represents. This is generally unpopulated except for when hydration is explicitly requested.
        • name
          String name
          The name of this item list.

    • Class com.broadleafcommerce.cart.client.domain.ItemListAccessResponse

      class ItemListAccessResponse extends Object implements Serializable

      • Serialized Fields

        • accessibleItemListIds
          Set<String> accessibleItemListIds
          The list of Item List ids that the user has the proper role for.
        • inaccessibleItemListIds
          Set<String> inaccessibleItemListIds
          The list of Item List ids that the user does not have the proper access rights to.

    • Class com.broadleafcommerce.cart.client.domain.ItemListAccessRule

      class ItemListAccessRule extends Object implements Serializable

      • Serialized Fields

        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • id
          String id
          The ID of this item list access rule.
        • itemListId
          String itemListId
          The ID of the item list this rule provides access to.
        • role
          String role
          The role this rule is allowing. Describes how (in terms of what level of access) the item list may be accessed. See DefaultItemListAccessRuleRole for out of box values.
        • type
          String type
          The type of this access rule. Describes what is contained in the ItemListAccessRule.value property and is used in performing the actual access validation. See DefaultItemListAccessRuleType for out of box values.
        • value
          String value
          Some value of the ItemListAccessRule.type of this access rule. For example, if the type is an email address, the value should contain an email address of the user being allowed access to the list.

    • Class com.broadleafcommerce.cart.client.domain.ItemListItem

      class ItemListItem extends Object implements Serializable

      • Serialized Fields

        • attributeChoices
          Map<String,com.broadleafcommerce.order.common.domain.AttributeChoiceValue> attributeChoices
          Attribute choices for this item driven by product options, where each key is the attributeName from an attribute choice.
        • attributes
          Map<String,Object> attributes
          Miscellaneous attributes for this item.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • id
          String id
          The ID of this Item List Item.
        • internalAttributes
          Map<String,Object> internalAttributes
          Miscellaneous internal attributes for this item. Distinguished from ItemListItem.getAttributes() in that this map is used for attributes that assist in the internal working of Broadleaf MicroServices. For example, attributes related to item merging.

          These attributes will not be passed along to a CartItem.

        • itemListId
          String itemListId
          The ID of the owning item list.
        • itemSkuRef
          ItemSkuRef itemSkuRef
          A reference to the corresponding SKU of this item.
        • quantity
          Integer quantity
          The number of this item in the item list.

    • Class com.broadleafcommerce.cart.client.domain.ItemSkuRef

      class ItemSkuRef extends Object implements Serializable

      • Serialized Fields

        • productId
          String productId
          The ID of the product being referred to.
        • sku
          String sku
          The SKU being referred to.
        • variantId
          String variantId
          The ID of the variantId being referred to.

    • Class com.broadleafcommerce.cart.client.domain.SpecificItemChoiceVariantPricingOverride

      class SpecificItemChoiceVariantPricingOverride extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • overridePrice
          javax.money.MonetaryAmount overridePrice
          The price to use for this item when the related variant is selected.
        • pricingKey
          String pricingKey
          System-wide unique identifier to configure specific pricing for the choice. Relevant if pricing data is managed in a separate system or data store, like the Broadleaf pricing services.
        • variantId
          String variantId
          ID of the variant this pricing should be used with.