Package com.broadleafcommerce.cartoperation.domain

Class CartItemAttributeConstants.Internal

java.lang.Object
com.broadleafcommerce.cartoperation.domain.CartItemAttributeConstants.Internal
Enclosing class:
CartItemAttributeConstants
public static final class CartItemAttributeConstants.Internal extends Object

  • Field Details

    • VARIANT_PRICING_STRATEGY

      public static final String VARIANT_PRICING_STRATEGY
      Indicates the variant pricing strategy for the product.

      Only relevant for DefaultProductType.VARIANT_BASED products.

      Since:
      Cart Operation Service 2.3.0, Release Train 2.3.0
      See Also:

    • DIRECT_SKU_PRICE_INFOS

      public static final String DIRECT_SKU_PRICE_INFOS
      Contains a map from CatalogItem.getSku() or Variant.getSku() keys to PriceInfo for the associated CatalogItem or Variant. Used to produce SKU-based targets for pricing.
      See Also:

    • SKU_PRICE_INFOS

      public static final String SKU_PRICE_INFOS
      Deprecated.
      Contains a map from CatalogItem.getSku() or Variant.getSku() keys to PriceInfo for the associated CatalogItem or Variant. Used to produce SKU-based targets for pricing. This structure initially contains values from the Product but after pricing runs is updated with the results of pricing. Using the same field for this purpose can cause issues between the first and subsequent pricing calls for a cart item.
      See Also:

    • PRICING_KEY_PRICE_INFOS

      public static final String PRICING_KEY_PRICE_INFOS
      Contains a map from CatalogItem.getPricingKey() key to PriceInfo for the associated CatalogItem. Used to produce pricingKey-based targets for pricing.
      See Also:

    • PRICE_INFO_PAYMENT_STRATEGY

      public static final String PRICE_INFO_PAYMENT_STRATEGY
      Indicates the DefaultPaymentStrategy associated with the cart item's PriceInfo.
      Since:
      Cart Operation Service 2.3.0, Release Train 2.3.0
      See Also:

    • PRICE_INFO_PAYMENT_STRATEGY_OVERRIDDEN

      public static final String PRICE_INFO_PAYMENT_STRATEGY_OVERRIDDEN
      Indicates that PRICE_INFO_PAYMENT_STRATEGY has been overridden based on the Product.getPaymentStrategy() in the case of merchandising products.
      Since:
      Cart Operation Service 2.3.0, Release Train 2.3.0
      See Also:

    • IS_BROADLEAF_SUBSCRIPTION

      public static final String IS_BROADLEAF_SUBSCRIPTION
      The value of Product.isSubscription(). Whether it's a Broadleaf-managed subscription.
      Since:
      Cart Operation Service 2.3.0, Release Train 2.3.0
      See Also:

    • IS_CANCELLATION_REQUEST

      public static final String IS_CANCELLATION_REQUEST
      Whether this is a cancellation request for a subscription item.
      Since:
      Cart Operation Service 2.3.0, Release Train 2.3.0
      See Also:

    • IS_PRICE_LIMITED_BY_QUANTITY

      public static final String IS_PRICE_LIMITED_BY_QUANTITY
      Indicates if a CartItem is using a price that is limited by quantity.
      See Also:

    • CLONED_ITEM_ORIGINAL_ID

      public static final String CLONED_ITEM_ORIGINAL_ID
      For CartItems which were cloned from another cart, this attribute will be populated with the ID of the original item which was cloned from.
      See Also:

    • ITEM_CHOICE_TARGET_KEY

      public static final String ITEM_CHOICE_TARGET_KEY
      A temporary storage location to mark that this dependent CartItem was successfully matched to a particular ItemChoice target (a SpecificItemChoice or Category) when populating item choices. Contains the relevant item choice target key, either a product or variant ID, or the targeted category ID. Used to simplify later validation.
      See Also:

    • IS_FREE_GIFT_ITEM

      public static final String IS_FREE_GIFT_ITEM
      Indicates if a CartItem is a free gift item added from a Free Gift offer.
      See Also:

    • FREE_GIFT_ADJUSTMENT

      public static final String FREE_GIFT_ADJUSTMENT
      A temporary storage location to store the Adjustment for a free gift item.

      This is needed because Adjustment.getAmount() needs to be set to item's subtotal after the free gift item is automatically added. At the time of a free gift offer being applied, the Offer Engine has no idea of the price of the free gift item , hence we need to update the Adjustment.

      See Also:

    • GIFT_FEE

      public static final String GIFT_FEE
      Stores the gift fee detail. See CartItemOfferUtils.getGiftFee(CartItem)
      See Also:

    • ORIGIN_OFFER_ID

      public static final String ORIGIN_OFFER_ID
      The id of the offer that this CartItem was a target of. This attribute is typically used to identifies which offer this item was added from, and keep track of offers to not be applied again.

      For example, CartItemA is a qualifier of a free gift offer OfferA, and CartItem_FG is a free gift item (target of OfferA) from the free gift offer. Whenever CartItem_FG is removed, the id of OfferA is added to Cart.getInternalAttributes() so that OfferA will not be applied again when CartItemA is added.

      See Also:

    • INVENTORY_TYPE

      public static final String INVENTORY_TYPE
      The following internal attributes are temporary storage locations for fulfillment related information to be used for populating a FulfillmentItem.
      See Also:

    • AVAILABLE_ONLINE

      public static final String AVAILABLE_ONLINE
      See Also:

    • INVENTORY_CHECK_STRATEGY

      public static final String INVENTORY_CHECK_STRATEGY
      See Also:

    • INVENTORY_RESERVATION_STRATEGY

      public static final String INVENTORY_RESERVATION_STRATEGY
      See Also:

    • FULFILLMENT_FLAT_RATES

      public static final String FULFILLMENT_FLAT_RATES
      See Also:

    • WEIGHT

      public static final String WEIGHT
      See Also:

    • DISCOUNTABLE

      public static final String DISCOUNTABLE
      See Also:

    • PRODUCT_TYPE

      public static final String PRODUCT_TYPE
      See Also:

    • TAX_CODE

      public static final String TAX_CODE
      See Also:

    • SKU

      public static final String SKU
      See Also:

    • FULFILLMENT_WORKFLOW

      public static final String FULFILLMENT_WORKFLOW
      See Also:

    • ADD_TO_CART_STRATEGY

      public static final String ADD_TO_CART_STRATEGY
      Inventory strategy internal attribute values
      See Also:

    • DIMENSION

      public static final String DIMENSION
      Fulfillment attributes
      See Also:

    • PRICEABLE_CHARACTERISTICS

      public static final String PRICEABLE_CHARACTERISTICS
      Names of Characteristics that should be stored as attributes to be used to populate PriceableTarget.getCharacteristics()
      Since:
      Cart Operation Service 2.2.0, Release Train 2.2.0
      See Also:

    • TARGETABLE_CHARACTERISTICS

      public static final String TARGETABLE_CHARACTERISTICS
      Names of Characteristics that should be stored as attributes to be used to contribute to LineItemDto.getAttributes().
      Since:
      Cart Operation Service 2.2.0, Release Train 2.2.0
      See Also:

    • PRICING_CATEGORY

      public static final String PRICING_CATEGORY
      Additional, optional data available in product attributes relating to a product's pricing grouping. Targeted when transforming pricing via modifiers.
      See Also:

    • ITEM_TYPE

      public static final String ITEM_TYPE
      The CartItem.type, which is typically a DefaultCartItemTypes enum.
      Since:
      Cart Operation Service 2.3.0, Release Train 2.3.0
      See Also:

    • FEE_CODE

      public static final String FEE_CODE
      The code of the Fee that the CartItem represents.
      Since:
      Cart Operation Service 2.3.0, Release Train 2.3.0
      See Also:

    • IS_FEE_REFUNDABLE

      public static final String IS_FEE_REFUNDABLE
      Whether the CartItem that represents a fee is refundable.
      Since:
      Cart Operation Service 2.3.0, Release Train 2.3.0
      See Also:

    • AUTO_RENEWAL_ENABLED

      public static final String AUTO_RENEWAL_ENABLED
      Whether the current subscription cartItem would be auto-renewed.
      Since:
      Cart Operation Service 2.3.0, Release Train 2.3.0
      See Also:

    • ALLOW_AUTO_RENEWAL_MODIFICATION

      public static final String ALLOW_AUTO_RENEWAL_MODIFICATION
      Whether the current subscription cartItem's auto-renewability can be modified after declaration on the subscription.
      Since:
      Cart Operation Service 2.3.0, Release Train 2.3.0
      See Also:

    • END_OF_TERM_STRATEGY

      public static final String END_OF_TERM_STRATEGY
      Indicates the action to be performed at the end of term.
      Since:
      Cart Operation Service 2.3.0, Release Train 2.3.0
      See Also:

    • CURRENCY_CONVERSION_DETAILS

      public static final String CURRENCY_CONVERSION_DETAILS
      In cases where the PriceInfo found for the item added to cart had a PriceTypeDetail that underwent currency conversion to match the requested currency, this will store the details of that conversion, particularly the rate used.
      Since:
      Cart Operation Service 2.3.0, Release Train 2.3.0
      See Also: