5.13. Download de Documentos¶
🔗 Endpoint¶
| Método | URL |
|---|---|
/public/v1/nota-comercial/{id}/documentos/download |
🧾 Descrição¶
Baixa todos os documentos vinculados a uma Nota Comercial compactados em um arquivo .zip. Inclui minutas, documentos das partes, comprovantes de garantias e demais arquivos associados à operação.
🔹 Path Parameter¶
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id | integer | Identificador único da NC |
🧪 Exemplo de cURL¶
curl -X GET https://api.vehub.com.br/public/v1/nota-comercial/100/documentos/download \
-H "Authorization: Bearer {seu_token}" \
-H "GrupoEconomico: {seu_grupo_economico}" \
--output documentos-nc-100.zip
📥 Responses¶
✅ 200 OK¶
Retorna o arquivo .zip com todos os documentos da NC.
| Header | Valor |
|---|---|
Content-Type | application/zip |
Content-Disposition | attachment; filename="documentos-nc-{id}.zip" |
Estrutura do arquivo ZIP:
documentos-nc-100.zip
├── minutas/
│ └── minuta-nota-comercial.pdf
├── emitente/
│ ├── contrato-social.pdf
│ └── documento-representante.pdf
├── garantias/
│ └── cessao-fiduciaria.pdf
└── comprovantes/
└── comprovante-pagamento-parcela-1.pdf
❌ 404 Not Found¶
{
"tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
"titulo": "Não encontrado",
"status": 404,
"erros": ["Nota Comercial não encontrada."]
}
❌ 422 Unprocessable Entity¶
{
"tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.21",
"titulo": "Sem documentos",
"status": 422,
"erros": ["A Nota Comercial não possui documentos vinculados para download."]
}