Acompanhamento da remessa

Depois que uma remessa é criada, o cliente ou integrador precisa acompanhar sua evolução para informar a operação e atender às necessidades do destinatário. A API de rastreio de pedidos reúne os dados necessários para essa consulta em um único recurso.

O papel da API de rastreio de pedidos

A remessa pode ser consultada pela referência do pedido ou pelo identificador da remessa. A resposta apresenta:

• o status atual da remessa;
• o histórico completo de movimentações;

O endpoint principal dessa capacidade é:

GET /logistic/tracking/v1/shipment

A consulta aceita exatamente um dos identificadores disponíveis:

• reference, para localizar a remessa a partir do pedido;
• code_id, para localizar a remessa pelo identificador da Magalog.

Quando usar

Use a API de rastreio de pedidos quando o ERP, Hub ou sistema do cliente precisar:

• exibir o histórico de movimentações;
• verificar a situação de uma remessa a partir do pedido ou do identificador logístico.

A API não fornece uma URL de rastreio. O cliente ou integrador deve construir a tela de acompanhamento no próprio sistema com o status atual e o histórico retornados pela consulta.

Possíveis status de retorno

O campo code identifica o status da remessa. A API pode retornar os seguintes valores:

Código	Significado
SHIPPING_CREATED	Remessa criada no sistema.
IN_PREPARATION	Remessa em preparação, aguardando informações ou processos internos, como Nota Fiscal ou volumes.
WAITING_INVOICE	Aguardando emissão ou associação da Nota Fiscal à remessa.
WAITING_STOCK_OPERATION	Aguardando uma operação de estoque, como separação, conferência ou movimentação do pedido.
WAITING_POST	Aguardando a postagem da remessa.
POSTED	Remessa postada.
READY_TO_SHIP	Remessa pronta para envio.
ACCEPTED	Transportadora confirmou que assumirá a operação ou coleta da remessa.
REJECTED	Remessa rejeitada pela transportadora ou pelo fluxo operacional.
WAITING_PICKUP	Aguardando a chegada do transportador para coleta.
PICKED_UP	Coleta realizada com sucesso.
PICKED_FAILURE	Falha na tentativa de coleta da remessa.
IN_TRANSIT	Remessa em trânsito entre unidades ou localidades.
IN_ROUTE_PICKUP	Transportador em rota para realizar a coleta ou retirada da remessa.
IN_ROUTE_DELIVERY	Remessa em rota de entrega para o destinatário.
WAITING_WITHDRAW	Aguardando a retirada da remessa pelo destinatário ou responsável.
WITHDRAWN	Remessa retirada com sucesso.
DELIVERED	Entrega realizada com sucesso.
DELIVERY_FAILURE	Falha na tentativa de entrega.
TRANSPORT_PROBLEM	Problema identificado durante o transporte da remessa.
DIRECTED_TO_RETURN	Remessa encaminhada para devolução.
DIRECTED_TO_REFUND	Remessa encaminhada para reembolso ou estorno.
IN_CANCELLATION	Cancelamento da remessa em andamento.
CANCELED	Remessa cancelada.
REFATURATED	Remessa refaturada ou com a documentação fiscal atualizada.
REVERSE_MANUALLY_COMPLETED	Processo de logística reversa concluído manualmente.
AUTHORIZATION_CODE_EXPIRED	Código de autorização expirado.
AUTHORIZATION_CODE_CANCELLED	Código de autorização cancelado.

Essa consulta apoia o acompanhamento da remessa. Os parâmetros, respostas, escopos e exemplos estão na API de rastreio de pedidos.