Package com.commercetools.api.models.cart

Class CartAddLineItemActionImpl

java.lang.Object

com.commercetools.api.models.cart.CartAddLineItemActionImpl

All Implemented Interfaces:

CartAddLineItemAction, CartUpdateAction, CustomizableDraft<CartAddLineItemAction>, ResourceUpdateAction<CartUpdateAction>, io.vrap.rmf.base.client.ModelBase

public class CartAddLineItemActionImpl
extends Object
implements CartAddLineItemAction, io.vrap.rmf.base.client.ModelBase

If 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. If LineItem shippingDetails is set, it is merged. All addresses will be present afterwards and, for address keys present in both shipping details, the quantity will be summed up. A new Line Item is added when the externalPrice or externalTotalPrice is set in this update action. The LineItem price is set as described in LineItem Price selection.

If the Tax Rate is not set, a MissingTaxRateForCountry error is returned.

If the Line Items do not have a Price according to the Product priceMode value for a selected currency and/or country, Customer Group, or Channel, a MatchingPriceNotFound error is returned.

Nested Class Summary

Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase

io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle

Field Summary

Fields inherited from interface com.commercetools.api.models.cart.CartAddLineItemAction

ADD_LINE_ITEM

Constructor Summary

Constructors

Constructor	Description
CartAddLineItemActionImpl()	create empty instance

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getAction()
ZonedDateTime	getAddedAt()	Date and time (UTC) the Product Variant is added to the Cart.
CustomFieldsDraft	getCustom()	Custom Fields for the Line Item.
ChannelResourceIdentifier	getDistributionChannel()	Used to select a Product Price.
Money	getExternalPrice()	Sets the LineItem price value, and the priceMode to ExternalPrice LineItemPriceMode.
ExternalTaxRateDraft	getExternalTaxRate()	External Tax Rate for the Line Item, if the Cart has the External TaxMode.
ExternalLineItemTotalPrice	getExternalTotalPrice()	Sets the LineItem price and totalPrice values, and the priceMode to ExternalTotal LineItemPriceMode.
InventoryMode	getInventoryMode()	Inventory mode specific to the Line Item only, and valid for the entire quantity of the Line Item.
String	getKey()	User-defined unique identifier of the LineItem.
String	getProductId()	id of the published Product.
Long	getQuantity()	Quantity of the Product Variant to add to the Cart.
ItemShippingDetailsDraft	getShippingDetails()	Container for Line Item-specific addresses.
String	getSku()	SKU of the ProductVariant.
ChannelResourceIdentifier	getSupplyChannel()	Used to identify Inventory entries that must be reserved.
Long	getVariantId()	id of the ProductVariant in the Product.
int	hashCode()
void	setAddedAt(ZonedDateTime addedAt)	Date and time (UTC) the Product Variant is added to the Cart.
void	setCustom(CustomFieldsDraft custom)	Custom Fields for the Line Item.
void	setDistributionChannel(ChannelResourceIdentifier distributionChannel)	Used to select a Product Price.
void	setExternalPrice(Money externalPrice)	Sets the LineItem price value, and the priceMode to ExternalPrice LineItemPriceMode.
void	setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)	External Tax Rate for the Line Item, if the Cart has the External TaxMode.
void	setExternalTotalPrice(ExternalLineItemTotalPrice externalTotalPrice)	Sets the LineItem price and totalPrice values, and the priceMode to ExternalTotal LineItemPriceMode.
void	setInventoryMode(InventoryMode inventoryMode)	Inventory mode specific to the Line Item only, and valid for the entire quantity of the Line Item.
void	setKey(String key)	User-defined unique identifier of the LineItem.
void	setProductId(String productId)	id of the published Product.
void	setQuantity(Long quantity)	Quantity of the Product Variant to add to the Cart.
void	setShippingDetails(ItemShippingDetailsDraft shippingDetails)	Container for Line Item-specific addresses.
void	setSku(String sku)	SKU of the ProductVariant.
void	setSupplyChannel(ChannelResourceIdentifier supplyChannel)	Used to identify Inventory entries that must be reserved.
void	setVariantId(Long variantId)	id of the ProductVariant in the Product.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.commercetools.api.models.cart.CartAddLineItemAction

withCartAddLineItemAction

Methods inherited from interface com.commercetools.api.models.cart.CartUpdateAction

withCartUpdateAction

Methods inherited from interface com.commercetools.api.models.CustomizableDraft

unwrapCustomizableDraft

Methods inherited from interface io.vrap.rmf.base.client.ModelBase

reflectionString, reflectionString

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Constructor Details

CartAddLineItemActionImpl

public CartAddLineItemActionImpl()

create empty instance

Method Details

getAction

public String getAction()

Specified by:

getAction in interface CartUpdateAction

Specified by:

getAction in interface ResourceUpdateAction<CartUpdateAction>

Returns:

action

getKey

public String getKey()

User-defined unique identifier of the LineItem.

Specified by:

getKey in interface CartAddLineItemAction

Returns:

key

getProductId

public String getProductId()

id of the published Product.

Either the productId and variantId, or sku must be provided.

Specified by:

getProductId in interface CartAddLineItemAction

Returns:

productId

getVariantId

public Long getVariantId()

id of the ProductVariant in the Product. If not provided, the Master Variant is used.

Either the productId and variantId, or sku must be provided.

Specified by:

getVariantId in interface CartAddLineItemAction

Returns:

variantId

getSku

public String getSku()

SKU of the ProductVariant.

Either the productId and variantId, or sku must be provided.

Specified by:

getSku in interface CartAddLineItemAction

Returns:

sku

getQuantity

public Long getQuantity()

Quantity of the Product Variant to add to the Cart.

Specified by:

getQuantity in interface CartAddLineItemAction

Returns:

quantity

getAddedAt

public ZonedDateTime getAddedAt()

Date and time (UTC) the Product Variant is added to the Cart. If not set, it defaults to the current date and time.

Optional for backwards compatibility reasons.

Specified by:

getAddedAt in interface CartAddLineItemAction

Returns:

addedAt

getDistributionChannel

public ChannelResourceIdentifier getDistributionChannel()

Used to select a Product Price. The Channel must have the ProductDistribution ChannelRoleEnum. If the Cart is bound to a Store with distributionChannels set, the Channel must match one of the Store's distribution channels.

Specified by:

getDistributionChannel in interface CartAddLineItemAction

Returns:

distributionChannel

getSupplyChannel

public ChannelResourceIdentifier getSupplyChannel()

Used to identify Inventory entries that must be reserved. The Channel must have the InventorySupply ChannelRoleEnum.

Specified by:

getSupplyChannel in interface CartAddLineItemAction

Returns:

supplyChannel

getExternalPrice

public Money getExternalPrice()

Sets the LineItem price value, and the priceMode to ExternalPrice LineItemPriceMode.

Specified by:

getExternalPrice in interface CartAddLineItemAction

Returns:

externalPrice

getExternalTotalPrice

public ExternalLineItemTotalPrice getExternalTotalPrice()

Sets the LineItem price and totalPrice values, and the priceMode to ExternalTotal LineItemPriceMode.

Specified by:

getExternalTotalPrice in interface CartAddLineItemAction

Returns:

externalTotalPrice

getExternalTaxRate

public ExternalTaxRateDraft getExternalTaxRate()

External Tax Rate for the Line Item, if the Cart has the External TaxMode.

Specified by:

getExternalTaxRate in interface CartAddLineItemAction

Returns:

externalTaxRate

getInventoryMode

public InventoryMode getInventoryMode()

Inventory mode specific to the Line Item only, and valid for the entire quantity of the Line Item. Set only if the inventory mode should be different from the inventoryMode specified on the Cart.

Specified by:

getInventoryMode in interface CartAddLineItemAction

Returns:

inventoryMode

getShippingDetails

public ItemShippingDetailsDraft getShippingDetails()

Container for Line Item-specific addresses.

Specified by:

getShippingDetails in interface CartAddLineItemAction

Returns:

shippingDetails

getCustom

public CustomFieldsDraft getCustom()

Custom Fields for the Line Item.

Specified by:

getCustom in interface CartAddLineItemAction

Specified by:

getCustom in interface CustomizableDraft<CartAddLineItemAction>

Returns:

custom

setKey

public void setKey(String key)

Description copied from interface: CartAddLineItemAction

User-defined unique identifier of the LineItem.

Specified by:

setKey in interface CartAddLineItemAction

Parameters:

key - value to be set

setProductId

public void setProductId(String productId)

Description copied from interface: CartAddLineItemAction

id of the published Product.

Either the productId and variantId, or sku must be provided.

Specified by:

setProductId in interface CartAddLineItemAction

Parameters:

productId - value to be set

setVariantId

public void setVariantId(Long variantId)

Description copied from interface: CartAddLineItemAction

id of the ProductVariant in the Product. If not provided, the Master Variant is used.

Either the productId and variantId, or sku must be provided.

Specified by:

setVariantId in interface CartAddLineItemAction

Parameters:

variantId - value to be set

setSku

public void setSku(String sku)

Description copied from interface: CartAddLineItemAction

SKU of the ProductVariant.

Either the productId and variantId, or sku must be provided.

Specified by:

setSku in interface CartAddLineItemAction

Parameters:

sku - value to be set

setQuantity

public void setQuantity(Long quantity)

Description copied from interface: CartAddLineItemAction

Quantity of the Product Variant to add to the Cart.

Specified by:

setQuantity in interface CartAddLineItemAction

Parameters:

quantity - value to be set

setAddedAt

public void setAddedAt(ZonedDateTime addedAt)

Description copied from interface: CartAddLineItemAction

Date and time (UTC) the Product Variant is added to the Cart. If not set, it defaults to the current date and time.

Optional for backwards compatibility reasons.

Specified by:

setAddedAt in interface CartAddLineItemAction

Parameters:

addedAt - value to be set

setDistributionChannel

public void setDistributionChannel(ChannelResourceIdentifier distributionChannel)

Description copied from interface: CartAddLineItemAction

Used to select a Product Price. The Channel must have the ProductDistribution ChannelRoleEnum. If the Cart is bound to a Store with distributionChannels set, the Channel must match one of the Store's distribution channels.

Specified by:

setDistributionChannel in interface CartAddLineItemAction

Parameters:

distributionChannel - value to be set

setSupplyChannel

public void setSupplyChannel(ChannelResourceIdentifier supplyChannel)

Description copied from interface: CartAddLineItemAction

Used to identify Inventory entries that must be reserved. The Channel must have the InventorySupply ChannelRoleEnum.

Specified by:

setSupplyChannel in interface CartAddLineItemAction

Parameters:

supplyChannel - value to be set

setExternalPrice

public void setExternalPrice(Money externalPrice)

Description copied from interface: CartAddLineItemAction

Sets the LineItem price value, and the priceMode to ExternalPrice LineItemPriceMode.

Specified by:

setExternalPrice in interface CartAddLineItemAction

Parameters:

externalPrice - value to be set

setExternalTotalPrice

public void setExternalTotalPrice(ExternalLineItemTotalPrice externalTotalPrice)

Description copied from interface: CartAddLineItemAction

Sets the LineItem price and totalPrice values, and the priceMode to ExternalTotal LineItemPriceMode.

Specified by:

setExternalTotalPrice in interface CartAddLineItemAction

Parameters:

externalTotalPrice - value to be set

setExternalTaxRate

public void setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)

Description copied from interface: CartAddLineItemAction

External Tax Rate for the Line Item, if the Cart has the External TaxMode.

Specified by:

setExternalTaxRate in interface CartAddLineItemAction

Parameters:

externalTaxRate - value to be set

setInventoryMode

public void setInventoryMode(InventoryMode inventoryMode)

Description copied from interface: CartAddLineItemAction

Inventory mode specific to the Line Item only, and valid for the entire quantity of the Line Item. Set only if the inventory mode should be different from the inventoryMode specified on the Cart.

Specified by:

setInventoryMode in interface CartAddLineItemAction

Parameters:

inventoryMode - value to be set

setShippingDetails

public void setShippingDetails(ItemShippingDetailsDraft shippingDetails)

Description copied from interface: CartAddLineItemAction

Container for Line Item-specific addresses.

Specified by:

setShippingDetails in interface CartAddLineItemAction

Parameters:

shippingDetails - value to be set

setCustom

public void setCustom(CustomFieldsDraft custom)

Description copied from interface: CartAddLineItemAction

Custom Fields for the Line Item.

Specified by:

setCustom in interface CartAddLineItemAction

Specified by:

setCustom in interface CustomizableDraft<CartAddLineItemAction>

Parameters:

custom - value to be set

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object