Manual da API · Leitura e consulta

Lista manifestos visíveis para a chave

GET/v1/saida/manifestos

Grupo integracao-tms. Chaves de consulta não usam esta listagem ampla; leem o documento. Sem posição de veículo.

Para que serve: lista os manifestos do ambiente da chave, com cursor.

Quando chamar: para conferir ou reconstruir a lista de manifestos que o Veltra tem (por exemplo, numa conciliação). Só a chave do TMS usa esta rota.

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.

Consulta (query)

alteradoDesdetextoopcional
limiteinteiroopcional
de 1 a 200; padrão: 50

Respostas

200application/json

Manifestos

JSON

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

Campos da resposta (9)

Campos

itenslista de objetosobrigatório
itens[].idtexto (uuid)obrigatório
itens[].numerotextoobrigatório
itens[].tipoManifestotexto (lista fixa)obrigatório
Valores: ENTREGA, COLETA, TRANSFERENCIA
itens[].atualizadoEmtexto (data e hora ISO 8601)opcional
itens[].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
itens[].kmChegadainteiro ou nuloopcional
Km do hodômetro na chegada. Nulo quando ainda não foi informado.
mínimo 0
itens[].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
proximoCursortexto ou nuloobrigatório

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

400 (limite ou cursor inválidos), 401, 403 (chave que não é de TMS), 429.

Observações

os três campos de km vêm da viagem (saída da base) mais recente que levou o manifesto e são null para manifesto sem saída de veículo (por exemplo, uma entrega comum sem transferência). Mudar o km não muda atualizadoEm: para saber na hora que o km foi informado, assine o evento veiculo.km_registrado. É só uma lista resumida, sem os documentos. Para a situação de cada documento, use GET /integracao/v1/manifestos/{numeroExterno}. O cursor funciona como o de eventos, com a mesma janela de 5 segundos.

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