Package com.commercetools.api.models.cart

Interface CartSetShippingMethodTaxAmountAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

public interface CartSetShippingMethodTaxAmountAction
extends CartUpdateAction

A Shipping Method tax amount can be set if the Cart has the ExternalAmount TaxMode.

Example to create an instance using the builder pattern

     CartSetShippingMethodTaxAmountAction cartSetShippingMethodTaxAmountAction = CartSetShippingMethodTaxAmountAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_SHIPPING_METHOD_TAX_AMOUNT	discriminator value for CartSetShippingMethodTaxAmountAction

Method Summary

Modifier and Type	Method	Description
static CartSetShippingMethodTaxAmountActionBuilder	builder()	builder factory method for CartSetShippingMethodTaxAmountAction
static CartSetShippingMethodTaxAmountActionBuilder	builder(CartSetShippingMethodTaxAmountAction template)	create builder for CartSetShippingMethodTaxAmountAction instance
CartSetShippingMethodTaxAmountAction	copyDeep()
static CartSetShippingMethodTaxAmountAction	deepCopy(CartSetShippingMethodTaxAmountAction template)	factory method to create a deep copy of CartSetShippingMethodTaxAmountAction
@Valid ExternalTaxAmountDraft	getExternalTaxAmount()	Value to set.
String	getShippingKey()	key of the ShippingMethod to update.
static CartSetShippingMethodTaxAmountAction	of()	factory method
static CartSetShippingMethodTaxAmountAction	of(CartSetShippingMethodTaxAmountAction template)	factory method to create a shallow copy CartSetShippingMethodTaxAmountAction
void	setExternalTaxAmount(ExternalTaxAmountDraft externalTaxAmount)	Value to set.
void	setShippingKey(String shippingKey)	key of the ShippingMethod to update.
static tools.jackson.core.type.TypeReference<CartSetShippingMethodTaxAmountAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartSetShippingMethodTaxAmountAction(Function<CartSetShippingMethodTaxAmountAction,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_AMOUNT

static final String SET_SHIPPING_METHOD_TAX_AMOUNT

discriminator value for CartSetShippingMethodTaxAmountAction

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

getExternalTaxAmount

@Valid
@Valid ExternalTaxAmountDraft getExternalTaxAmount()

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

Returns:

externalTaxAmount

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

setExternalTaxAmount

void setExternalTaxAmount(ExternalTaxAmountDraft externalTaxAmount)

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

Parameters:

externalTaxAmount - value to be set

of

static CartSetShippingMethodTaxAmountAction of()

factory method

Returns:

instance of CartSetShippingMethodTaxAmountAction

of

static CartSetShippingMethodTaxAmountAction of(CartSetShippingMethodTaxAmountAction template)

factory method to create a shallow copy CartSetShippingMethodTaxAmountAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CartSetShippingMethodTaxAmountAction copyDeep()

Specified by:

copyDeep in interface CartUpdateAction

deepCopy

@Nullable
static CartSetShippingMethodTaxAmountAction deepCopy(@Nullable
 CartSetShippingMethodTaxAmountAction template)

factory method to create a deep copy of CartSetShippingMethodTaxAmountAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartSetShippingMethodTaxAmountActionBuilder builder()

builder factory method for CartSetShippingMethodTaxAmountAction

Returns:

builder

builder

static CartSetShippingMethodTaxAmountActionBuilder builder(CartSetShippingMethodTaxAmountAction template)

create builder for CartSetShippingMethodTaxAmountAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartSetShippingMethodTaxAmountAction

default <T> T withCartSetShippingMethodTaxAmountAction(Function<CartSetShippingMethodTaxAmountAction,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<CartSetShippingMethodTaxAmountAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference