Manual da API · Leitura e consulta

Obtém um manifesto da leitura de saída

GET/v1/saida/manifestos/{id}

Grupo integracao-tms. Sem trilha nem posição do veículo para terceiros.

Para que serve: mostra um manifesto pelo id do Veltra.

Quando chamar: quando você tem o id (da resposta do envio) e quer o resumo. Só a chave do TMS usa.

Parâmetros

Cabeçalhos (header)

X-Veltra-Api-Keytextoobrigatório
Chave de API do TMS. Emitida na tela Chaves de API do portal; o valor completo aparece uma única vez.

Caminho (path)

idtexto (uuid)obrigatório

Respostas

200application/json

Manifesto

JSON

{
  "id": "0192f3a4-5b6c-7d8e-9f01-23456789abcd",
  "numero": "texto",
  "tipoManifesto": "ENTREGA",
  "atualizadoEm": "2026-11-06T09:15:00-03:00",
  "kmSaida": 0,
  "kmChegada": 0,
  "kmRodados": 0
}

Campos da resposta (7)

Campos

idtexto (uuid)obrigatório
numerotextoobrigatório
tipoManifestotexto (lista fixa)obrigatório
Valores: ENTREGA, COLETA, TRANSFERENCIA
atualizadoEmtexto (data e hora ISO 8601)opcional
kmSaidainteiro ou nuloopcional
Km do hodômetro na saída do veículo da base. Nulo quando o motorista não informou.
mínimo 0
kmChegadainteiro ou nuloopcional
Km do hodômetro na chegada. Nulo quando ainda não foi informado.
mínimo 0
kmRodadosinteiro ou nuloopcional
kmChegada - kmSaida. Nulo quando falta um dos dois ou quando a chegada é menor que a saída (anomalia de km). Mudanças de km não alteram atualizadoEm; acompanhe o evento veiculo.km_registrado.
mínimo 0

403application/problem+json

CHAVE_SUSPENSA (no campo codigo): a chave de consulta está suspensa porque o add-on foi desligado. A chave não foi revogada e volta a funcionar quando o add-on for contratado de novo.

JSON

{
  "type": "https://exemplo.com.br/webhook-veltra",
  "title": "texto",
  "status": 1,
  "detail": "texto",
  "instance": "https://exemplo.com.br/webhook-veltra",
  "codigo": "ASAAS_RECUSOU"
}

Campos da resposta (6)

Campos

typetextoobrigatório
titletextoobrigatório
statusinteiroobrigatório
detailtextoopcional
instancetextoopcional
codigotextoopcional
Código estável do problema para o cliente decidir o tratamento (ex.: ASAAS_RECUSOU, FATURA_NAO_ENCONTRADA, PAGINACAO_INVALIDA). Ausente quando o erro não tem código próprio.

Erroapplication/problem+json

Erro no formato RFC 9457 (application/problem+json)

JSON

{
  "type": "https://exemplo.com.br/webhook-veltra",
  "title": "texto",
  "status": 1,
  "detail": "texto",
  "instance": "https://exemplo.com.br/webhook-veltra",
  "codigo": "ASAAS_RECUSOU"
}

Campos da resposta (6)

Campos

typetextoobrigatório
titletextoobrigatório
statusinteiroobrigatório
detailtextoopcional
instancetextoopcional
codigotextoopcional
Código estável do problema para o cliente decidir o tratamento (ex.: ASAAS_RECUSOU, FATURA_NAO_ENCONTRADA, PAGINACAO_INVALIDA). Ausente quando o erro não tem código próprio.

Guia explicado

O que fazer: erros

401, 403, 404 (não existe neste ambiente ou é de outra transportadora), 400 (id que não é um UUID), 429.

Observações

não traz trilha nem posição do veículo.

Texto completo, com mais exemplos, em API por rota.