charitable / vendor / square / square / src / Legacy / Models / InventoryState.php

InventoryState.php in Charitable – Donation & Fundraising Platform (Donation Forms, Recurring Donations & Fundraising Campaigns) 1.8.13, at vendor/square/square/src/Legacy/Models/InventoryState.php

112 lines 3.7 KB

Raw Download Zip

1	<?php
2
3	declare(strict_types=1);
4
5	namespace Square\Legacy\Models;
6
7	/**
8	* Indicates the state of a tracked item quantity in the lifecycle of goods.
9	*/
10	class InventoryState
11	{
12	/**
13	* The related quantity of items are in a custom state. READ-ONLY:
14	* the Inventory API cannot move quantities to or from this state.
15	*/
16	public const CUSTOM = 'CUSTOM';
17
18	/**
19	* The related quantity of items are on hand and available for sale.
20	*/
21	public const IN_STOCK = 'IN_STOCK';
22
23	/**
24	* The related quantity of items were sold as part of an itemized
25	* transaction. Quantities in the `SOLD` state are no longer tracked.
26	*/
27	public const SOLD = 'SOLD';
28
29	/**
30	* The related quantity of items were returned through the Square Point
31	* of Sale application, but are not yet available for sale. READ-ONLY:
32	* the Inventory API cannot move quantities to or from this state.
33	*/
34	public const RETURNED_BY_CUSTOMER = 'RETURNED_BY_CUSTOMER';
35
36	/**
37	* The related quantity of items are on hand, but not currently
38	* available for sale. READ-ONLY: the Inventory API cannot move
39	* quantities to or from this state.
40	*/
41	public const RESERVED_FOR_SALE = 'RESERVED_FOR_SALE';
42
43	/**
44	* The related quantity of items were sold online. READ-ONLY: the
45	* Inventory API cannot move quantities to or from this state.
46	*/
47	public const SOLD_ONLINE = 'SOLD_ONLINE';
48
49	/**
50	* The related quantity of items were ordered from a vendor but not yet
51	* received. READ-ONLY: the Inventory API cannot move quantities to or
52	* from this state.
53	*/
54	public const ORDERED_FROM_VENDOR = 'ORDERED_FROM_VENDOR';
55
56	/**
57	* The related quantity of items were received from a vendor but are
58	* not yet available for sale. READ-ONLY: the Inventory API cannot move
59	* quantities to or from this state.
60	*/
61	public const RECEIVED_FROM_VENDOR = 'RECEIVED_FROM_VENDOR';
62
63	/**
64	* Replaced by `IN_TRANSIT` to represent quantities
65	* of items that are in transit between locations.
66	*/
67	public const IN_TRANSIT_TO = 'IN_TRANSIT_TO';
68
69	/**
70	* A placeholder indicating that the related quantity of items are not
71	* currently tracked in Square. Transferring quantities from the `NONE` state
72	* to a tracked state (e.g., `IN_STOCK`) introduces stock into the system.
73	*/
74	public const NONE = 'NONE';
75
76	/**
77	* The related quantity of items are lost or damaged and cannot be
78	* sold.
79	*/
80	public const WASTE = 'WASTE';
81
82	/**
83	* The related quantity of items were returned but not linked to a
84	* previous transaction. Unlinked returns are not tracked in Square.
85	* Transferring a quantity from `UNLINKED_RETURN` to a tracked state (e.g.,
86	* `IN_STOCK`) introduces new stock into the system.
87	*/
88	public const UNLINKED_RETURN = 'UNLINKED_RETURN';
89
90	/**
91	* The related quantity of items that are part of a composition consisting one or more components.
92	*/
93	public const COMPOSED = 'COMPOSED';
94
95	/**
96	* The related quantity of items that are part of a component.
97	*/
98	public const DECOMPOSED = 'DECOMPOSED';
99
100	/**
101	* This state is not supported by this version of the Square API. We recommend that you upgrade the
102	* client to use the appropriate version of the Square API supporting this state.
103	*/
104	public const SUPPORTED_BY_NEWER_VERSION = 'SUPPORTED_BY_NEWER_VERSION';
105
106	/**
107	* The related quantity of items are in transit between locations. READ-ONLY: the Inventory API
108	* cannot currently be used to move quantities to or from this inventory state.
109	*/
110	public const IN_TRANSIT = 'IN_TRANSIT';
111	}
112