Package com.commercetools.api.models.cart

Class CartAddCustomShippingMethodActionBuilder

java.lang.Object

com.commercetools.api.models.cart.CartAddCustomShippingMethodActionBuilder

All Implemented Interfaces:

Builder<CartAddCustomShippingMethodAction>

public class CartAddCustomShippingMethodActionBuilder
extends Object
implements Builder<CartAddCustomShippingMethodAction>

CartAddCustomShippingMethodActionBuilder Example to create an instance using the builder pattern

     CartAddCustomShippingMethodAction cartAddCustomShippingMethodAction = CartAddCustomShippingMethodAction.builder()
             .shippingKey("{shippingKey}")
             .shippingMethodName("{shippingMethodName}")
             .shippingAddress(shippingAddressBuilder -> shippingAddressBuilder)
             .shippingRate(shippingRateBuilder -> shippingRateBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
CartAddCustomShippingMethodActionBuilder()

Method Summary

Modifier and Type	Method	Description
CartAddCustomShippingMethodActionBuilder	addDeliveries(Function<DeliveryDraftBuilder,DeliveryDraft> builder)	Deliveries to be shipped with the custom Shipping Method.
CartAddCustomShippingMethodAction	build()	builds CartAddCustomShippingMethodAction with checking for non-null required values
CartAddCustomShippingMethodAction	buildUnchecked()	builds CartAddCustomShippingMethodAction without checking for non-null required values
CartAddCustomShippingMethodActionBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the custom Shipping Method.
CartAddCustomShippingMethodActionBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the custom Shipping Method.
CartAddCustomShippingMethodActionBuilder	deliveries(DeliveryDraft... deliveries)	Deliveries to be shipped with the custom Shipping Method.
CartAddCustomShippingMethodActionBuilder	deliveries(List<DeliveryDraft> deliveries)	Deliveries to be shipped with the custom Shipping Method.
CartAddCustomShippingMethodActionBuilder	externalTaxRate(ExternalTaxRateDraft externalTaxRate)	Tax Rate used to tax a shipping expense if the Cart has the External TaxMode.
CartAddCustomShippingMethodActionBuilder	externalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraftBuilder> builder)	Tax Rate used to tax a shipping expense if the Cart has the External TaxMode.
CustomFieldsDraft	getCustom()	Custom Fields for the custom Shipping Method.
List<DeliveryDraft>	getDeliveries()	Deliveries to be shipped with the custom Shipping Method.
ExternalTaxRateDraft	getExternalTaxRate()	Tax Rate used to tax a shipping expense if the Cart has the External TaxMode.
BaseAddress	getShippingAddress()	Determines the shipping rate and Tax Rate of the associated Line Items.
String	getShippingKey()	User-defined identifier for the custom Shipping Method that must be unique across the Cart with Multiple ShippingMode.
String	getShippingMethodName()	Name of the custom Shipping Method.
ShippingRateDraft	getShippingRate()	Determines the shipping price.
ShippingRateInputDraft	getShippingRateInput()	Input used to select a ShippingRatePriceTier.
TaxCategoryResourceIdentifier	getTaxCategory()	Tax Category used to determine a shipping Tax Rate if the Cart has the Platform TaxMode.
static CartAddCustomShippingMethodActionBuilder	of()	factory method for an instance of CartAddCustomShippingMethodActionBuilder
static CartAddCustomShippingMethodActionBuilder	of(CartAddCustomShippingMethodAction template)	create builder for CartAddCustomShippingMethodAction instance
CartAddCustomShippingMethodActionBuilder	plusDeliveries(DeliveryDraft... deliveries)	Deliveries to be shipped with the custom Shipping Method.
CartAddCustomShippingMethodActionBuilder	plusDeliveries(Function<DeliveryDraftBuilder,DeliveryDraftBuilder> builder)	Deliveries to be shipped with the custom Shipping Method.
CartAddCustomShippingMethodActionBuilder	setDeliveries(Function<DeliveryDraftBuilder,DeliveryDraft> builder)	Deliveries to be shipped with the custom Shipping Method.
CartAddCustomShippingMethodActionBuilder	shippingAddress(BaseAddress shippingAddress)	Determines the shipping rate and Tax Rate of the associated Line Items.
CartAddCustomShippingMethodActionBuilder	shippingAddress(Function<BaseAddressBuilder,BaseAddressBuilder> builder)	Determines the shipping rate and Tax Rate of the associated Line Items.
CartAddCustomShippingMethodActionBuilder	shippingKey(String shippingKey)	User-defined identifier for the custom Shipping Method that must be unique across the Cart with Multiple ShippingMode.
CartAddCustomShippingMethodActionBuilder	shippingMethodName(String shippingMethodName)	Name of the custom Shipping Method.
CartAddCustomShippingMethodActionBuilder	shippingRate(ShippingRateDraft shippingRate)	Determines the shipping price.
CartAddCustomShippingMethodActionBuilder	shippingRate(Function<ShippingRateDraftBuilder,ShippingRateDraftBuilder> builder)	Determines the shipping price.
CartAddCustomShippingMethodActionBuilder	shippingRateInput(ShippingRateInputDraft shippingRateInput)	Input used to select a ShippingRatePriceTier.
CartAddCustomShippingMethodActionBuilder	shippingRateInput(Function<ShippingRateInputDraftBuilder,Builder<? extends ShippingRateInputDraft>> builder)	Input used to select a ShippingRatePriceTier.
CartAddCustomShippingMethodActionBuilder	taxCategory(TaxCategoryResourceIdentifier taxCategory)	Tax Category used to determine a shipping Tax Rate if the Cart has the Platform TaxMode.
CartAddCustomShippingMethodActionBuilder	taxCategory(Function<TaxCategoryResourceIdentifierBuilder,TaxCategoryResourceIdentifierBuilder> builder)	Tax Category used to determine a shipping Tax Rate if the Cart has the Platform TaxMode.
CartAddCustomShippingMethodActionBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the custom Shipping Method.
CartAddCustomShippingMethodActionBuilder	withDeliveries(Function<DeliveryDraftBuilder,DeliveryDraftBuilder> builder)	Deliveries to be shipped with the custom Shipping Method.
CartAddCustomShippingMethodActionBuilder	withExternalTaxRate(Function<ExternalTaxRateDraftBuilder,ExternalTaxRateDraft> builder)	Tax Rate used to tax a shipping expense if the Cart has the External TaxMode.
CartAddCustomShippingMethodActionBuilder	withShippingAddress(Function<BaseAddressBuilder,BaseAddress> builder)	Determines the shipping rate and Tax Rate of the associated Line Items.
CartAddCustomShippingMethodActionBuilder	withShippingRate(Function<ShippingRateDraftBuilder,ShippingRateDraft> builder)	Determines the shipping price.
CartAddCustomShippingMethodActionBuilder	withTaxCategory(Function<TaxCategoryResourceIdentifierBuilder,TaxCategoryResourceIdentifier> builder)	Tax Category used to determine a shipping Tax Rate if the Cart has the Platform TaxMode.

Methods inherited from class java.lang.Object

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

Constructor Details

CartAddCustomShippingMethodActionBuilder

public CartAddCustomShippingMethodActionBuilder()

Method Details

shippingKey

public CartAddCustomShippingMethodActionBuilder shippingKey(String shippingKey)

User-defined identifier for the custom Shipping Method that must be unique across the Cart with Multiple ShippingMode.

Parameters:

shippingKey - value to be set

Returns:

Builder

shippingMethodName

public CartAddCustomShippingMethodActionBuilder shippingMethodName(String shippingMethodName)

Name of the custom Shipping Method.

Parameters:

shippingMethodName - value to be set

Returns:

Builder

shippingAddress

public CartAddCustomShippingMethodActionBuilder shippingAddress(Function<BaseAddressBuilder,BaseAddressBuilder> builder)

Determines the shipping rate and Tax Rate of the associated Line Items.

Parameters:

builder - function to build the shippingAddress value

Returns:

Builder

withShippingAddress

public CartAddCustomShippingMethodActionBuilder withShippingAddress(Function<BaseAddressBuilder,BaseAddress> builder)

Determines the shipping rate and Tax Rate of the associated Line Items.

Parameters:

builder - function to build the shippingAddress value

Returns:

Builder

shippingAddress

public CartAddCustomShippingMethodActionBuilder shippingAddress(BaseAddress shippingAddress)

Determines the shipping rate and Tax Rate of the associated Line Items.

Parameters:

shippingAddress - value to be set

Returns:

Builder

shippingRate

public CartAddCustomShippingMethodActionBuilder shippingRate(Function<ShippingRateDraftBuilder,ShippingRateDraftBuilder> builder)

Determines the shipping price.

Parameters:

builder - function to build the shippingRate value

Returns:

Builder

withShippingRate

public CartAddCustomShippingMethodActionBuilder withShippingRate(Function<ShippingRateDraftBuilder,ShippingRateDraft> builder)

Determines the shipping price.

Parameters:

builder - function to build the shippingRate value

Returns:

Builder

shippingRate

public CartAddCustomShippingMethodActionBuilder shippingRate(ShippingRateDraft shippingRate)

Determines the shipping price.

Parameters:

shippingRate - value to be set

Returns:

Builder

shippingRateInput

public CartAddCustomShippingMethodActionBuilder shippingRateInput(@Nullable
 ShippingRateInputDraft shippingRateInput)

Input used to select a ShippingRatePriceTier. The data type of this field depends on the shippingRateInputType.type configured in the Project:

• If CartClassification, it must be ClassificationShippingRateInputDraft.
• If CartScore, it must be ScoreShippingRateInputDraft.
• If CartValue, it cannot be set.

Parameters:

shippingRateInput - value to be set

Returns:

Builder

shippingRateInput

public CartAddCustomShippingMethodActionBuilder shippingRateInput(Function<ShippingRateInputDraftBuilder,Builder<? extends ShippingRateInputDraft>> builder)

Input used to select a ShippingRatePriceTier. The data type of this field depends on the shippingRateInputType.type configured in the Project:

• If CartClassification, it must be ClassificationShippingRateInputDraft.
• If CartScore, it must be ScoreShippingRateInputDraft.
• If CartValue, it cannot be set.

Parameters:

builder - function to build the shippingRateInput value

Returns:

Builder

taxCategory

public CartAddCustomShippingMethodActionBuilder taxCategory(Function<TaxCategoryResourceIdentifierBuilder,TaxCategoryResourceIdentifierBuilder> builder)

Tax Category used to determine a shipping Tax Rate if the Cart has the Platform TaxMode.

Parameters:

builder - function to build the taxCategory value

Returns:

Builder

withTaxCategory

public CartAddCustomShippingMethodActionBuilder withTaxCategory(Function<TaxCategoryResourceIdentifierBuilder,TaxCategoryResourceIdentifier> builder)

Tax Category used to determine a shipping Tax Rate if the Cart has the Platform TaxMode.

Parameters:

builder - function to build the taxCategory value

Returns:

Builder

taxCategory

public CartAddCustomShippingMethodActionBuilder taxCategory(@Nullable
 TaxCategoryResourceIdentifier taxCategory)

Tax Category used to determine a shipping Tax Rate if the Cart has the Platform TaxMode.

Parameters:

taxCategory - value to be set

Returns:

Builder

externalTaxRate

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

Tax Rate used to tax a shipping expense if the Cart has the External TaxMode.

Parameters:

builder - function to build the externalTaxRate value

Returns:

Builder

withExternalTaxRate

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

Tax Rate used to tax a shipping expense if the Cart has the External TaxMode.

Parameters:

builder - function to build the externalTaxRate value

Returns:

Builder

externalTaxRate

public CartAddCustomShippingMethodActionBuilder externalTaxRate(@Nullable
 ExternalTaxRateDraft externalTaxRate)

Tax Rate used to tax a shipping expense if the Cart has the External TaxMode.

Parameters:

externalTaxRate - value to be set

Returns:

Builder

deliveries

public CartAddCustomShippingMethodActionBuilder deliveries(@Nullable
 DeliveryDraft... deliveries)

Deliveries to be shipped with the custom Shipping Method.

Parameters:

deliveries - value to be set

Returns:

Builder

deliveries

public CartAddCustomShippingMethodActionBuilder deliveries(@Nullable
 List<DeliveryDraft> deliveries)

