Baixar anexo
O arquivo de um anexo do pedido — comprovante, etiqueta, nota fiscal.
Quando usar
Para trazer ao seu sistema os documentos do pedido: a etiqueta e a nota fiscal que a OTL
anexa, ou o comprovante que o parceiro enviou. A lista dos anexos (com id, tipo e
nomeArquivo) está em Detalhar pedido.
Parâmetros
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
idobrigatório | texto | — | O identificador do pedido, no caminho. |
anexoIdobrigatório | texto | — | O id do anexo (anexos[].id do pedido), no caminho. |
Exemplo
curl "https://api.otlshoes.com.br/v1/pedidos/cmg8k1p2a0007/anexos/cmg8k5z7u0004/arquivo" \
-H "Authorization: Bearer $OTL_TOKEN" \
-o comprovante-pix.pdf
Resposta
200 OK, e o corpo é o arquivo — não é JSON.
| Cabeçalho | Valor |
|---|---|
Content-Type |
O tipo do arquivo: application/pdf, image/jpeg, image/png ou image/webp |
Content-Disposition |
attachment, com o nome original do arquivo |
Content-Length |
O tamanho em bytes, quando conhecido |
Regras que não se leem no JSON
- Vale para qualquer anexo do pedido, não só para o comprovante.
- Não existe link público do arquivo: o download é sempre por esta rota, com o token.
- Em caso de erro a resposta volta a ser JSON, no formato de erro de sempre — confira o status antes de gravar o corpo em disco.
Erros possíveis
| HTTP | codigo |
Quando |
|---|---|---|
| 404 | NAO_ENCONTRADO |
O pedido ou o anexo não existe — ou o pedido é de outro parceiro |
| 403 | ESCOPO_INSUFICIENTE |
A integração não tem pedidos:ler |
