InventoryState enum

Indicates the state of a tracked item quantity in the lifecycle of goods.

Inheritance
Available extensions

Values

custom → const InventoryState

The related quantity of items are in a custom state. READ-ONLY

inStock → const InventoryState

The related quantity of items are on hand and available for sale.

sold → const InventoryState

The related quantity of items were sold as part of an itemized transaction. Quantities in the sold state are no longer tracked.

returnedByCustomer → const InventoryState

The related quantity of items were returned through the Square Point of Sale application, but are not yet available for sale. READ-ONLY

reservedForSale → const InventoryState

The related quantity of items are on hand, but not currently available for sale. READ-ONLY

soldOnline → const InventoryState

The related quantity of items were sold online. READ-ONLY

orderedFromVendor → const InventoryState

The related quantity of items were ordered from a vendor but not yet received. READ-ONLY

receivedFromVendor → const InventoryState

The related quantity of items were received from a vendor but are not yet available for sale. READ-ONLY

inTransitTo → const InventoryState

The related quantity of items are in transit between locations. READ-ONLY

none → const InventoryState

A placeholder indicating that the related quantity of items are not currently tracked in Square. Transferring quantities from the none state to a tracked state (e.g., inStock) introduces stock into the system.

waste → const InventoryState

The related quantity of items are lost or damaged and cannot be sold.

unlinkedReturn → const InventoryState

The related quantity of items were returned but not linked to a previous transaction. Unlinked returns are not tracked in Square. Transferring a quantity from unlinkedReturn to a tracked state (e.g., inStock) introduces new stock into the system.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<InventoryState>
A constant List of the values in this enum, in order of their declaration.