Package com.commercetools.api.models.inventory

Interface InventoryEntryAddQuantityAction

All Superinterfaces:

InventoryEntryUpdateAction, ResourceUpdateAction<InventoryEntryUpdateAction>

public interface InventoryEntryAddQuantityAction
extends InventoryEntryUpdateAction

Incrementally updates the quantityOnStock by the specified amount. This changes the availableQuantity, based on the number of active reservations.

To set an absolute quantity value instead, use the InventoryEntryChangeQuantityAction update action.

Example to create an instance using the builder pattern

     InventoryEntryAddQuantityAction inventoryEntryAddQuantityAction = InventoryEntryAddQuantityAction.builder()
             .quantity(0.3)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_QUANTITY	discriminator value for InventoryEntryAddQuantityAction

Method Summary

Modifier and Type	Method	Description
static InventoryEntryAddQuantityActionBuilder	builder()	builder factory method for InventoryEntryAddQuantityAction
static InventoryEntryAddQuantityActionBuilder	builder(InventoryEntryAddQuantityAction template)	create builder for InventoryEntryAddQuantityAction instance
InventoryEntryAddQuantityAction	copyDeep()
static InventoryEntryAddQuantityAction	deepCopy(InventoryEntryAddQuantityAction template)	factory method to create a deep copy of InventoryEntryAddQuantityAction
@NotNull Long	getQuantity()	Value to add to quantityOnStock.
static InventoryEntryAddQuantityAction	of()	factory method
static InventoryEntryAddQuantityAction	of(InventoryEntryAddQuantityAction template)	factory method to create a shallow copy InventoryEntryAddQuantityAction
void	setQuantity(Long quantity)	Value to add to quantityOnStock.
static com.fasterxml.jackson.core.type.TypeReference<InventoryEntryAddQuantityAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withInventoryEntryAddQuantityAction(Function<InventoryEntryAddQuantityAction,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

ADD_QUANTITY

static final String ADD_QUANTITY

discriminator value for InventoryEntryAddQuantityAction

See Also:

• Constant Field Values

Method Details

getQuantity

@NotNull
@NotNull Long getQuantity()

Value to add to quantityOnStock.

Returns:

quantity

setQuantity

void setQuantity(Long quantity)

Value to add to quantityOnStock.

Parameters:

quantity - value to be set

of

static InventoryEntryAddQuantityAction of()

factory method

Returns:

instance of InventoryEntryAddQuantityAction

of

static InventoryEntryAddQuantityAction of(InventoryEntryAddQuantityAction template)

factory method to create a shallow copy InventoryEntryAddQuantityAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

InventoryEntryAddQuantityAction copyDeep()

Specified by:

copyDeep in interface InventoryEntryUpdateAction

deepCopy

@Nullable
static InventoryEntryAddQuantityAction deepCopy(@Nullable
 InventoryEntryAddQuantityAction template)

factory method to create a deep copy of InventoryEntryAddQuantityAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static InventoryEntryAddQuantityActionBuilder builder()

builder factory method for InventoryEntryAddQuantityAction

Returns:

builder

builder

static InventoryEntryAddQuantityActionBuilder builder(InventoryEntryAddQuantityAction template)

create builder for InventoryEntryAddQuantityAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withInventoryEntryAddQuantityAction

default <T> T withInventoryEntryAddQuantityAction(Function<InventoryEntryAddQuantityAction,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<InventoryEntryAddQuantityAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference