Package com.commercetools.api.models.order_edit

Interface StagedOrderSetShippingMethodTaxAmountAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

All Known Implementing Classes:

StagedOrderSetShippingMethodTaxAmountActionImpl

public interface StagedOrderSetShippingMethodTaxAmountAction
extends StagedOrderUpdateAction

StagedOrderSetShippingMethodTaxAmountAction Example to create an instance using the builder pattern

     StagedOrderSetShippingMethodTaxAmountAction stagedOrderSetShippingMethodTaxAmountAction = StagedOrderSetShippingMethodTaxAmountAction.builder()
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static StagedOrderSetShippingMethodTaxAmountActionBuilder	builder()	builder factory method for StagedOrderSetShippingMethodTaxAmountAction
static StagedOrderSetShippingMethodTaxAmountActionBuilder	builder(StagedOrderSetShippingMethodTaxAmountAction template)	create builder for StagedOrderSetShippingMethodTaxAmountAction instance
static StagedOrderSetShippingMethodTaxAmountAction	deepCopy(StagedOrderSetShippingMethodTaxAmountAction template)	factory method to create a deep copy of StagedOrderSetShippingMethodTaxAmountAction
@Valid ExternalTaxAmountDraft	getExternalTaxAmount()	Cannot be used in LineItemDraft or CustomLineItemDraft.
String	getShippingKey()	key of the ShippingMethod to update.
static StagedOrderSetShippingMethodTaxAmountAction	of()	factory method
static StagedOrderSetShippingMethodTaxAmountAction	of(StagedOrderSetShippingMethodTaxAmountAction template)	factory method to create a shallow copy StagedOrderSetShippingMethodTaxAmountAction
void	setExternalTaxAmount(ExternalTaxAmountDraft externalTaxAmount)	Cannot be used in LineItemDraft or CustomLineItemDraft.
void	setShippingKey(String shippingKey)	key of the ShippingMethod to update.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderSetShippingMethodTaxAmountAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderSetShippingMethodTaxAmountAction(Function<StagedOrderSetShippingMethodTaxAmountAction,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_AMOUNT

static final String SET_SHIPPING_METHOD_TAX_AMOUNT

discriminator value for StagedOrderSetShippingMethodTaxAmountAction

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

getExternalTaxAmount

@Valid
@Valid ExternalTaxAmountDraft getExternalTaxAmount()

Cannot be used in LineItemDraft or CustomLineItemDraft.

Can only be set by these update actions:

• Set LineItem TaxAmount, Set CustomLineItem TaxAmount, or Set ShippingMethod TaxAmount on Carts
• Set LineItem TaxAmount, Set CustomLineItem TaxAmount, or Set ShippingMethod TaxAmount on Order Edits

Returns:

externalTaxAmount

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

setExternalTaxAmount

void setExternalTaxAmount(ExternalTaxAmountDraft externalTaxAmount)

Cannot be used in LineItemDraft or CustomLineItemDraft.

Can only be set by these update actions:

• Set LineItem TaxAmount, Set CustomLineItem TaxAmount, or Set ShippingMethod TaxAmount on Carts
• Set LineItem TaxAmount, Set CustomLineItem TaxAmount, or Set ShippingMethod TaxAmount on Order Edits

Parameters:

externalTaxAmount - value to be set

of

static StagedOrderSetShippingMethodTaxAmountAction of()

factory method

Returns:

instance of StagedOrderSetShippingMethodTaxAmountAction

of

static StagedOrderSetShippingMethodTaxAmountAction of(StagedOrderSetShippingMethodTaxAmountAction template)

factory method to create a shallow copy StagedOrderSetShippingMethodTaxAmountAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderSetShippingMethodTaxAmountAction deepCopy(@Nullable
 StagedOrderSetShippingMethodTaxAmountAction template)

factory method to create a deep copy of StagedOrderSetShippingMethodTaxAmountAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetShippingMethodTaxAmountActionBuilder builder()

builder factory method for StagedOrderSetShippingMethodTaxAmountAction

Returns:

builder

builder

static StagedOrderSetShippingMethodTaxAmountActionBuilder builder(StagedOrderSetShippingMethodTaxAmountAction template)

create builder for StagedOrderSetShippingMethodTaxAmountAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetShippingMethodTaxAmountAction

default <T> T withStagedOrderSetShippingMethodTaxAmountAction(Function<StagedOrderSetShippingMethodTaxAmountAction,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<StagedOrderSetShippingMethodTaxAmountAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference