Enum InventoryState

pub enum InventoryState {
    Custom,
    InStock,
    Sold,
    ReturnedByCustomer,
    ReservedForSale,
    SoldOnline,
    OrderedFromVendor,
    ReceivedFromVendor,
    InTransitTo,
    None,
    Waste,
    UnlinkedReturn,
    Composed,
    Decomposed,
    SuportedByNewerVersion,
}

A type of state for the related quantity of items

Variants

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 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.

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.

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.

SuportedByNewerVersion

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.

Trait Implementations

impl Clone for InventoryState

fn clone(&self) -> InventoryState

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InventoryState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InventoryState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for InventoryState

fn eq(&self, other: &InventoryState) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for InventoryState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for InventoryState

impl StructuralPartialEq for InventoryState