GET
https://www.allpost.com.br/api/v1/pedido/{numeroPedido}/anexo
Faz o download autenticado de um anexo de um pedido (reversa ou envio); numeroPedido (1578397 ou rvs0_1578397) + caminho de anexos[].url do 147
Módulo: Pedido
Descrição
Faz o download autenticado de um anexo de um pedido (reversa ou envio). Como o bucket S3 é privado, este endpoint é a única forma de recuperar o conteúdo binário de um arquivo anexado ao pedido.
Exemplo:
- https://www.allpost.com.br/api/v1/pedido/{numeroPedido}/anexo?caminho=logisticaReversa/anexos/{id}/arquivo.png
- https://www.allpost.com.br/api/v1/pedido/rvs0_1578397/anexo?caminho=rastreio/anexos/{id}/arquivo.pdf&modo=inline
O caminho do anexo é obtido na resposta do endpoint 147 (GET anexos do pedido), no campo anexos[].url.
O endpoint valida que o anexo pertence ao pedido informado (impede acesso arbitrário ao S3).
Parâmetro modo:
- inline: exibe o arquivo no navegador (útil para preview de imagens).
- attachment (default): força download do arquivo.
Códigos de retorno:
- 200: stream binário do arquivo com Content-Type correto (image/png, application/pdf, etc.).
- 400: parâmetros obrigatórios ausentes.
- 401: token ausente, expirado ou inválido.
- 403: o pedido não pertence à loja autenticada.
- 404: pedido ou anexo não encontrado.
Exemplo:
- https://www.allpost.com.br/api/v1/pedido/{numeroPedido}/anexo?caminho=logisticaReversa/anexos/{id}/arquivo.png
- https://www.allpost.com.br/api/v1/pedido/rvs0_1578397/anexo?caminho=rastreio/anexos/{id}/arquivo.pdf&modo=inline
O caminho do anexo é obtido na resposta do endpoint 147 (GET anexos do pedido), no campo anexos[].url.
O endpoint valida que o anexo pertence ao pedido informado (impede acesso arbitrário ao S3).
Parâmetro modo:
- inline: exibe o arquivo no navegador (útil para preview de imagens).
- attachment (default): força download do arquivo.
Códigos de retorno:
- 200: stream binário do arquivo com Content-Type correto (image/png, application/pdf, etc.).
- 400: parâmetros obrigatórios ausentes.
- 401: token ausente, expirado ou inválido.
- 403: o pedido não pertence à loja autenticada.
- 404: pedido ou anexo não encontrado.
Parâmetros de Path
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| numeroPedido | string | Sim | Número do pedido ou número do pedido de reversa (ex.: 1578397 ou rvs0_1578397). Atende reversa e envio. |
| caminho | string | Sim | Caminho relativo do anexo no S3 (obtido em anexos[].url do endpoint 147). |
| modo | string | Não | "inline" (exibe no navegador) ou "attachment" (download). Default: attachment. |
Response
Sucesso (200):
Stream binário do arquivo. Headers relevantes:
Content-Type: image/png
Content-Disposition: inline; filename="arquivo.png"
Content-Length: 45231
Erro (JSON):
{
"mensagem": "Anexo não encontrado."
}