Interface InventoryEntry

interface InventoryEntry {
    availableQuantity: number;
    createdAt: string;
    createdBy?: CreatedBy;
    custom?: CustomFields;
    expectedDelivery?: string;
    id: string;
    key?: string;
    lastModifiedAt: string;
    lastModifiedBy?: LastModifiedBy;
    quantityOnStock: number;
    restockableInDays?: number;
    sku: string;
    supplyChannel?: ChannelReference;
    version: number;
}

Hierarchy (view full)

Properties

availableQuantity createdAt createdBy? custom? expectedDelivery? id key? lastModifiedAt lastModifiedBy? quantityOnStock restockableInDays? sku supplyChannel? version

Properties

Readonly availableQuantity

availableQuantity: number

Available amount of stock (quantityOnStock - reserved).

Readonly createdAt

createdAt: string

Date and time (UTC) the InventoryEntry was initially created.

Optional Readonly createdBy

createdBy?: CreatedBy

IDs and references that created the InventoryEntry.

Optional Readonly custom

custom?: CustomFields

Custom Fields of the InventoryEntry.

Optional Readonly expectedDelivery

expectedDelivery?: string

Date and time of the next restock.

Readonly id

id: string

Unique identifier of the InventoryEntry.

Optional Readonly key

key?: string

User-defined unique identifier of the InventoryEntry.

Readonly lastModifiedAt

lastModifiedAt: string

Date and time (UTC) the InventoryEntry was last updated.

Optional Readonly lastModifiedBy

lastModifiedBy?: LastModifiedBy

IDs and references that last modified the InventoryEntry.

Readonly quantityOnStock

quantityOnStock: number

Overall amount of stock (availableQuantity + reserved).

Optional Readonly restockableInDays

restockableInDays?: number

How often the InventoryEntry is restocked (in days).

Readonly sku

sku: string

ProductVariant sku of the InventoryEntry.

Optional Readonly supplyChannel

supplyChannel?: ChannelReference

Channel that supplies this InventoryEntry.

Readonly version

version: number

Current version of the InventoryEntry.

Settings

Member Visibility

Theme

On This Page

availableQuantitycreatedAtcreatedBycustomexpectedDeliveryidkeylastModifiedAtlastModifiedByquantityOnStockrestockableInDaysskusupplyChannelversion