Class CartItemAttributeConstants.Internal

    • Field Detail

      • 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:
        Constant Field Values
      • 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:
        Constant Field Values
      • 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:
        Constant Field Values
      • 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:
        Constant Field Values
      • 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:
        CartAttributeConstants.Internal.OFFER_IDS_TO_IGNORE, Constant Field Values
      • 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:
        Constant Field Values