inventory-state.md

Inventory State

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

Enumeration

Inventory State

Fields

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.
IN_STOCK	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.
RETURNED_BY_CUSTOMER	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_FOR_SALE	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_ONLINE	The related quantity of items were sold online. READ-ONLY: the Inventory API cannot move quantities to or from this state.
ORDERED_FROM_VENDOR	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_FROM_VENDOR	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_TRANSIT_TO	Replaced by IN_TRANSIT to represent quantities of items that are in transit between locations.
NONE	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., IN_STOCK) introduces stock into the system.
WASTE	The related quantity of items are lost or damaged and cannot be sold.
UNLINKED_RETURN	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.
COMPOSED	The related quantity of items that are part of a composition consisting one or more components.
DECOMPOSED	The related quantity of items that are part of a component.
SUPPORTED_BY_NEWER_VERSION	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.
IN_TRANSIT	The related quantity of items are in transit between locations. READ-ONLY: the Inventory API cannot currently be used to move quantities to or from this inventory state.