io.sphere.sdk.inventory

Interface InventoryEntry

All Superinterfaces:

CreationTimestamped, Custom, Identifiable<InventoryEntry>, Referenceable<InventoryEntry>, Resource<InventoryEntry>, ResourceIdentifiable<InventoryEntry>, ResourceView<InventoryEntry,InventoryEntry>, Timestamped, Versioned<InventoryEntry>

public interface InventoryEntry
extends Resource<InventoryEntry>, Custom

Inventory allows you to track stock quantity per SKU and optionally per supply Channel.

An InventoryEntry can have custom fields.

See Also:

InventoryEntryCreateCommand, InventoryEntryUpdateCommand, InventoryEntryDeleteCommand, InventoryEntryQuery, InventoryEntryByIdGet

Method Summary

Modifier and Type	Method and Description
Long	getAvailableQuantity() Available amount of stock.
CustomFields	getCustom()
ZonedDateTime	getExpectedDelivery() The date and time of the next restock.
Long	getQuantityOnStock() Overall amount of stock.
Integer	getRestockableInDays() The time period in days, that tells how often this inventory entry is restocked.
String	getSku()
Reference<Channel>	getSupplyChannel() Optional connection to particular supplier.
static Reference<InventoryEntry>	referenceOfId(String id) Creates a reference for one item of this class by a known ID.
static String	referenceTypeId() A type hint for references which resource type is linked in a reference.
static String	resourceTypeId() An identifier for this resource which supports CustomFields.
default Reference<InventoryEntry>	toReference() Creates a reference to this resource, the reference may not be filled.
static com.fasterxml.jackson.core.type.TypeReference<InventoryEntry>	typeReference() Creates a container which contains the full Java type information to deserialize this class from JSON.

Methods inherited from interface io.sphere.sdk.models.Resource

getCreatedAt, getId, getLastModifiedAt, getVersion

Methods inherited from interface io.sphere.sdk.models.Versioned

of, of

Methods inherited from interface io.sphere.sdk.models.Referenceable

hasSameIdAs, toResourceIdentifier

Method Detail

getAvailableQuantity

Long getAvailableQuantity()

Available amount of stock. (available means: quantityOnStock - reserved quantity)

Returns:

quantity

See Also:

AddQuantity, RemoveQuantity, ChangeQuantity

getExpectedDelivery

@Nullable
ZonedDateTime getExpectedDelivery()

The date and time of the next restock.

Returns:

date time or null

See Also:

SetExpectedDelivery

getQuantityOnStock

Long getQuantityOnStock()

Overall amount of stock. (available + reserved)

Returns:

quantity

See Also:

AddQuantity, RemoveQuantity, ChangeQuantity

getRestockableInDays

@Nullable
Integer getRestockableInDays()

The time period in days, that tells how often this inventory entry is restocked.

Returns:

time in days or null

See Also:

SetRestockableInDays

getSku

String getSku()

getSupplyChannel

@Nullable
Reference<Channel> getSupplyChannel()

Optional connection to particular supplier.

Returns:

channel or null

See Also:

SetSupplyChannel

toReference

default Reference<InventoryEntry> toReference()

Description copied from interface: Referenceable

Creates a reference to this resource, the reference may not be filled.

Specified by:

toReference in interface Referenceable<InventoryEntry>

Specified by:

toReference in interface Resource<InventoryEntry>

Returns:

reference

referenceTypeId

static String referenceTypeId()

A type hint for references which resource type is linked in a reference.

Returns:

type hint

See Also:

Reference.getTypeId()

typeReference

static com.fasterxml.jackson.core.type.TypeReference<InventoryEntry> typeReference()

Creates a container which contains the full Java type information to deserialize this class from JSON.

Returns:

type reference

See Also:

SphereJsonUtils.readObject(byte[], TypeReference), SphereJsonUtils.readObject(String, TypeReference), SphereJsonUtils.readObject(com.fasterxml.jackson.databind.JsonNode, TypeReference), SphereJsonUtils.readObjectFromResource(String, TypeReference)

referenceOfId

static Reference<InventoryEntry> referenceOfId(String id)

Creates a reference for one item of this class by a known ID.

An example for categories but this applies for other resources, too:

final String categoryIdFromFormOrSession = "84ac4271-0fec-49d0-9fee-55586c565c58";
final Reference<Category> categoryReference = Category.referenceOfId(categoryIdFromFormOrSession);
assertThat(categoryReference.getId()).isEqualTo(categoryIdFromFormOrSession);
See the test code.

If you already have a resource object, then use toReference() instead:

final Category category = getCategory1();
final Reference<Category> categoryReference = category.toReference();
assertThat(category.getId()).isEqualTo(categoryReference.getId());
See the test code.

Parameters:

id - the ID of the resource which should be referenced.

Returns:

reference

resourceTypeId

static String resourceTypeId()

An identifier for this resource which supports CustomFields.

Returns:

ID of this resource type

See Also:

TypeDraft.getResourceTypeIds(), Custom

getCustom

@Nullable
CustomFields getCustom()

Specified by:

getCustom in interface Custom