# Dicionário e Fluxo de Estados de Encomendas

Gerado em tempo real a partir do código implementado (OrdersStatusInput / OrdersService) em https://api.superlabel.ca/api/documentation/order-status-flow?lang=pt — volte a descarregar em qualquer altura para obter a versão mais recente.

## Dicionário de estados (`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 |

Âncoras semânticas: out_for_delivery=20, successful=8, entrega falhada=10 (need_rescheduled) / 9 (redelivered_later), rejected_by_recipient=40, cancelled=12, redelivery=11 (rescheduled).

Estados finais: cancelled(12), waiting_for_self_pickup(17), waiting_customer_options(32).

## Dicionário de eventos de rastreio (`status_code` / `tracking_event_key`)

Gerado a partir de TrackingEvent::EVENT_KEY_MAPPING — as mesmas constantes que o sistema em execução aplica a cada payload de rastreio e webhook. As chaves são estáveis: apenas são acrescentadas, nunca renomeadas nem reutilizadas.

| status_code | key |
|---|---|
| 100 | information_submitted |
| 110 | booking_confirmed |
| 120 | awaiting_pickup |
| 200 | pushed_successful |
| 201 | pushed_failed |
| 300 | received |
| 301 | arrival_scan |
| 400 | planned |
| 401 | removed_from_route |
| 402 | route_cancelled |
| 403 | cancelled |
| 410 | rider_assigned |
| 411 | rider_reassigned |
| 412 | rider_assignment_cancelled |
| 430 | in_transit |
| 431 | on_hold |
| 434 | collection_on_hold |
| 432 | customs_clearance |
| 433 | loaded |
| 435 | facility_received |
| 436 | arrived_at_facility |
| 450 | start_delivery |
| 500 | deliver_success |
| 501 | need_rescheduled |
| 502 | redelivered_later |
| 503 | not_delivered |
| 504 | partial_deliver_success |
| 460 | start_pickup |
| 470 | at_device |
| 471 | device_picked_up |
| 472 | device_expired |
| 473 | device_removed |
| 510 | pickuped |
| 512 | repickup_later |
| 513 | not_pickuped |
| 600 | return_to_sender |
| 700 | rejected_by_recipient |
| 800 | package_outbound |

## Fluxo principal de entrega

```mermaid
stateDiagram-v2
    [*] --> new_order: encomenda criada
    new_order --> waiting_to_plan
    waiting_to_plan --> planning
    planning --> already_planned
    planning --> plan_failed
    plan_failed --> waiting_to_plan: replaneamento
    already_planned --> out_for_delivery: motorista inicia a rota
    out_for_delivery --> successful: entregue (POD)
    out_for_delivery --> need_rescheduled: entrega falhada
    out_for_delivery --> redelivered_later: nova tentativa na mesma rota
    out_for_delivery --> rejected_by_recipient: recusada
    redelivered_later --> successful
    redelivered_later --> need_rescheduled
    need_rescheduled --> rescheduled: recolocada em fila
    rescheduled --> waiting_to_plan
    successful --> [*]
```

## Correções de receção de devolução (geradas a partir de ALLOWED_RECEIVE_STATUS_MAP)

Aplicadas quando um volume é fisicamente recebido de novo. A transição `successful --> rescheduled` é o caso de "o estado de entregue pode ser revogado" que os integradores têm de tratar: considere o evento mais recente (id mais elevado) como autoritativo. Quando o envelope de payload está ativado (webhook_payload_envelope=1), estes eventos incluem também `is_correction: true`.

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

## Regras de cancelamento

- Estados canceláveis via API: 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).
- Adicionalmente canceláveis apenas por contas de cliente/funcionário: successful(8).
- As encomendas canceladas são excluídas das consultas de rastreio e nunca são reativadas automaticamente.

## Dicionários de motivos de falha / rejeição

1. Códigos de incidente normalizados (estáveis, apenas aditivos): `incident_reason` nos eventos de rastreio — categorias carrier_* / retailer_* / consignee_* / customs_* / weather / other.
2. Motivos de devolução configuráveis pelo comerciante (texto livre, podem mudar): expostos como `reason` nos payloads de rastreio.

Os integradores devem ramificar a lógica com base em (1) e limitar-se a exibir (2).