square_api_client/models/enums/
inventory_state.rs

1//! Model for InventoryState enum.
2
3use serde::{Deserialize, Serialize};
4
5/// A type of state for the related quantity of items
6#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
7#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
8pub enum InventoryState {
9    /// The related quantity of items are in a custom state. READ-ONLY: the Inventory API cannot
10    /// move quantities to or from this state.
11    Custom,
12    /// The related quantity of items are on hand and available for sale.
13    InStock,
14    /// The related quantity of items were sold as part of an itemized transaction. Quantities in
15    /// the SOLD state are no longer tracked.
16    Sold,
17    /// The related quantity of items were returned through the Square Point of Sale application,
18    /// but are not yet available for sale. READ-ONLY: the Inventory API cannot move quantities to
19    /// or from this state.
20    ReturnedByCustomer,
21    /// The related quantity of items are on hand, but not currently available for sale. READ-ONLY:
22    /// the Inventory API cannot move quantities to or from this state.
23    ReservedForSale,
24    /// The related quantity of items were sold online. READ-ONLY: the Inventory API cannot move
25    /// quantities to or from this state.
26    SoldOnline,
27    /// The related quantity of items were ordered from a vendor but not yet received. READ-ONLY:
28    /// the Inventory API cannot move quantities to or from this state.
29    OrderedFromVendor,
30    ///The related quantity of items were received from a vendor but are not yet available for sale.
31    /// READ-ONLY: the Inventory API cannot move quantities to or from this state.
32    ReceivedFromVendor,
33    /// The related quantity of items are in transit between locations. READ-ONLY*: the Inventory
34    /// API cannot move quantities to or from this state.
35    InTransitTo,
36    /// A placeholder indicating that the related quantity of items are not currently tracked in
37    /// Square. Transferring quantities from the NONE state to a tracked state (e.g., IN_STOCK)
38    /// introduces stock into the system.
39    None,
40    /// The related quantity of items are lost or damaged and cannot be sold.
41    Waste,
42    /// The related quantity of items were returned but not linked to a previous transaction.
43    /// Unlinked returns are not tracked in Square. Transferring a quantity from UNLINKED_RETURN to
44    /// a tracked state (e.g., IN_STOCK) introduces new stock into the system.
45    UnlinkedReturn,
46    /// The related quantity of items that are part of a composition consisting one or more
47    /// components.
48    Composed,
49    /// The related quantity of items that are part of a component.
50    Decomposed,
51    /// This state is not supported by this version of the Square API. We recommend that you upgrade
52    /// the client to use the appropriate version of the Square API supporting this state.
53    SuportedByNewerVersion,
54}
square_api_client/models/enums/inventory_state.rs

square_api_client/models/enums/
inventory_state.rs
