Package com.commercetools.api.models.order_edit

Class StagedOrderAddLineItemActionBuilder

java.lang.Object

com.commercetools.api.models.order_edit.StagedOrderAddLineItemActionBuilder

All Implemented Interfaces:

Builder<StagedOrderAddLineItemAction>

public class StagedOrderAddLineItemActionBuilder
extends Object
implements Builder<StagedOrderAddLineItemAction>

StagedOrderAddLineItemActionBuilder Example to create an instance using the builder pattern

     StagedOrderAddLineItemAction stagedOrderAddLineItemAction = StagedOrderAddLineItemAction.builder()
             .build()
 

Constructor Summary

Constructors

Constructor	Description
StagedOrderAddLineItemActionBuilder()

Method Summary

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

StagedOrderAddLineItemActionBuilder

public StagedOrderAddLineItemActionBuilder()

Method Details

key

public StagedOrderAddLineItemActionBuilder key(@Nullable
 String key)

User-defined unique identifier of the LineItem.

Parameters:

key - value to be set

Returns:

Builder

productId

public StagedOrderAddLineItemActionBuilder 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 StagedOrderAddLineItemActionBuilder 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 StagedOrderAddLineItemActionBuilder 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 StagedOrderAddLineItemActionBuilder quantity(@Nullable
 Long quantity)

Quantity of the Product Variant to add to the Cart.

Parameters:

quantity - value to be set

Returns:

Builder

addedAt

public StagedOrderAddLineItemActionBuilder 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 StagedOrderAddLineItemActionBuilder 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 StagedOrderAddLineItemActionBuilder 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 StagedOrderAddLineItemActionBuilder 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 StagedOrderAddLineItemActionBuilder 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 StagedOrderAddLineItemActionBuilder 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 StagedOrderAddLineItemActionBuilder 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 StagedOrderAddLineItemActionBuilder 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 StagedOrderAddLineItemActionBuilder 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 StagedOrderAddLineItemActionBuilder 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 StagedOrderAddLineItemActionBuilder 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 StagedOrderAddLineItemActionBuilder 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 StagedOrderAddLineItemActionBuilder 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 StagedOrderAddLineItemActionBuilder externalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraftBuilder> builder)

Sets the external Tax Rate for the Line Item, if the Cart has the External TaxMode. 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 StagedOrderAddLineItemActionBuilder withExternalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraft> builder)

Sets the external Tax Rate for the Line Item, if the Cart has the External TaxMode. 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 StagedOrderAddLineItemActionBuilder externalTaxRate(@Nullable
 ExternalTaxRateDraft externalTaxRate)

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

Parameters:

externalTaxRate - value to be set

Returns:

Builder

inventoryMode

public StagedOrderAddLineItemActionBuilder 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 StagedOrderAddLineItemActionBuilder shippingDetails(Function<ItemShippingDetailsDraftBuilder,ItemShippingDetailsDraftBuilder> builder)

Container for Line Item-specific addresses.

Parameters:

builder - function to build the shippingDetails value

Returns:

Builder

withShippingDetails

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

Container for Line Item-specific addresses.

Parameters:

builder - function to build the shippingDetails value

Returns:

Builder

shippingDetails

public StagedOrderAddLineItemActionBuilder shippingDetails(@Nullable
 ItemShippingDetailsDraft shippingDetails)

Container for Line Item-specific addresses.

Parameters:

shippingDetails - value to be set

Returns:

Builder

custom

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

Custom Fields for the Line Item.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

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

Custom Fields for the Line Item.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public StagedOrderAddLineItemActionBuilder 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. If the Cart has Multiple ShippingMode, the Tax Rate is accepted but ignored.

Returns:

externalTaxRate

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 StagedOrderAddLineItemAction build()

builds StagedOrderAddLineItemAction with checking for non-null required values

Specified by:

build in interface Builder<StagedOrderAddLineItemAction>

Returns:

StagedOrderAddLineItemAction

buildUnchecked

public StagedOrderAddLineItemAction buildUnchecked()

builds StagedOrderAddLineItemAction without checking for non-null required values

Returns:

StagedOrderAddLineItemAction

of

public static StagedOrderAddLineItemActionBuilder of()

factory method for an instance of StagedOrderAddLineItemActionBuilder

Returns:

builder

of

public static StagedOrderAddLineItemActionBuilder of(StagedOrderAddLineItemAction template)

create builder for StagedOrderAddLineItemAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder