Indicates the state of a tracked item quantity in the lifecycle of goods.
InventoryState
| Name | Description |
|---|---|
CUSTOM |
The related quantity of items are in a custom state. READ-ONLY: the Inventory API cannot move quantities to or from this state. |
INSTOCK |
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 SOLD state are no longer tracked. |
RETURNEDBYCUSTOMER |
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. |
RESERVEDFORSALE |
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. |
SOLDONLINE |
The related quantity of items were sold online. READ-ONLY: the Inventory API cannot move quantities to or from this state. |
ORDEREDFROMVENDOR |
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. |
RECEIVEDFROMVENDOR |
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. |
INTRANSITTO |
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 NONE stateto a tracked state (e.g., IN_STOCK) introduces stock into the system. |
WASTE |
The related quantity of items are lost or damaged and cannot be sold. |
UNLINKEDRETURN |
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 UNLINKED_RETURN to a tracked state (e.g.,IN_STOCK) introduces new stock into the system. |