# Order Status Dictionary & Flow

Generated live from the deployed code (OrdersStatusInput / OrdersService) at https://api.xlcourier.com/api/documentation/order-status-flow — re-download any time for the latest version.

## Status dictionary (`orders_status_id`)

| id | key |
|---|---|
| 1 | need_update_address |
| 2 | new_order |
| 3 | waiting_to_plan |
| 4 | planning |
| 5 | already_planned |
| 6 | plan_failed |
| 7 | already_pickup |
| 8 | successful |
| 9 | redelivered_later |
| 10 | need_rescheduled |
| 11 | rescheduled |
| 12 | cancelled |
| 14 | already_pickup |
| 16 | need_to_pick_up |
| 17 | waiting_for_self_pickup |
| 18 | self_pickup_completed |
| 19 | return_to_customer |
| 20 | out_for_delivery |
| 21 | out_for_pickup |
| 22 | partial_received |
| 23 | partial_delivered |
| 24 | partial_pickuped |
| 25 | hand_off |
| 26 | review |
| 27 | destroyed |
| 28 | need_convert_to_3rd_party_label |
| 29 | in_transit |
| 30 | package_lost |
| 31 | package_damaged |
| 32 | waiting_customer_options |
| 33 | handed_over_to_the_third_party_carrier |
| 34 | waiting_batch_pickup |
| 35 | payment_required |
| 36 | bulk_transshipment_pending |
| 37 | bulk_transshipment_in_transit |
| 38 | bulk_transshipment_pending_inbound |
| 39 | inbound_scan_required |
| 40 | rejected_by_recipient |
| 41 | package_outbound |
| 42 | waiting_for_quote |
| 43 | waiting_third_party_handover |
| 44 | waiting_for_assignment |
| 45 | start_pickup |
| 46 | start_delivery |

Semantic anchors: out_for_delivery=20, successful=8, delivery failed=10 (need_rescheduled) / 9 (redelivered_later), rejected_by_recipient=40, cancelled=12, redelivery=11 (rescheduled).

Final statuses: cancelled(12), waiting_for_self_pickup(17), waiting_customer_options(32).

## Tracking-event dictionary (`status_code` / `tracking_event_key`)

Generated from TrackingEvent::EVENT_KEY_MAPPING — the same constants the runtime stamps on every tracking payload and webhook. Keys are stable: only ever added, never renamed or reused.

| status_code | key |
|---|---|
| 100 | information_submitted |
| 110 | booking_confirmed |
| 120 | awaiting_pickup |
| 300 | received |
| 301 | arrival_scan |
| 400 | planned |
| 401 | removed_from_route |
| 402 | route_cancelled |
| 410 | rider_assigned |
| 411 | rider_reassigned |
| 412 | rider_assignment_cancelled |
| 450 | start_delivery |
| 500 | deliver_success |
| 501 | need_rescheduled |
| 502 | redelivered_later |
| 503 | not_delivered |
| 460 | start_pickup |
| 510 | pickuped |
| 512 | repickup_later |
| 513 | not_pickuped |
| 600 | return_to_sender |
| 700 | rejected_by_recipient |
| 800 | package_outbound |

## Main delivery flow

```mermaid
stateDiagram-v2
    [*] --> new_order: order created
    new_order --> waiting_to_plan
    waiting_to_plan --> planning
    planning --> already_planned
    planning --> plan_failed
    plan_failed --> waiting_to_plan: re-plan
    already_planned --> out_for_delivery: driver starts route
    out_for_delivery --> successful: delivered (POD)
    out_for_delivery --> need_rescheduled: delivery failed
    out_for_delivery --> redelivered_later: retry same route
    out_for_delivery --> rejected_by_recipient: refused
    redelivered_later --> successful
    redelivered_later --> need_rescheduled
    need_rescheduled --> rescheduled: re-queued
    rescheduled --> waiting_to_plan
    successful --> [*]
```

## Receive-back corrections (generated from ALLOWED_RECEIVE_STATUS_MAP)

Applied when a package is physically received again. The `successful --> rescheduled` edge is the "delivered status can be revoked" case integrators must handle: treat the newest event (highest id) as authoritative. When the payload envelope is enabled (webhook_payload_envelope=1), such events also carry `is_correction: true`.

```mermaid
stateDiagram-v2
    in_transit --> new_order: received back
    package_outbound --> new_order: received back
    need_to_pick_up --> new_order: received back
    waiting_batch_pickup --> new_order: received back
    already_pickup --> new_order: received back
    out_for_pickup --> new_order: received back
    partial_received --> new_order: received back
    partial_pickuped --> new_order: received back
    already_pickup --> already_pickup: received back
    waiting_customer_options --> waiting_customer_options: received back
    out_for_delivery --> rescheduled: received back
    hand_off --> rescheduled: received back
    redelivered_later --> rescheduled: received back
    need_rescheduled --> rescheduled: received back
    rescheduled --> rescheduled: received back
    successful --> rescheduled: received back
    handed_over_to_the_third_party_carrier --> successful: received back
    bulk_transshipment_in_transit --> new_order: received back
    bulk_transshipment_pending_inbound --> new_order: received back
    inbound_scan_required --> new_order: received back
    package_damaged --> review: received back
    package_lost --> review: received back
```

## Cancel rules

- API-cancellable statuses: need_update_address(1), new_order(2), already_planned(5), redelivered_later(9), need_rescheduled(10), rescheduled(11), cancelled(12), plan_failed(6), status_15(15), already_pickup(7), already_pickup(14), need_to_pick_up(16), waiting_for_self_pickup(17), self_pickup_completed(18), return_to_customer(19), out_for_delivery(20), out_for_pickup(21), partial_received(22), partial_delivered(23), partial_pickuped(24), hand_off(25), review(26), destroyed(27), need_convert_to_3rd_party_label(28), in_transit(29), inbound_scan_required(39), payment_required(35).
- Additionally cancellable by client/employee accounts only: successful(8).
- Cancelled orders are excluded from tracking lookups and never auto-revived.

## Failure / rejection reason dictionaries

1. Normalized incident codes (stable, additive-only): `incident_reason` on tracking events — carrier_* / retailer_* / consignee_* / customs_* / weather / other categories.
2. Merchant-configurable return reasons (free text, may change): exposed as `reason` in tracking payloads.

Integrators should branch on (1) and only display (2).