Orbit supplies a current status for tours, shipments and orders. Statuses are updated in lockstep:
| Tour Status | Shipment Status | Order Status | Description |
|---|
| – | – | requested | Order is requested, no shipment and no tour created yet. |
| – | Unrouted | confirmed | Order is confirmed, shipment is created but not routed on a tour yet. |
| Unassigned | Routed | confirmed | Tour is created from shipment, not assigned to a carrier yet. |
| Assigned | Routed | confirmed | Tour is assigned to a carrier. |
| Running | EnroutePickup | confirmed | Tour is started. More detailed tour status can be obtained from "substatus" property. Shipment status is updated. |
| Running | EnrouteDropoff | confirmed | Shipment pickup stop is reached on tour, shipment status is updated. |
| WaitingForReview | WaitingForReview | WaitingForReview | Tour is finished and waiting for review. Shipment and Order status are updated to “WaitingForReview”. |
| Completed | Delivered | completed | Tour is reviewed. No effects on shipment and order status. |
| Trigger | Tour Status | Shipment Status | Order Status | Description |
|---|
| Tour cancelled | Cancelled | Unrouted | confirmed | Tour is cancelled. Shipment is unrouted and can be re-planned on a new tour. Order remains confirmed. |
| Trigger | Tour Status | Shipment Status | Order Status | Description |
|---|
| Tour reset | Assigned | Routed | confirmed | Tour is reset to “Assigned” status. Shipment remains “Routed” on the tour. Logged times and substatus are cleared. |
| Trigger | Tour Status | Shipment Status | Order Status | Description |
|---|
| Tour deleted | (deleted) | Unrouted | confirmed | Tour is deleted. All shipments on the tour are unrouted and can be re-planned. Order remains confirmed. |
| Trigger | Shipment Status | Tour Status | Order Status | Description |
|---|
| Shipment cancelled | Cancelled | (unchanged) | confirmed | Shipment is cancelled. If shipment is on a tour, it is removed from the tour and the tour is rebuilt without it. Order remains confirmed. |
| Trigger | Order Status | Shipment Status | Tour Status | Description |
|---|
| Order cancelled | cancelled | Cancelled | (rebuilt or deleted) | Order is cancelled. All shipments are cancelled. Shipments are removed from their tours. Tours are rebuilt without cancelled shipments or deleted if no shipments remain. |
Scenario 1: Tour Cancellation
| Trigger | Tour Status | All Shipments Status | Order Status | Description |
|---|
| Tour cancelled | Cancelled | Unrouted | confirmed | All shipments on the tour are unrouted and can be re-planned. Orders remain confirmed. |
Scenario 2: One Shipment Cancelled
| Trigger | Tour Status | Cancelled Shipment | Other Shipments | Description |
|---|
| 1 Shipment cancelled | (rebuilt) | Cancelled (removed from tour) | Routed (remain on tour) | Tour is rebuilt without the cancelled shipment. Other shipments remain on the tour. |
Scenario: Order Cancellation
| Trigger | Order Status | All Shipments Status | Tours Status | Description |
|---|
| Order cancelled | cancelled | Cancelled (removed from tours) | (rebuilt or deleted) | All shipments are cancelled and removed from their tours. Tours are rebuilt or deleted. |
