Package com.commercetools.api.models.order_edit

Interface StagedOrderSetLineItemTaxAmountAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderSetLineItemTaxAmountAction
extends StagedOrderUpdateAction

Can be used if the Cart has the ExternalAmount TaxMode. This update action sets the taxedPrice and taxRate on a Line Item and must be used after any price-affecting change occurs.

Example to create an instance using the builder pattern

     StagedOrderSetLineItemTaxAmountAction stagedOrderSetLineItemTaxAmountAction = StagedOrderSetLineItemTaxAmountAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_LINE_ITEM_TAX_AMOUNT	discriminator value for StagedOrderSetLineItemTaxAmountAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderSetLineItemTaxAmountActionBuilder	builder()	builder factory method for StagedOrderSetLineItemTaxAmountAction
static StagedOrderSetLineItemTaxAmountActionBuilder	builder(StagedOrderSetLineItemTaxAmountAction template)	create builder for StagedOrderSetLineItemTaxAmountAction instance
StagedOrderSetLineItemTaxAmountAction	copyDeep()
static StagedOrderSetLineItemTaxAmountAction	deepCopy(StagedOrderSetLineItemTaxAmountAction template)	factory method to create a deep copy of StagedOrderSetLineItemTaxAmountAction
@Valid ExternalTaxAmountDraft	getExternalTaxAmount()	Value to set.
String	getLineItemId()	id of the LineItem to update.
String	getLineItemKey()	key of the LineItem to update.
String	getShippingKey()	key of the ShippingMethod used for this Line Item.
static StagedOrderSetLineItemTaxAmountAction	of()	factory method
static StagedOrderSetLineItemTaxAmountAction	of(StagedOrderSetLineItemTaxAmountAction template)	factory method to create a shallow copy StagedOrderSetLineItemTaxAmountAction
void	setExternalTaxAmount(ExternalTaxAmountDraft externalTaxAmount)	Value to set.
void	setLineItemId(String lineItemId)	id of the LineItem to update.
void	setLineItemKey(String lineItemKey)	key of the LineItem to update.
void	setShippingKey(String shippingKey)	key of the ShippingMethod used for this Line Item.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderSetLineItemTaxAmountAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderSetLineItemTaxAmountAction(Function<StagedOrderSetLineItemTaxAmountAction,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_LINE_ITEM_TAX_AMOUNT

static final String SET_LINE_ITEM_TAX_AMOUNT

discriminator value for StagedOrderSetLineItemTaxAmountAction

See Also:

• Constant Field Values

Method Details

getLineItemId

String getLineItemId()

id of the LineItem to update. Either lineItemId or lineItemKey is required.

Returns:

lineItemId

getLineItemKey

String getLineItemKey()

key of the LineItem to update. Either lineItemId or lineItemKey is required.

Returns:

lineItemKey

getExternalTaxAmount

@Valid
@Valid ExternalTaxAmountDraft getExternalTaxAmount()

Value to set. If empty, any existing value will be removed.

Returns:

externalTaxAmount

getShippingKey

String getShippingKey()

key of the ShippingMethod used for this Line Item. This is required for Carts with Multiple ShippingMode.

Returns:

shippingKey

setLineItemId

void setLineItemId(String lineItemId)

id of the LineItem to update. Either lineItemId or lineItemKey is required.

Parameters:

lineItemId - value to be set

setLineItemKey

void setLineItemKey(String lineItemKey)

key of the LineItem to update. Either lineItemId or lineItemKey is required.

Parameters:

lineItemKey - value to be set

setExternalTaxAmount

void setExternalTaxAmount(ExternalTaxAmountDraft externalTaxAmount)

Value to set. If empty, any existing value will be removed.

Parameters:

externalTaxAmount - value to be set

setShippingKey

void setShippingKey(String shippingKey)

key of the ShippingMethod used for this Line Item. This is required for Carts with Multiple ShippingMode.

Parameters:

shippingKey - value to be set

of

static StagedOrderSetLineItemTaxAmountAction of()

factory method

Returns:

instance of StagedOrderSetLineItemTaxAmountAction

of

static StagedOrderSetLineItemTaxAmountAction of(StagedOrderSetLineItemTaxAmountAction template)

factory method to create a shallow copy StagedOrderSetLineItemTaxAmountAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

StagedOrderSetLineItemTaxAmountAction copyDeep()

Specified by:

copyDeep in interface StagedOrderUpdateAction

deepCopy

@Nullable
static StagedOrderSetLineItemTaxAmountAction deepCopy(@Nullable
 StagedOrderSetLineItemTaxAmountAction template)

factory method to create a deep copy of StagedOrderSetLineItemTaxAmountAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetLineItemTaxAmountActionBuilder builder()

builder factory method for StagedOrderSetLineItemTaxAmountAction

Returns:

builder

builder

static StagedOrderSetLineItemTaxAmountActionBuilder builder(StagedOrderSetLineItemTaxAmountAction template)

create builder for StagedOrderSetLineItemTaxAmountAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetLineItemTaxAmountAction

default <T> T withStagedOrderSetLineItemTaxAmountAction(Function<StagedOrderSetLineItemTaxAmountAction,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<StagedOrderSetLineItemTaxAmountAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference