Package com.commercetools.api.models.cart

Class CartAddLineItemActionBuilder

java.lang.Object

com.commercetools.api.models.cart.CartAddLineItemActionBuilder

All Implemented Interfaces:

Builder<CartAddLineItemAction>

public class CartAddLineItemActionBuilder
extends Object
implements Builder<CartAddLineItemAction>

CartAddLineItemActionBuilder Example to create an instance using the builder pattern

     CartAddLineItemAction cartAddLineItemAction = CartAddLineItemAction.builder()
             .build()
 

Constructor Summary

Constructors

Constructor	Description
CartAddLineItemActionBuilder()

Method Summary

Modifier and Type	Method	Description
CartAddLineItemActionBuilder	addedAt(ZonedDateTime addedAt)	Date and time (UTC) the Product Variant is added to the Cart.
CartAddLineItemActionBuilder	addPerMethodExternalTaxRate(Function<MethodExternalTaxRateDraftBuilder,MethodExternalTaxRateDraft> builder)	Sets the external Tax Rates for individual Shipping Methods, if the Cart has the External TaxMode and Multiple ShippingMode.
CartAddLineItemAction	build()	builds CartAddLineItemAction with checking for non-null required values
CartAddLineItemAction	buildUnchecked()	builds CartAddLineItemAction without checking for non-null required values
CartAddLineItemActionBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the Line Item.
CartAddLineItemActionBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the Line Item.
CartAddLineItemActionBuilder	distributionChannel(ChannelResourceIdentifier distributionChannel)	Used to select a Product Price.
CartAddLineItemActionBuilder	distributionChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifierBuilder> builder)	Used to select a Product Price.
CartAddLineItemActionBuilder	externalPrice(Money externalPrice)	Sets the LineItem price value, and the priceMode to ExternalPrice LineItemPriceMode.
CartAddLineItemActionBuilder	externalPrice(Function<MoneyBuilder,MoneyBuilder> builder)	Sets the LineItem price value, and the priceMode to ExternalPrice LineItemPriceMode.
CartAddLineItemActionBuilder	externalTaxRate(ExternalTaxRateDraft externalTaxRate)	Sets the external Tax Rate for the Line Item, if the Cart has the External TaxMode and Single ShippingMode.
CartAddLineItemActionBuilder	externalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraftBuilder> builder)	Sets the external Tax Rate for the Line Item, if the Cart has the External TaxMode and Single ShippingMode.
CartAddLineItemActionBuilder	externalTotalPrice(ExternalLineItemTotalPrice externalTotalPrice)	Sets the LineItem price and totalPrice values, and the priceMode to ExternalTotal LineItemPriceMode.
CartAddLineItemActionBuilder	externalTotalPrice(Function<ExternalLineItemTotalPriceBuilder,ExternalLineItemTotalPriceBuilder> builder)	Sets the LineItem price and totalPrice values, and the priceMode to ExternalTotal LineItemPriceMode.
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()	Sets the external Tax Rate for the Line Item, if the Cart has the External TaxMode and Single ShippingMode.
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.
List<MethodExternalTaxRateDraft>	getPerMethodExternalTaxRate()	Sets the external Tax Rates for individual Shipping Methods, if the Cart has the External TaxMode and Multiple ShippingMode.
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.
CartAddLineItemActionBuilder	inventoryMode(InventoryMode inventoryMode)	Inventory mode specific to the Line Item only, and valid for the entire quantity of the Line Item.
CartAddLineItemActionBuilder	key(String key)	User-defined unique identifier of the LineItem.
static CartAddLineItemActionBuilder	of()	factory method for an instance of CartAddLineItemActionBuilder
static CartAddLineItemActionBuilder	of(CartAddLineItemAction template)	create builder for CartAddLineItemAction instance
CartAddLineItemActionBuilder	perMethodExternalTaxRate(MethodExternalTaxRateDraft... perMethodExternalTaxRate)	Sets the external Tax Rates for individual Shipping Methods, if the Cart has the External TaxMode and Multiple ShippingMode.
CartAddLineItemActionBuilder	perMethodExternalTaxRate(List<MethodExternalTaxRateDraft> perMethodExternalTaxRate)	Sets the external Tax Rates for individual Shipping Methods, if the Cart has the External TaxMode and Multiple ShippingMode.
CartAddLineItemActionBuilder	plusPerMethodExternalTaxRate(MethodExternalTaxRateDraft... perMethodExternalTaxRate)	Sets the external Tax Rates for individual Shipping Methods, if the Cart has the External TaxMode and Multiple ShippingMode.
CartAddLineItemActionBuilder	plusPerMethodExternalTaxRate(Function<MethodExternalTaxRateDraftBuilder,MethodExternalTaxRateDraftBuilder> builder)	Sets the external Tax Rates for individual Shipping Methods, if the Cart has the External TaxMode and Multiple ShippingMode.
CartAddLineItemActionBuilder	productId(String productId)	id of the published Product.
CartAddLineItemActionBuilder	quantity(Long quantity)	Quantity of the Product Variant to add to the Cart.
CartAddLineItemActionBuilder	setPerMethodExternalTaxRate(Function<MethodExternalTaxRateDraftBuilder,MethodExternalTaxRateDraft> builder)	Sets the external Tax Rates for individual Shipping Methods, if the Cart has the External TaxMode and Multiple ShippingMode.
CartAddLineItemActionBuilder	shippingDetails(ItemShippingDetailsDraft shippingDetails)	Container for Line Item-specific addresses.
CartAddLineItemActionBuilder	shippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraftBuilder> builder)	Container for Line Item-specific addresses.
CartAddLineItemActionBuilder	sku(String sku)	SKU of the ProductVariant.
CartAddLineItemActionBuilder	supplyChannel(ChannelResourceIdentifier supplyChannel)	Used to identify Inventory entries that must be reserved.
CartAddLineItemActionBuilder	supplyChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifierBuilder> builder)	Used to identify Inventory entries that must be reserved.
CartAddLineItemActionBuilder	variantId(Long variantId)	id of the ProductVariant in the Product.
CartAddLineItemActionBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the Line Item.
CartAddLineItemActionBuilder	withDistributionChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifier> builder)	Used to select a Product Price.
CartAddLineItemActionBuilder	withExternalPrice(Function<MoneyBuilder,Money> builder)	Sets the LineItem price value, and the priceMode to ExternalPrice LineItemPriceMode.
CartAddLineItemActionBuilder	withExternalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraft> builder)	Sets the external Tax Rate for the Line Item, if the Cart has the External TaxMode and Single ShippingMode.
CartAddLineItemActionBuilder	withExternalTotalPrice(Function<ExternalLineItemTotalPriceBuilder,ExternalLineItemTotalPrice> builder)	Sets the LineItem price and totalPrice values, and the priceMode to ExternalTotal LineItemPriceMode.
CartAddLineItemActionBuilder	withPerMethodExternalTaxRate(Function<MethodExternalTaxRateDraftBuilder,MethodExternalTaxRateDraftBuilder> builder)	Sets the external Tax Rates for individual Shipping Methods, if the Cart has the External TaxMode and Multiple ShippingMode.
CartAddLineItemActionBuilder	withShippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraft> builder)	Container for Line Item-specific addresses.
CartAddLineItemActionBuilder	withSupplyChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifier> builder)	Used to identify Inventory entries that must be reserved.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CartAddLineItemActionBuilder

public CartAddLineItemActionBuilder()

Method Details

key

public CartAddLineItemActionBuilder key(@Nullable
 String key)

User-defined unique identifier of the LineItem.

Parameters:

key - value to be set

Returns:

Builder

productId

public CartAddLineItemActionBuilder productId(@Nullable
 String productId)

id of the published Product.

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

Parameters:

productId - value to be set

Returns:

Builder

variantId

public CartAddLineItemActionBuilder variantId(@Nullable
 Long variantId)

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.

Parameters:

variantId - value to be set

Returns:

Builder

sku

public CartAddLineItemActionBuilder sku(@Nullable
 String sku)

SKU of the ProductVariant.

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

Parameters:

sku - value to be set

Returns:

Builder

quantity

public CartAddLineItemActionBuilder quantity(@Nullable
 Long quantity)

Quantity of the Product Variant to add to the Cart.

Parameters:

quantity - value to be set

Returns:

Builder

addedAt

public CartAddLineItemActionBuilder addedAt(@Nullable
 ZonedDateTime addedAt)

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.

Parameters:

addedAt - value to be set

Returns:

Builder

distributionChannel

public CartAddLineItemActionBuilder distributionChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifierBuilder> builder)

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.

Parameters:

builder - function to build the distributionChannel value

Returns:

Builder

withDistributionChannel

public CartAddLineItemActionBuilder withDistributionChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifier> builder)

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.

Parameters:

builder - function to build the distributionChannel value

Returns:

Builder

distributionChannel

public CartAddLineItemActionBuilder distributionChannel(@Nullable
 ChannelResourceIdentifier distributionChannel)

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.

Parameters:

distributionChannel - value to be set

Returns:

Builder

supplyChannel

public CartAddLineItemActionBuilder supplyChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifierBuilder> builder)

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

Parameters:

builder - function to build the supplyChannel value

Returns:

Builder

withSupplyChannel

public CartAddLineItemActionBuilder withSupplyChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifier> builder)

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

Parameters:

builder - function to build the supplyChannel value

Returns:

Builder

supplyChannel

public CartAddLineItemActionBuilder supplyChannel(@Nullable
 ChannelResourceIdentifier supplyChannel)

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

Parameters:

supplyChannel - value to be set

Returns:

Builder

externalPrice

public CartAddLineItemActionBuilder externalPrice(Function<MoneyBuilder,MoneyBuilder> builder)

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

Parameters:

builder - function to build the externalPrice value

Returns:

Builder

withExternalPrice

public CartAddLineItemActionBuilder withExternalPrice(Function<MoneyBuilder,Money> builder)

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

Parameters:

builder - function to build the externalPrice value

Returns:

Builder

externalPrice

public CartAddLineItemActionBuilder externalPrice(@Nullable
 Money externalPrice)

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

Parameters:

externalPrice - value to be set

Returns:

Builder

externalTotalPrice

public CartAddLineItemActionBuilder externalTotalPrice(Function<ExternalLineItemTotalPriceBuilder,ExternalLineItemTotalPriceBuilder> builder)

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

Parameters:

builder - function to build the externalTotalPrice value

Returns:

Builder

withExternalTotalPrice

public CartAddLineItemActionBuilder withExternalTotalPrice(Function<ExternalLineItemTotalPriceBuilder,ExternalLineItemTotalPrice> builder)

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

Parameters:

builder - function to build the externalTotalPrice value

Returns:

Builder

externalTotalPrice

public CartAddLineItemActionBuilder externalTotalPrice(@Nullable
 ExternalLineItemTotalPrice externalTotalPrice)

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

Parameters:

externalTotalPrice - value to be set

Returns:

Builder

externalTaxRate

public CartAddLineItemActionBuilder externalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraftBuilder> builder)

Sets the external Tax Rate for the Line Item, if the Cart has the External TaxMode and Single ShippingMode. If the Cart has Multiple ShippingMode, the Tax Rate is accepted but ignored.

Parameters:

builder - function to build the externalTaxRate value

Returns:

Builder

withExternalTaxRate

public CartAddLineItemActionBuilder withExternalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraft> builder)

Sets the external Tax Rate for the Line Item, if the Cart has the External TaxMode and Single ShippingMode. If the Cart has Multiple ShippingMode, the Tax Rate is accepted but ignored.

Parameters:

builder - function to build the externalTaxRate value

Returns:

Builder

externalTaxRate

public CartAddLineItemActionBuilder externalTaxRate(@Nullable
 ExternalTaxRateDraft externalTaxRate)

Sets the external Tax Rate for the Line Item, if the Cart has the External TaxMode and Single ShippingMode. If the Cart has Multiple ShippingMode, the Tax Rate is accepted but ignored.

Parameters:

externalTaxRate - value to be set

Returns:

Builder

perMethodExternalTaxRate

public CartAddLineItemActionBuilder perMethodExternalTaxRate(@Nullable
 MethodExternalTaxRateDraft... perMethodExternalTaxRate)

Sets the external Tax Rates for individual Shipping Methods, if the Cart has the External TaxMode and Multiple ShippingMode.

Parameters:

perMethodExternalTaxRate - value to be set

Returns:

Builder

perMethodExternalTaxRate

public CartAddLineItemActionBuilder perMethodExternalTaxRate(@Nullable
 List<MethodExternalTaxRateDraft> perMethodExternalTaxRate)

Sets the external Tax Rates for individual Shipping Methods, if the Cart has the External TaxMode and Multiple ShippingMode.

Parameters:

perMethodExternalTaxRate - value to be set

Returns:

Builder

plusPerMethodExternalTaxRate

public CartAddLineItemActionBuilder plusPerMethodExternalTaxRate(@Nullable
 MethodExternalTaxRateDraft... perMethodExternalTaxRate)

Sets the external Tax Rates for individual Shipping Methods, if the Cart has the External TaxMode and Multiple ShippingMode.

Parameters:

perMethodExternalTaxRate - value to be set

Returns:

Builder

plusPerMethodExternalTaxRate

public CartAddLineItemActionBuilder plusPerMethodExternalTaxRate(Function<MethodExternalTaxRateDraftBuilder,MethodExternalTaxRateDraftBuilder> builder)

Sets the external Tax Rates for individual Shipping Methods, if the Cart has the External TaxMode and Multiple ShippingMode.

Parameters:

builder - function to build the perMethodExternalTaxRate value

Returns:

Builder

withPerMethodExternalTaxRate

public CartAddLineItemActionBuilder withPerMethodExternalTaxRate(Function<MethodExternalTaxRateDraftBuilder,MethodExternalTaxRateDraftBuilder> builder)

Sets the external Tax Rates for individual Shipping Methods, if the Cart has the External TaxMode and Multiple ShippingMode.

Parameters:

builder - function to build the perMethodExternalTaxRate value

Returns:

Builder

addPerMethodExternalTaxRate

public CartAddLineItemActionBuilder addPerMethodExternalTaxRate(Function<MethodExternalTaxRateDraftBuilder,MethodExternalTaxRateDraft> builder)

Sets the external Tax Rates for individual Shipping Methods, if the Cart has the External TaxMode and Multiple ShippingMode.

Parameters:

builder - function to build the perMethodExternalTaxRate value

Returns:

Builder

setPerMethodExternalTaxRate

public CartAddLineItemActionBuilder setPerMethodExternalTaxRate(Function<MethodExternalTaxRateDraftBuilder,MethodExternalTaxRateDraft> builder)

Sets the external Tax Rates for individual Shipping Methods, if the Cart has the External TaxMode and Multiple ShippingMode.

Parameters:

builder - function to build the perMethodExternalTaxRate value

Returns:

Builder

inventoryMode

public CartAddLineItemActionBuilder inventoryMode(@Nullable
 InventoryMode inventoryMode)

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.

Parameters:

inventoryMode - value to be set

Returns:

Builder

shippingDetails

public CartAddLineItemActionBuilder shippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraftBuilder> builder)

Container for Line Item-specific addresses.

Parameters:

builder - function to build the shippingDetails value

Returns:

Builder

withShippingDetails

public CartAddLineItemActionBuilder withShippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraft> builder)

Container for Line Item-specific addresses.

Parameters:

builder - function to build the shippingDetails value

Returns:

Builder

shippingDetails

public CartAddLineItemActionBuilder shippingDetails(@Nullable
 ItemShippingDetailsDraft shippingDetails)

Container for Line Item-specific addresses.

Parameters:

shippingDetails - value to be set

Returns:

Builder

custom

public CartAddLineItemActionBuilder custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)

Custom Fields for the Line Item.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

public CartAddLineItemActionBuilder withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)

Custom Fields for the Line Item.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public CartAddLineItemActionBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the Line Item.

Parameters:

custom - value to be set

Returns:

Builder

getKey

@Nullable
public String getKey()

User-defined unique identifier of the LineItem.

Returns:

key

getProductId

@Nullable
public String getProductId()

id of the published Product.

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

Returns:

productId

getVariantId

@Nullable
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.

Returns:

variantId

getSku

@Nullable
public String getSku()

SKU of the ProductVariant.

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

Returns:

sku

getQuantity

@Nullable
public Long getQuantity()

Quantity of the Product Variant to add to the Cart.

Returns:

quantity

getAddedAt

@Nullable
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.

Returns:

addedAt

getDistributionChannel

@Nullable
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.

Returns:

distributionChannel

getSupplyChannel

@Nullable
public ChannelResourceIdentifier getSupplyChannel()

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

Returns:

supplyChannel

getExternalPrice

@Nullable
public Money getExternalPrice()

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

Returns:

externalPrice

getExternalTotalPrice

@Nullable
public ExternalLineItemTotalPrice getExternalTotalPrice()

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

Returns:

externalTotalPrice

getExternalTaxRate

@Nullable
public ExternalTaxRateDraft getExternalTaxRate()

Sets the external Tax Rate for the Line Item, if the Cart has the External TaxMode and Single ShippingMode. If the Cart has Multiple ShippingMode, the Tax Rate is accepted but ignored.

Returns:

externalTaxRate

getPerMethodExternalTaxRate

@Nullable
public List<MethodExternalTaxRateDraft> getPerMethodExternalTaxRate()

Sets the external Tax Rates for individual Shipping Methods, if the Cart has the External TaxMode and Multiple ShippingMode.

Returns:

perMethodExternalTaxRate

getInventoryMode

@Nullable
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.

Returns:

inventoryMode

getShippingDetails

@Nullable
public ItemShippingDetailsDraft getShippingDetails()

Container for Line Item-specific addresses.

Returns:

shippingDetails

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields for the Line Item.

Returns:

custom

build

public CartAddLineItemAction build()

builds CartAddLineItemAction with checking for non-null required values

Specified by:

build in interface Builder<CartAddLineItemAction>

Returns:

CartAddLineItemAction

buildUnchecked

public CartAddLineItemAction buildUnchecked()

builds CartAddLineItemAction without checking for non-null required values

Returns:

CartAddLineItemAction

of

public static CartAddLineItemActionBuilder of()

factory method for an instance of CartAddLineItemActionBuilder

Returns:

builder

of

public static CartAddLineItemActionBuilder of(CartAddLineItemAction template)

create builder for CartAddLineItemAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder