Package com.commercetools.api.models.order_edit

Interface StagedOrderSetCustomLineItemTaxAmountAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderSetCustomLineItemTaxAmountAction
extends StagedOrderUpdateAction

Can be used if the Cart has the ExternalAmount TaxMode.

Example to create an instance using the builder pattern

     StagedOrderSetCustomLineItemTaxAmountAction stagedOrderSetCustomLineItemTaxAmountAction = StagedOrderSetCustomLineItemTaxAmountAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_CUSTOM_LINE_ITEM_TAX_AMOUNT	discriminator value for StagedOrderSetCustomLineItemTaxAmountAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderSetCustomLineItemTaxAmountActionBuilder	builder()	builder factory method for StagedOrderSetCustomLineItemTaxAmountAction
static StagedOrderSetCustomLineItemTaxAmountActionBuilder	builder(StagedOrderSetCustomLineItemTaxAmountAction template)	create builder for StagedOrderSetCustomLineItemTaxAmountAction instance
StagedOrderSetCustomLineItemTaxAmountAction	copyDeep()
static StagedOrderSetCustomLineItemTaxAmountAction	deepCopy(StagedOrderSetCustomLineItemTaxAmountAction template)	factory method to create a deep copy of StagedOrderSetCustomLineItemTaxAmountAction
String	getCustomLineItemId()	id of the CustomLineItem to update.
String	getCustomLineItemKey()	key of the CustomLineItem to update.
@Valid ExternalTaxAmountDraft	getExternalTaxAmount()	Value to set.
String	getShippingKey()	key of the ShippingMethod used for this Custom Line Item.
static StagedOrderSetCustomLineItemTaxAmountAction	of()	factory method
static StagedOrderSetCustomLineItemTaxAmountAction	of(StagedOrderSetCustomLineItemTaxAmountAction template)	factory method to create a shallow copy StagedOrderSetCustomLineItemTaxAmountAction
void	setCustomLineItemId(String customLineItemId)	id of the CustomLineItem to update.
void	setCustomLineItemKey(String customLineItemKey)	key of the CustomLineItem to update.
void	setExternalTaxAmount(ExternalTaxAmountDraft externalTaxAmount)	Value to set.
void	setShippingKey(String shippingKey)	key of the ShippingMethod used for this Custom Line Item.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderSetCustomLineItemTaxAmountAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderSetCustomLineItemTaxAmountAction(Function<StagedOrderSetCustomLineItemTaxAmountAction,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_CUSTOM_LINE_ITEM_TAX_AMOUNT

static final String SET_CUSTOM_LINE_ITEM_TAX_AMOUNT

discriminator value for StagedOrderSetCustomLineItemTaxAmountAction

See Also:

• Constant Field Values

Method Details

getCustomLineItemId

String getCustomLineItemId()

id of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Returns:

customLineItemId

getCustomLineItemKey

String getCustomLineItemKey()

key of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Returns:

customLineItemKey

getExternalTaxAmount

@Valid
@Valid ExternalTaxAmountDraft getExternalTaxAmount()

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

Returns:

externalTaxAmount

getShippingKey

String getShippingKey()

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

Returns:

shippingKey

setCustomLineItemId

void setCustomLineItemId(String customLineItemId)

id of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Parameters:

customLineItemId - value to be set

setCustomLineItemKey

void setCustomLineItemKey(String customLineItemKey)

key of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Parameters:

customLineItemKey - 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

setShippingKey

void setShippingKey(String shippingKey)

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

Parameters:

shippingKey - value to be set

of

static StagedOrderSetCustomLineItemTaxAmountAction of()

factory method

Returns:

instance of StagedOrderSetCustomLineItemTaxAmountAction

of

static StagedOrderSetCustomLineItemTaxAmountAction of(StagedOrderSetCustomLineItemTaxAmountAction template)

factory method to create a shallow copy StagedOrderSetCustomLineItemTaxAmountAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

StagedOrderSetCustomLineItemTaxAmountAction copyDeep()

Specified by:

copyDeep in interface StagedOrderUpdateAction

deepCopy

@Nullable
static StagedOrderSetCustomLineItemTaxAmountAction deepCopy(@Nullable
 StagedOrderSetCustomLineItemTaxAmountAction template)

factory method to create a deep copy of StagedOrderSetCustomLineItemTaxAmountAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetCustomLineItemTaxAmountActionBuilder builder()

builder factory method for StagedOrderSetCustomLineItemTaxAmountAction

Returns:

builder

builder

static StagedOrderSetCustomLineItemTaxAmountActionBuilder builder(StagedOrderSetCustomLineItemTaxAmountAction template)

create builder for StagedOrderSetCustomLineItemTaxAmountAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetCustomLineItemTaxAmountAction

default <T> T withStagedOrderSetCustomLineItemTaxAmountAction(Function<StagedOrderSetCustomLineItemTaxAmountAction,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<StagedOrderSetCustomLineItemTaxAmountAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference