Package com.commercetools.api.models.cart

Interface CartSetShippingMethodTaxRateAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

public interface CartSetShippingMethodTaxRateAction
extends CartUpdateAction

A Shipping Method Tax Rate can be set if the Cart has the External TaxMode.

Example to create an instance using the builder pattern

     CartSetShippingMethodTaxRateAction cartSetShippingMethodTaxRateAction = CartSetShippingMethodTaxRateAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_SHIPPING_METHOD_TAX_RATE	discriminator value for CartSetShippingMethodTaxRateAction

Method Summary

Modifier and Type	Method	Description
static CartSetShippingMethodTaxRateActionBuilder	builder()	builder factory method for CartSetShippingMethodTaxRateAction
static CartSetShippingMethodTaxRateActionBuilder	builder(CartSetShippingMethodTaxRateAction template)	create builder for CartSetShippingMethodTaxRateAction instance
CartSetShippingMethodTaxRateAction	copyDeep()
static CartSetShippingMethodTaxRateAction	deepCopy(CartSetShippingMethodTaxRateAction template)	factory method to create a deep copy of CartSetShippingMethodTaxRateAction
@Valid ExternalTaxRateDraft	getExternalTaxRate()	Value to set.
String	getShippingKey()	key of the ShippingMethod to update.
static CartSetShippingMethodTaxRateAction	of()	factory method
static CartSetShippingMethodTaxRateAction	of(CartSetShippingMethodTaxRateAction template)	factory method to create a shallow copy CartSetShippingMethodTaxRateAction
void	setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)	Value to set.
void	setShippingKey(String shippingKey)	key of the ShippingMethod to update.
static tools.jackson.core.type.TypeReference<CartSetShippingMethodTaxRateAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartSetShippingMethodTaxRateAction(Function<CartSetShippingMethodTaxRateAction,T> helper)	accessor map function

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

getAction, withCartUpdateAction

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

get

Field Details

SET_SHIPPING_METHOD_TAX_RATE

static final String SET_SHIPPING_METHOD_TAX_RATE

discriminator value for CartSetShippingMethodTaxRateAction

See Also:

• Constant Field Values

Method Details

getShippingKey

String getShippingKey()

key of the ShippingMethod to update. This is required and valid only for Carts with Multiple ShippingMode. An InvalidOperation error is returned if shippingKey is provided for Carts with Single ShippingMode, or omitted for Carts with Multiple ShippingMode.

Returns:

shippingKey

getExternalTaxRate

@Valid
@Valid ExternalTaxRateDraft getExternalTaxRate()

Value to set. If empty, any existing value is removed.

Returns:

externalTaxRate

setShippingKey

void setShippingKey(String shippingKey)

key of the ShippingMethod to update. This is required and valid only for Carts with Multiple ShippingMode. An InvalidOperation error is returned if shippingKey is provided for Carts with Single ShippingMode, or omitted for Carts with Multiple ShippingMode.

Parameters:

shippingKey - value to be set

setExternalTaxRate

void setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)

Value to set. If empty, any existing value is removed.

Parameters:

externalTaxRate - value to be set

of

static CartSetShippingMethodTaxRateAction of()

factory method

Returns:

instance of CartSetShippingMethodTaxRateAction

of

static CartSetShippingMethodTaxRateAction of(CartSetShippingMethodTaxRateAction template)

factory method to create a shallow copy CartSetShippingMethodTaxRateAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CartSetShippingMethodTaxRateAction copyDeep()

Specified by:

copyDeep in interface CartUpdateAction

deepCopy

@Nullable
static CartSetShippingMethodTaxRateAction deepCopy(@Nullable
 CartSetShippingMethodTaxRateAction template)

factory method to create a deep copy of CartSetShippingMethodTaxRateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartSetShippingMethodTaxRateActionBuilder builder()

builder factory method for CartSetShippingMethodTaxRateAction

Returns:

builder

builder

static CartSetShippingMethodTaxRateActionBuilder builder(CartSetShippingMethodTaxRateAction template)

create builder for CartSetShippingMethodTaxRateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartSetShippingMethodTaxRateAction

default <T> T withCartSetShippingMethodTaxRateAction(Function<CartSetShippingMethodTaxRateAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static tools.jackson.core.type.TypeReference<CartSetShippingMethodTaxRateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference