Package com.commercetools.api.models.order_edit

Interface StagedOrderRemoveLineItemAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

All Known Implementing Classes:

StagedOrderRemoveLineItemActionImpl

public interface StagedOrderRemoveLineItemAction
extends StagedOrderUpdateAction

StagedOrderRemoveLineItemAction Example to create an instance using the builder pattern

     StagedOrderRemoveLineItemAction stagedOrderRemoveLineItemAction = StagedOrderRemoveLineItemAction.builder()
             .lineItemId("{lineItemId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_LINE_ITEM	discriminator value for StagedOrderRemoveLineItemAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderRemoveLineItemActionBuilder	builder()	builder factory method for StagedOrderRemoveLineItemAction
static StagedOrderRemoveLineItemActionBuilder	builder(StagedOrderRemoveLineItemAction template)	create builder for StagedOrderRemoveLineItemAction instance
static StagedOrderRemoveLineItemAction	deepCopy(StagedOrderRemoveLineItemAction template)	factory method to create a deep copy of StagedOrderRemoveLineItemAction
@Valid Money	getExternalPrice()	Draft type that stores amounts only in cent precision for the specified currency.
@Valid ExternalLineItemTotalPrice	getExternalTotalPrice()
@NotNull String	getLineItemId()
Long	getQuantity()
@Valid ItemShippingDetailsDraft	getShippingDetailsToRemove()	For order creation and updates, the sum of the targets must match the quantity of the Line Items or Custom Line Items.
static StagedOrderRemoveLineItemAction	of()	factory method
static StagedOrderRemoveLineItemAction	of(StagedOrderRemoveLineItemAction template)	factory method to create a shallow copy StagedOrderRemoveLineItemAction
void	setExternalPrice(Money externalPrice)	Draft type that stores amounts only in cent precision for the specified currency.
void	setExternalTotalPrice(ExternalLineItemTotalPrice externalTotalPrice)	set externalTotalPrice
void	setLineItemId(String lineItemId)	set lineItemId
void	setQuantity(Long quantity)	set quantity
void	setShippingDetailsToRemove(ItemShippingDetailsDraft shippingDetailsToRemove)	For order creation and updates, the sum of the targets must match the quantity of the Line Items or Custom Line Items.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderRemoveLineItemAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderRemoveLineItemAction(Function<StagedOrderRemoveLineItemAction,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

REMOVE_LINE_ITEM

static final String REMOVE_LINE_ITEM

discriminator value for StagedOrderRemoveLineItemAction

See Also:

• Constant Field Values

Method Details

getLineItemId

@NotNull
@NotNull String getLineItemId()

Returns:

lineItemId

getQuantity

Long getQuantity()

Returns:

quantity

getExternalPrice

@Valid
@Valid Money getExternalPrice()

Draft type that stores amounts only in cent precision for the specified currency.

Returns:

externalPrice

getExternalTotalPrice

@Valid
@Valid ExternalLineItemTotalPrice getExternalTotalPrice()

Returns:

externalTotalPrice

getShippingDetailsToRemove

@Valid
@Valid ItemShippingDetailsDraft getShippingDetailsToRemove()

For order creation and updates, the sum of the targets must match the quantity of the Line Items or Custom Line Items.

Returns:

shippingDetailsToRemove

setLineItemId

void setLineItemId(String lineItemId)

set lineItemId

Parameters:

lineItemId - value to be set

setQuantity

void setQuantity(Long quantity)

set quantity

Parameters:

quantity - value to be set

setExternalPrice

void setExternalPrice(Money externalPrice)

Draft type that stores amounts only in cent precision for the specified currency.

Parameters:

externalPrice - value to be set

setExternalTotalPrice

void setExternalTotalPrice(ExternalLineItemTotalPrice externalTotalPrice)

set externalTotalPrice

Parameters:

externalTotalPrice - value to be set

setShippingDetailsToRemove

void setShippingDetailsToRemove(ItemShippingDetailsDraft shippingDetailsToRemove)

For order creation and updates, the sum of the targets must match the quantity of the Line Items or Custom Line Items.

Parameters:

shippingDetailsToRemove - value to be set

of

static StagedOrderRemoveLineItemAction of()

factory method

Returns:

instance of StagedOrderRemoveLineItemAction

of

static StagedOrderRemoveLineItemAction of(StagedOrderRemoveLineItemAction template)

factory method to create a shallow copy StagedOrderRemoveLineItemAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderRemoveLineItemAction deepCopy(@Nullable
 StagedOrderRemoveLineItemAction template)

factory method to create a deep copy of StagedOrderRemoveLineItemAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderRemoveLineItemActionBuilder builder()

builder factory method for StagedOrderRemoveLineItemAction

Returns:

builder

builder

static StagedOrderRemoveLineItemActionBuilder builder(StagedOrderRemoveLineItemAction template)

create builder for StagedOrderRemoveLineItemAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderRemoveLineItemAction

default <T> T withStagedOrderRemoveLineItemAction(Function<StagedOrderRemoveLineItemAction,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<StagedOrderRemoveLineItemAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference