Package com.commercetools.api.models.message

Interface InventoryEntrySafetyStockMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface InventoryEntrySafetyStockMessagePayload
extends MessagePayload

Generated after InventoryEntry quantityOnStock reaches the configured safety stock level. For more information, see InventoryEntryStockLevels.

Example to create an instance using the builder pattern

     InventoryEntrySafetyStockMessagePayload inventoryEntrySafetyStockMessagePayload = InventoryEntrySafetyStockMessagePayload.builder()
             .sku("{sku}")
             .quantityOnStock(0.3)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INVENTORY_ENTRY_SAFETY_STOCK	discriminator value for InventoryEntrySafetyStockMessagePayload

Method Summary

Modifier and Type	Method	Description
static InventoryEntrySafetyStockMessagePayloadBuilder	builder()	builder factory method for InventoryEntrySafetyStockMessagePayload
static InventoryEntrySafetyStockMessagePayloadBuilder	builder(InventoryEntrySafetyStockMessagePayload template)	create builder for InventoryEntrySafetyStockMessagePayload instance
InventoryEntrySafetyStockMessagePayload	copyDeep()
static InventoryEntrySafetyStockMessagePayload	deepCopy(InventoryEntrySafetyStockMessagePayload template)	factory method to create a deep copy of InventoryEntrySafetyStockMessagePayload
@NotNull Integer	getQuantityOnStock()	The quantityOnStock of the InventoryEntry at the time the safety stock level was reached.
@NotNull String	getSku()	The sku of the InventoryEntry whose quantityOnStock reached the configured safety stock level.
@Valid ChannelReference	getSupplyChannel()	Reference to the Channel where the InventoryEntry quantityOnStock reached the configured safety stock level.
static InventoryEntrySafetyStockMessagePayload	of()	factory method
static InventoryEntrySafetyStockMessagePayload	of(InventoryEntrySafetyStockMessagePayload template)	factory method to create a shallow copy InventoryEntrySafetyStockMessagePayload
void	setQuantityOnStock(Integer quantityOnStock)	The quantityOnStock of the InventoryEntry at the time the safety stock level was reached.
void	setSku(String sku)	The sku of the InventoryEntry whose quantityOnStock reached the configured safety stock level.
void	setSupplyChannel(ChannelReference supplyChannel)	Reference to the Channel where the InventoryEntry quantityOnStock reached the configured safety stock level.
static com.fasterxml.jackson.core.type.TypeReference<InventoryEntrySafetyStockMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withInventoryEntrySafetyStockMessagePayload(Function<InventoryEntrySafetyStockMessagePayload,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.message.MessagePayload

getType, withMessagePayload

Methods inherited from interface com.commercetools.api.models.message.MessagePayloadMixin

as

Field Details

INVENTORY_ENTRY_SAFETY_STOCK

static final String INVENTORY_ENTRY_SAFETY_STOCK

discriminator value for InventoryEntrySafetyStockMessagePayload

See Also:

• Constant Field Values

Method Details

getSku

@NotNull
@NotNull String getSku()

The sku of the InventoryEntry whose quantityOnStock reached the configured safety stock level.

Returns:

sku

getQuantityOnStock

@NotNull
@NotNull Integer getQuantityOnStock()

The quantityOnStock of the InventoryEntry at the time the safety stock level was reached.

Returns:

quantityOnStock

getSupplyChannel

@Valid
@Valid ChannelReference getSupplyChannel()

Reference to the Channel where the InventoryEntry quantityOnStock reached the configured safety stock level.

Returns:

supplyChannel

setSku

void setSku(String sku)

The sku of the InventoryEntry whose quantityOnStock reached the configured safety stock level.

Parameters:

sku - value to be set

setQuantityOnStock

void setQuantityOnStock(Integer quantityOnStock)

The quantityOnStock of the InventoryEntry at the time the safety stock level was reached.

Parameters:

quantityOnStock - value to be set

setSupplyChannel

void setSupplyChannel(ChannelReference supplyChannel)

Reference to the Channel where the InventoryEntry quantityOnStock reached the configured safety stock level.

Parameters:

supplyChannel - value to be set

of

static InventoryEntrySafetyStockMessagePayload of()

factory method

Returns:

instance of InventoryEntrySafetyStockMessagePayload

of

static InventoryEntrySafetyStockMessagePayload of(InventoryEntrySafetyStockMessagePayload template)

factory method to create a shallow copy InventoryEntrySafetyStockMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

InventoryEntrySafetyStockMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static InventoryEntrySafetyStockMessagePayload deepCopy(@Nullable
 InventoryEntrySafetyStockMessagePayload template)

factory method to create a deep copy of InventoryEntrySafetyStockMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static InventoryEntrySafetyStockMessagePayloadBuilder builder()

builder factory method for InventoryEntrySafetyStockMessagePayload

Returns:

builder

builder

static InventoryEntrySafetyStockMessagePayloadBuilder builder(InventoryEntrySafetyStockMessagePayload template)

create builder for InventoryEntrySafetyStockMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withInventoryEntrySafetyStockMessagePayload

default <T> T withInventoryEntrySafetyStockMessagePayload(Function<InventoryEntrySafetyStockMessagePayload,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<InventoryEntrySafetyStockMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference