Package com.commercetools.api.models.order_edit

Interface StagedOrderSetShippingMethodTaxRateAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderSetShippingMethodTaxRateAction
extends StagedOrderUpdateAction

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

Example to create an instance using the builder pattern

     StagedOrderSetShippingMethodTaxRateAction stagedOrderSetShippingMethodTaxRateAction = StagedOrderSetShippingMethodTaxRateAction.builder()
             .build()
 

Field Summary

Fields

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

Method Summary

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

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

get

Methods inherited from interface com.commercetools.api.models.order.StagedOrderUpdateAction

getAction, withStagedOrderUpdateAction

Field Details

SET_SHIPPING_METHOD_TAX_RATE

static final String SET_SHIPPING_METHOD_TAX_RATE

discriminator value for StagedOrderSetShippingMethodTaxRateAction

See Also:

• Constant Field Values

Method Details

getShippingKey

String getShippingKey()

key of the ShippingMethod to update. This is required for Orders 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 for Orders 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 StagedOrderSetShippingMethodTaxRateAction of()

factory method

Returns:

instance of StagedOrderSetShippingMethodTaxRateAction

of

static StagedOrderSetShippingMethodTaxRateAction of(StagedOrderSetShippingMethodTaxRateAction template)

factory method to create a shallow copy StagedOrderSetShippingMethodTaxRateAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

StagedOrderSetShippingMethodTaxRateAction copyDeep()

Specified by:

copyDeep in interface StagedOrderUpdateAction

deepCopy

@Nullable
static StagedOrderSetShippingMethodTaxRateAction deepCopy(@Nullable
 StagedOrderSetShippingMethodTaxRateAction template)

factory method to create a deep copy of StagedOrderSetShippingMethodTaxRateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetShippingMethodTaxRateActionBuilder builder()

builder factory method for StagedOrderSetShippingMethodTaxRateAction

Returns:

builder

builder

static StagedOrderSetShippingMethodTaxRateActionBuilder builder(StagedOrderSetShippingMethodTaxRateAction template)

create builder for StagedOrderSetShippingMethodTaxRateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetShippingMethodTaxRateAction

default <T> T withStagedOrderSetShippingMethodTaxRateAction(Function<StagedOrderSetShippingMethodTaxRateAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<StagedOrderSetShippingMethodTaxRateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference