Package com.commercetools.api.models.order_edit

Interface StagedOrderChangeCustomLineItemQuantityAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

All Known Implementing Classes:

StagedOrderChangeCustomLineItemQuantityActionImpl

public interface StagedOrderChangeCustomLineItemQuantityAction
extends StagedOrderUpdateAction

When multiple shipping addresses are set for a Custom Line Item, use the Add CustomLineItem update action to change the shipping details. Since it is not possible for the API to infer how the overall change in the Custom Line Item quantity should be distributed over the sub-quantities, the shippingDetails field is kept in its current state to avoid data loss.

To change the Custom Line Item quantity and shipping details together, use this update action in combination with the Set CustomLineItem ShippingDetails update action in a single Order update command.

Example to create an instance using the builder pattern

     StagedOrderChangeCustomLineItemQuantityAction stagedOrderChangeCustomLineItemQuantityAction = StagedOrderChangeCustomLineItemQuantityAction.builder()
             .quantity(0.3)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_CUSTOM_LINE_ITEM_QUANTITY	discriminator value for StagedOrderChangeCustomLineItemQuantityAction

Method Summary

Modifier and Type	Method	Description
static StagedOrderChangeCustomLineItemQuantityActionBuilder	builder()	builder factory method for StagedOrderChangeCustomLineItemQuantityAction
static StagedOrderChangeCustomLineItemQuantityActionBuilder	builder(StagedOrderChangeCustomLineItemQuantityAction template)	create builder for StagedOrderChangeCustomLineItemQuantityAction instance
static StagedOrderChangeCustomLineItemQuantityAction	deepCopy(StagedOrderChangeCustomLineItemQuantityAction template)	factory method to create a deep copy of StagedOrderChangeCustomLineItemQuantityAction
String	getCustomLineItemId()	id of the CustomLineItem to update.
String	getCustomLineItemKey()	key of the CustomLineItem to update.
@NotNull Long	getQuantity()	New value to set.
static StagedOrderChangeCustomLineItemQuantityAction	of()	factory method
static StagedOrderChangeCustomLineItemQuantityAction	of(StagedOrderChangeCustomLineItemQuantityAction template)	factory method to create a shallow copy StagedOrderChangeCustomLineItemQuantityAction
void	setCustomLineItemId(String customLineItemId)	id of the CustomLineItem to update.
void	setCustomLineItemKey(String customLineItemKey)	key of the CustomLineItem to update.
void	setQuantity(Long quantity)	New value to set.
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderChangeCustomLineItemQuantityAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderChangeCustomLineItemQuantityAction(Function<StagedOrderChangeCustomLineItemQuantityAction,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

CHANGE_CUSTOM_LINE_ITEM_QUANTITY

static final String CHANGE_CUSTOM_LINE_ITEM_QUANTITY

discriminator value for StagedOrderChangeCustomLineItemQuantityAction

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

getQuantity

@NotNull
@NotNull Long getQuantity()

New value to set. If 0, the Custom Line Item is removed from the Order.

Returns:

quantity

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

setQuantity

void setQuantity(Long quantity)

New value to set. If 0, the Custom Line Item is removed from the Order.

Parameters:

quantity - value to be set

of

static StagedOrderChangeCustomLineItemQuantityAction of()

factory method

Returns:

instance of StagedOrderChangeCustomLineItemQuantityAction

of

static StagedOrderChangeCustomLineItemQuantityAction of(StagedOrderChangeCustomLineItemQuantityAction template)

factory method to create a shallow copy StagedOrderChangeCustomLineItemQuantityAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static StagedOrderChangeCustomLineItemQuantityAction deepCopy(@Nullable
 StagedOrderChangeCustomLineItemQuantityAction template)

factory method to create a deep copy of StagedOrderChangeCustomLineItemQuantityAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderChangeCustomLineItemQuantityActionBuilder builder()

builder factory method for StagedOrderChangeCustomLineItemQuantityAction

Returns:

builder

builder

static StagedOrderChangeCustomLineItemQuantityActionBuilder builder(StagedOrderChangeCustomLineItemQuantityAction template)

create builder for StagedOrderChangeCustomLineItemQuantityAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderChangeCustomLineItemQuantityAction

default <T> T withStagedOrderChangeCustomLineItemQuantityAction(Function<StagedOrderChangeCustomLineItemQuantityAction,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<StagedOrderChangeCustomLineItemQuantityAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference