> For the complete documentation index, see [llms.txt](https://docs.shippify.co/developers/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shippify.co/developers/pt/guia-de-integracao/processos-basicos/atualizacao-de-estados/estados.md).

# Estados

## Ciclo de vida

Para que uma entrega seja completada, ela deve passar por uma série de mudanças de estado, as quais detalhamos na seguinte imagem.

<figure><img src="/files/YYW5WVroEj9L7MoVWfLo" alt=""><figcaption><p>Estados de una entrega</p></figcaption></figure>

### Estados Iniciais

Quando uma entrega é criada no sistema, ela pode ser criada com o estado 'Processando', o que significa que a tarefa foi criada com sucesso e está pronta para ser atribuída. Quando é criada como 'Pendente de Revisão', significa que houve um erro na geolocalização, seja no endereço de coleta ou de entrega, e é necessário que um operador corrija o endereço para que possa passar para o estado 'Processando' e continuar o fluxo."

### Atrelar&#x20;

Para vincular uma entrega a um motorista, existem duas opções: colocá-la no estado de 'Transmissão' (a entrega é publicada na rede de motoristas para que um deles a aceite no aplicativo móvel) ou atribuí-la diretamente a um motorista (este processo é realizado por um operador no painel, e ao atribuí-la, não significa que o motorista aceitou a tarefa).

### Coleta

Quando um motorista aceita a entrega pelo aplicativo móvel ou quando um operador a atribui pelo painel e o motorista a aceita no aplicativo, ela passa para 'Confirmado para Coleta'. Após confirmar a coleta, o motorista indica no aplicativo quando está a caminho para a coleta. Por fim, ao chegar ao armazém, o motorista marca no aplicativo que já está no ponto de coleta. Durante todo esse processo, o motorista pode rejeitar a entrega, alterando seu estado para 'Não Coletado'.

### **Coleta sem sucesso**

Durante todo esse processo de coleta, o motorista pode rejeitar a entrega, alterando seu estado para 'Não Coletado', deixando assim a entrega sem motorista atribuído. Sob esse estado, podem ser configuradas razões para descrever o motivo da mudança ou rejeição, como problemas com o veículo

### Entrega

Quando o motorista já está na bodega, procede-se à digitalização e verificação dos pacotes da entrega. No caso de a entrega pertencer a uma rota, o mesmo processo deve ser realizado para cada uma. Durante este processo, a tarefa está com o estado 'Em Entrega'. Após a conclusão da verificação, ela passa para 'A Caminho da Entrega' e posteriormente para 'No Ponto de Entrega' quando chegar ao endereço acordado.

### Entrega **sem sucesso**

Durante todo esse processo de entrega, o motorista pode optar por não concluir a entrega, alterando o status para 'Em Resguardo pelo Motorista'. Nesse estado, podem ser configuradas razões para descrever o motivo da alteração, como, por exemplo, o cliente não estar no local de entrega. O motorista pode tentar a entrega novamente até um máximo de 3 vezes. Se conseguir realizar a entrega, a tarefa continua no fluxo verde. Caso contrário, segue o fluxo vermelho, que devolve o pacote à bodega, marcando a entrega como retornada.

### Estados Finais

Após realizar a entrega dos pacotes ao destinatário, é solicitado no aplicativo comprovantes de entrega, como fotos ou assinatura da pessoa que recebe o pacote. Uma vez entregues os comprovantes, a tarefa muda para o estado 'Completado', finalizando assim o ciclo de vida da tarefa.

### Cancelamento

Em qualquer etapa do fluxo, a entrega pode ser cancelada, seja por integração externa do API ou no painel. Ao cancelar, a entrega fica sem motorista atribuído. Sob este estado, podem ser configuradas razões para descrever o motivo da mudança, por exemplo, cliente cancelou o pedido.

## **Códigos de estado**

<table><thead><tr><th>Estado da entrega</th><th>Código</th><th width="321">Descrição</th></tr></thead><tbody><tr><td>Pendente de revisão</td><td>pending_to_review</td><td>Uma entrega é criada com informações ausentes de coleta ou entrega (contato, localização) e precisa ser revisada.</td></tr><tr><td>Processando</td><td>processing</td><td>Uma entrega é criada com sucesso na plataforma.</td></tr><tr><td>Buscando motorista</td><td>broadcasting</td><td>Uma entrega foi publicada na rede de motoristas.</td></tr><tr><td>Atrelada</td><td>assigned</td><td>Uma entrega foi atribuída a um motorista.</td></tr><tr><td>Confirmado para coleta</td><td>confirmed_to_pickup</td><td>A entrega foi confirmada para ser realizada por um motorista.</td></tr><tr><td>Em caminho para coleta</td><td>going_to_pickup</td><td>O motorista está a caminho do local de coleta.</td></tr><tr><td>No ponto de coleta</td><td>at_pickup</td><td>Um motorista está no local de coleta.</td></tr><tr><td>Em entrega</td><td>on_delivery</td><td>Motorista a caminho da entrega.</td></tr><tr><td>Em rota de entrega</td><td>going_to_dropoff</td><td>Um motorista está a caminho do endereço de entrega.</td></tr><tr><td>No ponto de entrega</td><td>at_dropoff</td><td>Um motorista está no endereço de entrega.</td></tr><tr><td>Entregue</td><td>dropped_off</td><td>Um motorista está aguardando o comprovante de entrega (foto, assinatura, dados do destinatário).</td></tr><tr><td>Completado</td><td>completed</td><td>Um motorista concluiu com êxito uma entrega.</td></tr><tr><td>Cancelado</td><td>canceled</td><td>Uma entrega foi cancelada.</td></tr><tr><td>Em rota de devolução</td><td>going_to_return</td><td>Um motorista está a caminho do local de coleta para devolver uma entrega.</td></tr><tr><td>No ponto de devolução</td><td>at_return_point</td><td>Um motorista está no local de coleta para devolver uma entrega.</td></tr><tr><td>Devolvido</td><td>returned</td><td>Um motorista devolveu com sucesso uma entrega.</td></tr><tr><td>Não coletado</td><td>not_picked_up</td><td>Um motorista informou que uma entrega não foi coletada.</td></tr><tr><td>Não coletado cobrável</td><td>not_picked_up_payable</td><td>Um motorista informou que uma entrega não foi coletada, mas será remunerado.</td></tr><tr><td>Em pose do motorista</td><td>hold_by_courier</td><td>Uma entrega está retida pelo motorista atribuído até que uma nova tentativa seja feita ou seja devolvida ao endereço de coleta.</td></tr></tbody></table>

## **Motivos e problemas**&#x20;

Se precisar especificar a razão pela qual uma tarefa mudou para um estado, você pode configurar, no estado de sua preferência, os motivos desejados. Esses motivos explicarão ou fornecerão mais detalhes sobre a mudança. Se em seu sistema externo houver um estado que não exista em nossa lista, você pode vinculá-lo ao mais semelhante e criar um motivo que o identifique melhor. Geralmente, esses motivos são adicionados aos estados de "retido pelo motorista" e "cancelado".

### &#x20;Exemplos

<table><thead><tr><th width="195">Estado na Shippify</th><th>Motivos</th><th>Estados Externos</th></tr></thead><tbody><tr><td>hold_by_courier</td><td>Recusado pelo cliente</td><td>Recusado pelo cliente</td></tr><tr><td>hold_by_courier</td><td>Cliente ausente</td><td>Cliente ausente</td></tr><tr><td>canceled</td><td>Pacote perdido</td><td>Pacote perdido</td></tr><tr><td>canceled</td><td>Cancelado pelo cliente</td><td>Cliente cancelou</td></tr></tbody></table>

### Criação

Pode criar esses motivos dentro do painel, acessando [este link](https://dash.shippify.co/settings/sections/deliveries/status-info). Aqui você encontra razões do sistema que pode reutilizar e, caso não encontre a indicada, pode criá-la.&#x20;

#### Pasos

1. Entre [neste link](https://dash.shippify.co/settings/sections/deliveries/status-info).
2. Selecione um estado.
3. Revisa se não existe no sistema um motivo similar ao teu. Se existir, adiciona-o à tua companhia; caso contrário, crie um.

<figure><img src="/files/zQqhfRPX49u4zoNVhlyY" alt=""><figcaption><p>Motivos de problemas de entrega</p></figcaption></figure>

## Link de estados com plataforma externa

Já que você conhece os estados e motivos dentro do nosso sistema, pode proceder a vinculá-los com o seu sistema. Para ter uma visão melhor disso, você pode seguir o exemplo da nossa documentação [nesta plantilla](https://docs.google.com/spreadsheets/d/1UIZlIxcRq-iOfRq9-VyE8jzF9FKl-oEJ04Yxwt3n4JI/edit?usp=sharing) e preencher-la.&#x20;

Aqui você encontrará uma tabela na qual você deve preencher as informações dos estados em seu sistema e como seriam equivalentes no Shippify.

<figure><img src="/files/ufw5tvO1VwbiuTjXyaM2" alt=""><figcaption><p>Plantilla</p></figcaption></figure>

### Passos

1. Liste os estados da sua plataforma na coluna azul.
2. Encontre o estado equivalente no Shippify. Você pode se ajudar fazendo as seguintes perguntas:
   1. É um estado que ocorre antes da coleta dos pacotes no depósito?
      * [Quando é recém criado/agendado?](#estados-iniciales)
      * [Quando está procurando motorista?](#asignacion)
   2. [É um estado que ocorre durante o processo de coleta?](#recoleccion)
   3. [É um estado que ocorre durante o processo de entrega?](#entrega)
   4. É um estado que indica que aconteceu algum problema?
      * [No processo de coleta](#recoleccion-fallida)
      * [No processo de entrega](#entrega-fallida)
      * [Geral](#cancelacion)
   5. [É um estado que indica que a entrega foi feita com sucesso?](#estados-finales)
3. Se você precisar de mais detalhes para um estado ou se o mesmo estado na Shippify corresponder a dois ou mais estados da sua plataforma, então [adicione motivos à esse estado.](#motivos-de-problemas)

Quando já tiver sua tabela preenchida, poderá continuar a configurar a [sincronização de estados](/developers/pt/guia-de-integracao/processos-basicos/atualizacao-de-estados.md) no seu sistema.