Status values
Was this page helpful?
Status values
What each order status, stock state and movement type means.
Overview
These are the fixed values the API uses in status and type fields. New values can be added, so your code should handle one it does not know.
Order status
| Value | Meaning |
|---|---|
placed | The order has arrived. |
processing | It is being prepared. |
shipped | It has left the warehouse. |
out_for_delivery | It is with the courier for delivery. |
delivered | The customer has it. |
cancelled | It was cancelled. |
returned | It came back. |
lost | It was lost in transit. |
Shipment status
| Value | Meaning |
|---|---|
packing | Being packed. |
packed | Packed and waiting for the courier. |
dispatched | Handed to the courier. |
cancelled | The parcel was cancelled. |
Stock states
| Value | Meaning | Counts as on hand |
|---|---|---|
available | Free to sell. | Yes |
committed | Held for orders. | Yes |
qc_hold | Waiting for a quality check. | Yes |
damaged | Not sellable. | Yes |
quarantine | Expired, recalled or not found. | Yes |
reserved | Kept aside by hand. | Yes |
incoming | Ordered from a supplier. | No |
in_transit | On the way between warehouses. | No |
Movement types
| Value | Meaning |
|---|---|
OPEN | Opening stock. |
INC | Units expected from a supplier, or no longer expected. |
RCV | Received from a supplier. |
QCP | Passed a quality check. |
QCF | Failed a quality check. |
PUT | Put away into a bin. |
MOV | Moved between bins. |
RSV | Reserved by hand. |
URS | Reservation released. |
ALC | Held for an order. |
DAL | Released from an order. |
PCK | Picked for an order. |
DSP | Dispatched to a customer. |
RTI | Returned by a customer. |
TRO | Sent on a transfer. |
TRI | Received from a transfer. |
TRL | Lost on a transfer. |
ADJ | Adjusted. |
CNT | Changed by a stock count. |
CHA | Changed on a channel. |
QRN | Moved to quarantine. |
QRL | Released from quarantine. |
SCR | Scrapped. |
RTV | Returned to a supplier. |
KAS | Used in or made by assembling a kit. |
KDS | Used in or made by taking a kit apart. |
DCO | Sent out on a delivery challan. |
DCI | Came back from a delivery challan. |
Warehouse kind
| Value | Meaning |
|---|---|
own | A warehouse you run. |
store | A store or outlet. |
3pl | Run for you by a logistics partner. |
channel_fulfilled | Stock held by a channel, such as Amazon FBA. It is read-only. |
Movement ends
The kind in a movement's from and to.
| Value | Meaning |
|---|---|
warehouse | One of your warehouses. |
supplier | A supplier. |
customer | A customer. |
transit | On the way. |
adjustment | A correction, with no physical place. |
scrap | Thrown away. |
channel | A sales channel. |