Manual da API · Leitura e consulta

Baixa o pacote de evidências quando o escopo autorizar

GET/v1/saida/comprovantes/{id}/pacote

Só a chave do TMS baixa o pacote ZIP. Comprovante inexistente responde 404 e comprovante ainda não publicado responde 409, ambos em application/problem+json.

Para que serve: baixa o pacote de evidências (arquivo ZIP) do comprovante: o PDF, o manifesto da evidência e os arquivos de apoio (as fotos, e os arquivos de validação quando existem).

Quando chamar: quando você precisa guardar a prova completa de uma entrega, por exemplo para auditoria ou para anexar numa disputa. 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/zip

Pacote ZIP

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.

404application/problem+json

Comprovante inexistente neste ambiente (COMPROVANTE_NAO_ENCONTRADO, no campo codigo).

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.

409application/problem+json

Comprovante ainda não publicado (COMPROVANTE_AINDA_NAO_PUBLICADO, no campo codigo).

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

os mesmos do PDF: 401, 403, 429, 404 (COMPROVANTE_NAO_ENCONTRADO) para comprovante inexistente e 409 (COMPROVANTE_AINDA_NAO_PUBLICADO) para comprovante ainda não publicado, ambos em application/problem+json.

Observações

o ZIP traz um arquivo LEIA-ME.txt que explica o conteúdo. Se uma foto ainda não estiver disponível, o pacote não é entregue e a resposta é um erro: tente depois.

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