Package com.commercetools.api.models.cart
package com.commercetools.api.models.cart
-
ClassDescriptionCart Example to create an instance using the builder patternIf the Cart already contains a CustomLineItem with the same
slug
,name
,money
,taxCategory
,state
, and Custom Fields, then only the quantity of the existing Custom Line Item is increased.CartAddCustomLineItemActionBuilder Example to create an instance using the builder patternTo add a custom Shipping Method (independent of the ShippingMethods managed through the Shipping Methods API) to the Cart, it must have theMultiple
ShippingMode.CartAddCustomShippingMethodActionBuilder Example to create an instance using the builder patternAdds a DiscountCode to the Cart to activate the related Cart Discounts.CartAddDiscountCodeActionBuilder Example to create an instance using the builder patternAdds an address to a Cart when shipping to multiple addresses is desired.CartAddItemShippingAddressActionBuilder Example to create an instance using the builder patternIf the Cart contains a LineItem for a Product Variant with the same LineItemMode, Custom Fields, supply and distribution channel, then only the quantity of the existing Line Item is increased.CartAddLineItemActionBuilder Example to create an instance using the builder patternCartAddPaymentAction Example to create an instance using the builder patternCartAddPaymentActionBuilder Example to create an instance using the builder patternAdds a Shipping Method for a specified shipping address to a Cart withMultiple
ShippingMode.CartAddShippingMethodActionBuilder Example to create an instance using the builder patternAdds all LineItems of a ShoppingList to the Cart.CartAddShoppingListActionBuilder Example to create an instance using the builder patternCartApplyDeltaToCustomLineItemShippingDetailsTargetsAction Example to create an instance using the builder patternCartApplyDeltaToCustomLineItemShippingDetailsTargetsActionBuilder Example to create an instance using the builder patternTo override the shipping details, see Set LineItem ShippingDetails.CartApplyDeltaToLineItemShippingDetailsTargetsActionBuilder Example to create an instance using the builder patternCartBuilder Example to create an instance using the builder patternCartChangeCustomLineItemMoneyAction Example to create an instance using the builder patternCartChangeCustomLineItemMoneyActionBuilder Example to create an instance using the builder patternCartChangeCustomLineItemPriceModeAction Example to create an instance using the builder patternCartChangeCustomLineItemPriceModeActionBuilder Example to create an instance using the builder patternWhen multiple shipping addresses are set for a Custom Line Item, use the Add CustomLineItem update action to change the shipping details.CartChangeCustomLineItemQuantityActionBuilder Example to create an instance using the builder patternWhen multiple shipping addresses are set for a Line Item, use the Remove LineItem and Add LineItem update action to change the shipping details.CartChangeLineItemQuantityActionBuilder Example to create an instance using the builder patternCartChangeLineItemsOrderAction Example to create an instance using the builder patternCartChangeLineItemsOrderActionBuilder Example to create an instance using the builder patternChanging the tax calculation mode leads to recalculation of taxes.CartChangeTaxCalculationModeActionBuilder Example to create an instance using the builder patternWhenExternal
TaxMode is changed toPlatform
orDisabled
, all previously set external Tax Rates are removed. When set toPlatform
, Line Items, Custom Line Items, and Shipping Method require a Tax Category with a Tax Rate for the Cart'sshippingAddress
. Example to create an instance using the builder patternCartChangeTaxModeActionBuilder Example to create an instance using the builder patternChanging the tax rounding mode leads to recalculation of taxes.CartChangeTaxRoundingModeActionBuilder Example to create an instance using the builder patternCartDraft Example to create an instance using the builder patternCartDraftBuilder Example to create an instance using the builder patternChanges the CartState fromActive
toFrozen
.CartFreezeCartActionBuilder Example to create an instance using the builder patternIndicates who created the Cart.possible values of CartOriginPagedQueryResult with results containing an array of Cart.CartPagedQueryResponseBuilder Example to create an instance using the builder patternThis update action does not set any Cart field in particular, but it triggers several Cart updates to bring prices and discounts to the latest state.CartRecalculateActionBuilder Example to create an instance using the builder patternReference to a Cart.CartReferenceBuilder Example to create an instance using the builder patternThis update action does not support specifying quantities, unlike the Remove LineItem update action.CartRemoveCustomLineItemActionBuilder Example to create an instance using the builder patternCartRemoveDiscountCodeAction Example to create an instance using the builder patternCartRemoveDiscountCodeActionBuilder Example to create an instance using the builder patternAn address can only be removed if it is not referenced in any ItemShippingTarget of the Cart.CartRemoveItemShippingAddressActionBuilder Example to create an instance using the builder patternThe LineItem price is updated as described in Line Item price selection.CartRemoveLineItemActionBuilder Example to create an instance using the builder patternCartRemovePaymentAction Example to create an instance using the builder patternCartRemovePaymentActionBuilder Example to create an instance using the builder patternRemoves a Shipping Method from a Cart that has theMultiple
ShippingMode.CartRemoveShippingMethodActionBuilder Example to create an instance using the builder patternResourceIdentifier to a Cart.CartResourceIdentifierBuilder Example to create an instance using the builder patternIf the Cart is already associated with a Customer, an InvalidOperation error is returned.CartSetAnonymousIdActionBuilder Example to create an instance using the builder patternCartSetBillingAddressAction Example to create an instance using the builder patternCartSetBillingAddressActionBuilder Example to create an instance using the builder patternCartSetBillingAddressCustomFieldAction Example to create an instance using the builder patternCartSetBillingAddressCustomFieldActionBuilder Example to create an instance using the builder patternCartSetBillingAddressCustomTypeAction Example to create an instance using the builder patternCartSetBillingAddressCustomTypeActionBuilder Example to create an instance using the builder patternUpdates the Business Unit on the Cart.CartSetBusinessUnitActionBuilder Example to create an instance using the builder patternCan be used if the Cart has theExternalAmount
TaxMode.CartSetCartTotalTaxActionBuilder Example to create an instance using the builder patternSetting the country can lead to changes in the LineItem prices.CartSetCountryActionBuilder Example to create an instance using the builder patternCartSetCustomerEmailAction Example to create an instance using the builder patternCartSetCustomerEmailActionBuilder Example to create an instance using the builder patternThis update action can only be used if a Customer is not assigned to the Cart.CartSetCustomerGroupActionBuilder Example to create an instance using the builder patternSetting the Cart'scustomerId
can lead to updates on all its LineItemprices
.CartSetCustomerIdActionBuilder Example to create an instance using the builder patternCartSetCustomFieldAction Example to create an instance using the builder patternCartSetCustomFieldActionBuilder Example to create an instance using the builder patternCartSetCustomLineItemCustomFieldAction Example to create an instance using the builder patternCartSetCustomLineItemCustomFieldActionBuilder Example to create an instance using the builder patternCartSetCustomLineItemCustomTypeAction Example to create an instance using the builder patternCartSetCustomLineItemCustomTypeActionBuilder Example to create an instance using the builder patternCartSetCustomLineItemShippingDetailsAction Example to create an instance using the builder patternCartSetCustomLineItemShippingDetailsActionBuilder Example to create an instance using the builder patternCan be used if the Cart has theExternalAmount
TaxMode.CartSetCustomLineItemTaxAmountActionBuilder Example to create an instance using the builder patternCan be used if the Cart has theExternal
TaxMode.CartSetCustomLineItemTaxRateActionBuilder Example to create an instance using the builder patternTo set the Cart's custom Shipping Method (independent of the ShippingMethods managed through the Shipping Methods API) the Cart must have theSingle
ShippingMode and ashippingAddress
.CartSetCustomShippingMethodActionBuilder Example to create an instance using the builder patternCartSetCustomTypeAction Example to create an instance using the builder patternCartSetCustomTypeActionBuilder Example to create an instance using the builder patternNumber of days after which a Cart withActive
CartState is deleted since its last modification.CartSetDeleteDaysAfterLastModificationActionBuilder Example to create an instance using the builder patternAdds a DirectDiscount, but only if no DiscountCode has been added to the Cart.CartSetDirectDiscountsActionBuilder Example to create an instance using the builder patternCartSetItemShippingAddressCustomFieldAction Example to create an instance using the builder patternCartSetItemShippingAddressCustomFieldActionBuilder Example to create an instance using the builder patternCartSetItemShippingAddressCustomTypeAction Example to create an instance using the builder patternCartSetItemShippingAddressCustomTypeActionBuilder Example to create an instance using the builder patternCartSetKeyAction Example to create an instance using the builder patternCartSetKeyActionBuilder Example to create an instance using the builder patternCartSetLineItemCustomFieldAction Example to create an instance using the builder patternCartSetLineItemCustomFieldActionBuilder Example to create an instance using the builder patternCartSetLineItemCustomTypeAction Example to create an instance using the builder patternCartSetLineItemCustomTypeActionBuilder Example to create an instance using the builder patternSetting a distribution channel for a LineItem can lead to an updatedprice
as described in Line Item price selection.CartSetLineItemDistributionChannelActionBuilder Example to create an instance using the builder patternCartSetLineItemInventoryModeAction Example to create an instance using the builder patternCartSetLineItemInventoryModeActionBuilder Example to create an instance using the builder patternSets the LineItemprice
and changes thepriceMode
toExternalPrice
LineItemPriceMode.CartSetLineItemPriceActionBuilder Example to create an instance using the builder patternCartSetLineItemShippingDetailsAction Example to create an instance using the builder patternCartSetLineItemShippingDetailsActionBuilder Example to create an instance using the builder patternPerforming this action has no impact on inventory that should be reserved.CartSetLineItemSupplyChannelActionBuilder Example to create an instance using the builder patternCan be used if the Cart has theExternalAmount
TaxMode.CartSetLineItemTaxAmountActionBuilder Example to create an instance using the builder patternCan be used if the Cart has theExternal
TaxMode.CartSetLineItemTaxRateActionBuilder Example to create an instance using the builder patternSets the LineItemtotalPrice
andprice
, and changes thepriceMode
toExternalTotal
LineItemPriceMode.CartSetLineItemTotalPriceActionBuilder Example to create an instance using the builder patternCartSetLocaleAction Example to create an instance using the builder patternCartSetLocaleActionBuilder Example to create an instance using the builder patternSetting the shipping address also sets the TaxRate of Line Items and calculates the TaxedPrice.CartSetShippingAddressActionBuilder Example to create an instance using the builder patternCartSetShippingAddressCustomFieldAction Example to create an instance using the builder patternCartSetShippingAddressCustomFieldActionBuilder Example to create an instance using the builder patternCartSetShippingAddressCustomTypeAction Example to create an instance using the builder patternCartSetShippingAddressCustomTypeActionBuilder Example to create an instance using the builder patternCartSetShippingCustomFieldAction Example to create an instance using the builder patternCartSetShippingCustomFieldActionBuilder Example to create an instance using the builder patternThis action sets, overwrites, or removes any existing Custom Type and Custom Fields for the Cart'sshippingMethod
orshipping
.CartSetShippingCustomTypeActionBuilder Example to create an instance using the builder patternTo set the Cart's Shipping Method the Cart must have theSingle
ShippingMode and ashippingAddress
.CartSetShippingMethodActionBuilder Example to create an instance using the builder patternA Shipping Method tax amount can be set if the Cart has theExternalAmount
TaxMode.CartSetShippingMethodTaxAmountActionBuilder Example to create an instance using the builder patternA Shipping Method Tax Rate can be set if the Cart has theExternal
TaxMode.CartSetShippingMethodTaxRateActionBuilder Example to create an instance using the builder patternInput used to select a ShippingRatePriceTier.CartSetShippingRateInputActionBuilder Example to create an instance using the builder patternIndicates the current status of a Cart.possible values of CartStateChanges the CartState fromFrozen
toActive
.CartUnfreezeCartActionBuilder Example to create an instance using the builder patternCartUpdate Example to create an instance using the builder patternCartUpdateAction Example to create a subtype instance using the builder patternCartUpdateActionBuilderCartUpdateBuilder Example to create an instance using the builder patternUpdates an address initemShippingAddresses
by keeping the Addresskey
.CartUpdateItemShippingAddressActionBuilder Example to create an instance using the builder patternClassificationShippingRateInput Example to create an instance using the builder patternClassificationShippingRateInputBuilder Example to create an instance using the builder patternClassificationShippingRateInputDraft Example to create an instance using the builder patternClassificationShippingRateInputDraftBuilder Example to create an instance using the builder patternA generic item that can be added to the Cart but is not bound to a Product that can be used for discounts (negative money), vouchers, complex cart rules, additional services, or fees.CustomLineItemBuilder Example to create an instance using the builder patternCustomLineItemDraft Example to create an instance using the builder patternCustomLineItemDraftBuilder Example to create an instance using the builder patternDetermines if Cart Discounts can be applied to a Custom Line Item in the Cart.possible values of CustomLineItemPriceModeCustomShippingDraft Example to create an instance using the builder patternCustomShippingDraftBuilder Example to create an instance using the builder patternRepresents a CartDiscount that is only associated with a single Cart or Order.DirectDiscountBuilder Example to create an instance using the builder patternRepresents a CartDiscount that can only be associated with a single Cart or Order.DirectDiscountDraftBuilder Example to create an instance using the builder patternReference to a DirectDiscount.DirectDiscountReferenceBuilder Example to create an instance using the builder patternDiscountCodeInfo Example to create an instance using the builder patternDiscountCodeInfoBuilder Example to create an instance using the builder patternIndicates the state of a Discount Code in a Cart.possible values of DiscountCodeStateDiscountedLineItemPortion Example to create an instance using the builder patternDiscountedLineItemPortionBuilder Example to create an instance using the builder patternDiscountedLineItemPortionDraft Example to create an instance using the builder patternDiscountedLineItemPortionDraftBuilder Example to create an instance using the builder patternDiscountedLineItemPrice Example to create an instance using the builder patternDiscountedLineItemPriceBuilder Example to create an instance using the builder patternDiscountedLineItemPriceForQuantity Example to create an instance using the builder patternDiscountedLineItemPriceForQuantityBuilder Example to create an instance using the builder patternDiscountedTotalPricePortion Example to create an instance using the builder patternDiscountedTotalPricePortionBuilder Example to create an instance using the builder patternDiscountOnTotalPrice Example to create an instance using the builder patternDiscountOnTotalPriceBuilder Example to create an instance using the builder patternExternalLineItemTotalPrice Example to create an instance using the builder patternExternalLineItemTotalPriceBuilder Example to create an instance using the builder patternCannot be used in LineItemDraft or CustomLineItemDraft.ExternalTaxAmountDraftBuilder Example to create an instance using the builder patternControls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.ExternalTaxRateDraftBuilder Example to create an instance using the builder patternIndicates how Line Items in a Cart are tracked.possible values of InventoryModeItemShippingDetails Example to create an instance using the builder patternItemShippingDetailsBuilder Example to create an instance using the builder patternFor order creation and updates, the sum of thetargets
must match the quantity of the Line Items or Custom Line Items.ItemShippingDetailsDraftBuilder Example to create an instance using the builder patternDetermines the address (as a reference to an address initemShippingAddresses
) and the quantity shipped to the address.ItemShippingTargetBuilder Example to create an instance using the builder patternThe representation of a Line Item in a Cart or in an Order.LineItemBuilder Example to create an instance using the builder patternFor Product Variant identification, either theproductId
andvariantId
, orsku
must be provided.LineItemDraftBuilder Example to create an instance using the builder patternIndicates how a Line Item was added to a Cart.possible values of LineItemModeThis mode indicates how the price is set for the Line Item.possible values of LineItemPriceModeMethodExternalTaxRateDraft Example to create an instance using the builder patternMethodExternalTaxRateDraftBuilder Example to create an instance using the builder patternMethodTaxedPrice Example to create an instance using the builder patternMethodTaxedPriceBuilder Example to create an instance using the builder patternMethodTaxRate Example to create an instance using the builder patternMethodTaxRateBuilder Example to create an instance using the builder patternThe scope controls which part of the product information is published.possible values of ProductPublishScopeProductTailoringUpdate Example to create an instance using the builder patternProductTailoringUpdateBuilder Example to create an instance using the builder patternUsed for replicating an existing Cart or Order.ReplicaCartDraftBuilder Example to create an instance using the builder patternDetermines how monetary values are rounded.possible values of RoundingModeScoreShippingRateInput Example to create an instance using the builder patternScoreShippingRateInputBuilder Example to create an instance using the builder patternScoreShippingRateInputDraft Example to create an instance using the builder patternScoreShippingRateInputDraftBuilder Example to create an instance using the builder patternShipping Example to create an instance using the builder patternShippingBuilder Example to create an instance using the builder patternWraps all shipping-related information (such as address, rate, deliveries) per Shipping Method for Carts with multiple Shipping Methods.ShippingDraftBuilder Example to create an instance using the builder patternShippingInfo Example to create an instance using the builder patternShippingInfoBuilder Example to create an instance using the builder patternDetermines whether the selected ShippingMethod is allowed for the Cart.possible values of ShippingMethodStateShippingModepossible values of ShippingModeShippingRateInput Example to create a subtype instance using the builder patternShippingRateInputBuilderGeneric type holding specifc ShippingRateInputDraft types.ShippingRateInputDraftBuilderDetermines in which Tax calculation mode taxed prices are calculated.possible values of TaxCalculationModeTaxedItemPrice Example to create an instance using the builder patternTaxedItemPriceBuilder Example to create an instance using the builder patternTaxedPrice Example to create an instance using the builder patternTaxedPriceBuilder Example to create an instance using the builder patternTaxedPriceDraft Example to create an instance using the builder patternTaxedPriceDraftBuilder Example to create an instance using the builder patternIndicates how taxes are set on the Cart.possible values of TaxModeThe tax portions are calculated from the TaxRates.TaxPortionBuilder Example to create an instance using the builder patternRepresents the portions that sum up to thetotalGross
field of a TaxedPrice.TaxPortionDraftBuilder Example to create an instance using the builder pattern