Enum
InventoryState
Indicates the state of a tracked item quantity in the lifecycle of goods.
Values
CUSTOM
The related quantity of items are in a custom state. READ-ONLY: the Inventory API cannot move quantities to or from this state. |
IN_
The related quantity of items are on hand and available for sale. |
SOLD
The related quantity of items were sold as part of an itemized
transaction. Quantities in the |
RETURNED_
The related quantity of items were returned through the Square Point of Sale application, but are not yet available for sale. READ-ONLY: the Inventory API cannot move quantities to or from this state. |
RESERVED_
The related quantity of items are on hand, but not currently available for sale. READ-ONLY: the Inventory API cannot move quantities to or from this state. |
SOLD_
The related quantity of items were sold online. READ-ONLY: the Inventory API cannot move quantities to or from this state. |
ORDERED_
The related quantity of items were ordered from a vendor but not yet received. READ-ONLY: the Inventory API cannot move quantities to or from this state. |
RECEIVED_
The related quantity of items were received from a vendor but are not yet available for sale. READ-ONLY: the Inventory API cannot move quantities to or from this state. |
IN_
The related quantity of items are in transit between locations. READ-ONLY*: the Inventory API cannot move quantities to or from this state. |
NONE
A placeholder indicating that the related quantity of items are not
currently tracked in Square. Transferring quantities from the |
WASTE
The related quantity of items are lost or damaged and cannot be sold. |
UNLINKED_
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 |
COMPOSED
Beta
The related quantity of items that are part of a composition consisting one or more components. |
DECOMPOSED
Beta
The related quantity of items that are part of a component. |
SUPPORTED_
Beta
This state is not supported by this version of the Square API. We recommend that you upgrade the client to use the appropriate version of the Square API supporting this state. |