Deliveries to be shipped with the custom Shipping Method.

Parameters:

deliveries - value to be set

Returns:

Builder

plusDeliveries

public CartAddCustomShippingMethodActionBuilder plusDeliveries(@Nullable
 DeliveryDraft... deliveries)

Deliveries to be shipped with the custom Shipping Method.

Parameters:

deliveries - value to be set

Returns:

Builder

plusDeliveries

public CartAddCustomShippingMethodActionBuilder plusDeliveries(Function<DeliveryDraftBuilder,DeliveryDraftBuilder> builder)

Deliveries to be shipped with the custom Shipping Method.

Parameters:

builder - function to build the deliveries value

Returns:

Builder

withDeliveries

public CartAddCustomShippingMethodActionBuilder withDeliveries(Function<DeliveryDraftBuilder,DeliveryDraftBuilder> builder)

Deliveries to be shipped with the custom Shipping Method.

Parameters:

builder - function to build the deliveries value

Returns:

Builder

addDeliveries

public CartAddCustomShippingMethodActionBuilder addDeliveries(Function<DeliveryDraftBuilder,DeliveryDraft> builder)

Deliveries to be shipped with the custom Shipping Method.

Parameters:

builder - function to build the deliveries value

Returns:

Builder

setDeliveries

public CartAddCustomShippingMethodActionBuilder setDeliveries(Function<DeliveryDraftBuilder,DeliveryDraft> builder)

Deliveries to be shipped with the custom Shipping Method.

Parameters:

builder - function to build the deliveries value

Returns:

Builder

custom

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

Custom Fields for the custom Shipping Method.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

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

Custom Fields for the custom Shipping Method.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public CartAddCustomShippingMethodActionBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the custom Shipping Method.

Parameters:

custom - value to be set

Returns:

Builder

getShippingKey

public String getShippingKey()

User-defined identifier for the custom Shipping Method that must be unique across the Cart with Multiple ShippingMode.

Returns:

shippingKey

getShippingMethodName

public String getShippingMethodName()

Name of the custom Shipping Method.

Returns:

shippingMethodName

getShippingAddress

public BaseAddress getShippingAddress()

Determines the shipping rate and Tax Rate of the associated Line Items.

Returns:

shippingAddress

getShippingRate

public ShippingRateDraft getShippingRate()

Determines the shipping price.

Returns:

shippingRate

getShippingRateInput

@Nullable
public ShippingRateInputDraft getShippingRateInput()

Input used to select a ShippingRatePriceTier. The data type of this field depends on the shippingRateInputType.type configured in the Project:

• If CartClassification, it must be ClassificationShippingRateInputDraft.
• If CartScore, it must be ScoreShippingRateInputDraft.
• If CartValue, it cannot be set.

Returns:

shippingRateInput

getTaxCategory

@Nullable
public TaxCategoryResourceIdentifier getTaxCategory()

Tax Category used to determine a shipping Tax Rate if the Cart has the Platform TaxMode.

Returns:

taxCategory

getExternalTaxRate

@Nullable
public ExternalTaxRateDraft getExternalTaxRate()

Tax Rate used to tax a shipping expense if the Cart has the External TaxMode.

Returns:

externalTaxRate

getDeliveries

@Nullable
public List<DeliveryDraft> getDeliveries()

Deliveries to be shipped with the custom Shipping Method.

Returns:

deliveries

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields for the custom Shipping Method.

Returns:

custom

build

public CartAddCustomShippingMethodAction build()

builds CartAddCustomShippingMethodAction with checking for non-null required values

Specified by:

build in interface Builder<CartAddCustomShippingMethodAction>

Returns:

CartAddCustomShippingMethodAction

buildUnchecked

public CartAddCustomShippingMethodAction buildUnchecked()

builds CartAddCustomShippingMethodAction without checking for non-null required values

Returns:

CartAddCustomShippingMethodAction

of

public static CartAddCustomShippingMethodActionBuilder of()

factory method for an instance of CartAddCustomShippingMethodActionBuilder

Returns:

builder

of

public static CartAddCustomShippingMethodActionBuilder of(CartAddCustomShippingMethodAction template)

create builder for CartAddCustomShippingMethodAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder