Package com.commercetools.api.models.inventory

Interface InventoryEntryRemoveQuantityAction

All Superinterfaces:

InventoryEntryUpdateAction, ResourceUpdateAction<InventoryEntryUpdateAction>

public interface InventoryEntryRemoveQuantityAction
extends InventoryEntryUpdateAction

Removes a specific quantity from quantityOnStock. This changes the availableQuantity, based on the number of active reservations. You can update quantityOnStock to values below zero.

Carts with existing ReserveOnCart reservations will not be invalidated by this update action and can still be ordered.

Example to create an instance using the builder pattern

     InventoryEntryRemoveQuantityAction inventoryEntryRemoveQuantityAction = InventoryEntryRemoveQuantityAction.builder()
             .quantity(0.3)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_QUANTITY	discriminator value for InventoryEntryRemoveQuantityAction

Method Summary

Modifier and Type	Method	Description
static InventoryEntryRemoveQuantityActionBuilder	builder()	builder factory method for InventoryEntryRemoveQuantityAction
static InventoryEntryRemoveQuantityActionBuilder	builder(InventoryEntryRemoveQuantityAction template)	create builder for InventoryEntryRemoveQuantityAction instance
InventoryEntryRemoveQuantityAction	copyDeep()
static InventoryEntryRemoveQuantityAction	deepCopy(InventoryEntryRemoveQuantityAction template)	factory method to create a deep copy of InventoryEntryRemoveQuantityAction
@NotNull Long	getQuantity()	Value to remove from quantityOnStock.
static InventoryEntryRemoveQuantityAction	of()	factory method
static InventoryEntryRemoveQuantityAction	of(InventoryEntryRemoveQuantityAction template)	factory method to create a shallow copy InventoryEntryRemoveQuantityAction
void	setQuantity(Long quantity)	Value to remove from quantityOnStock.
static com.fasterxml.jackson.core.type.TypeReference<InventoryEntryRemoveQuantityAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withInventoryEntryRemoveQuantityAction(Function<InventoryEntryRemoveQuantityAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.inventory.InventoryEntryUpdateAction

getAction, withInventoryEntryUpdateAction

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Field Details

REMOVE_QUANTITY

static final String REMOVE_QUANTITY

discriminator value for InventoryEntryRemoveQuantityAction

See Also:

• Constant Field Values

Method Details

getQuantity

@NotNull
@NotNull Long getQuantity()

Value to remove from quantityOnStock.

Returns:

quantity

setQuantity

void setQuantity(Long quantity)

Value to remove from quantityOnStock.

Parameters:

quantity - value to be set

of

static InventoryEntryRemoveQuantityAction of()

factory method

Returns:

instance of InventoryEntryRemoveQuantityAction

of

static InventoryEntryRemoveQuantityAction of(InventoryEntryRemoveQuantityAction template)

factory method to create a shallow copy InventoryEntryRemoveQuantityAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

InventoryEntryRemoveQuantityAction copyDeep()

Specified by:

copyDeep in interface InventoryEntryUpdateAction

deepCopy

@Nullable
static InventoryEntryRemoveQuantityAction deepCopy(@Nullable
 InventoryEntryRemoveQuantityAction template)

factory method to create a deep copy of InventoryEntryRemoveQuantityAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static InventoryEntryRemoveQuantityActionBuilder builder()

builder factory method for InventoryEntryRemoveQuantityAction

Returns:

builder

builder

static InventoryEntryRemoveQuantityActionBuilder builder(InventoryEntryRemoveQuantityAction template)

create builder for InventoryEntryRemoveQuantityAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withInventoryEntryRemoveQuantityAction

default <T> T withInventoryEntryRemoveQuantityAction(Function<InventoryEntryRemoveQuantityAction,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<InventoryEntryRemoveQuantityAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference