Order Statuses

The following are the possible order statuses. See the order statuses API reference.

Note

Shipwell Orders is the modern order framework that we build new functionality upon and the order framework that is documented in the orders section of the Shipwell Developer Portal. We continue to maintain the strong Orders (Legacy/v2) framework for existing customers that utilize this legacy framework, however functionality documented and described in this orders section does not pertain to Orders (Legacy/v2).

Name	Description
`FILLED`	Represents an order that has been designated for releases to occur and all releases have been completed for all line items. The child orders that have been released from it may or may have not been shipped yet.
`READY`	Represents a specific order that is ready to be shipped but has not been added to any shipments yet.
`NOT_READY`	Represents a specific order that is not ready to be shipped, has been sent to a supplier, and has not been fully released onto shipments. This status is only present for Supplier Portal customers.
`ASSIGNED`	Represents a specific order that is assigned to one or more shipments but none of the shipment the orders are on have begun.
`CANCELED`	Represents a specific order that has been `CANCELED`. This order could have previously been on a shipment and then removed or could have never been on a shipment.
`DISPATCHED`	Represents a specific order that is on its first shipment that is in the status of `DISPATCHED`.
`IN_TRANSIT`	Represents a specific order that has one or more shipments that are in transit and also has one or more shipments assigned not delivered.
`OUT_FOR_DELIVERY`	Represents a specific order that has one all shipments delivered except one shipment remaining that has a shipment `OUT_FOR_DELIVERY` status. This status is done based on a daily job that designates shipments that are identified as being delivered that day but have not been delivered when the job has been run.
`DELIVERED`	Represents a specific order that has all shipments currently assigned as delivered.

Note

The order statuses DISPATCHED, IN_TRANSIT, OUT_FOR_DELIVERY, and DELIVERED are derived from the status of the shipment when an order is on a single shipment. Once an order is on two or more shipments then the order status DISPATCHED only applies to when the initial shipment is dispatched. Further, once an order is on two or more shipments then the order status is IN_TRANSIT until the shipments all have the same status. If all the shipments have the same status then the order will have the same status that all the shipments have. For each shipment OUT_FOR_DELIVERY and DELIVERED do not apply until the last shipment of an order is OUT_FOR_DELIVERY or DELIVERED.

Order Release Statuses

The following are the possible order release statuses. See the order release statuses API reference.

Name	Description
`NEED`	Represents an order release that has been indicated as needed and waiting for the supplier to accept or reject release.
`ACCEPTED`	Represents an order release that has been accepted.
`REJECTED`	Represents an order release that has been identified as rejected.