GET
https://www.allpost.com.br/api/v1/reversa/etiqueta/{idPedidoReversa}/{modelo}
Gera a etiqueta de reversa do pedido em PDF (modelos: A4, BOBINA, A4-Correios, BOBINA-Correios)
Módulo: Pedido
Descrição
Gera a etiqueta de reversa de um pedido em formato PDF. São 4 modelos disponíveis: 2 para Correios e 2 para transportadora.
Modelos aceitos:
- A4: A4 para transportadora.
- BOBINA: bobina para transportadora.
- A4-Correios: A4 para Correios.
- BOBINA-Correios: bobina para Correios.
Exemplo:
- https://www.allpost.com.br/api/v1/reversa/etiqueta/{idPedidoReversa}/BOBINA-Correios
- https://www.allpost.com.br/api/v1/reversa/etiqueta/{idPedidoReversa}/A4?baixar=sim
Retorna o binário do PDF (Content-Type: application/pdf). Por padrão é exibido inline; use baixar=sim para forçar o download.
O isolamento é feito automaticamente pela loja do token.
Correios sem protocolo de rastreio: quando a transportadora do envio é Correios e o pedido ainda não possui protocolo/código de rastreio, o allPost integra automaticamente a pré-reversa com os Correios (gera o protocolo) antes de emitir a etiqueta. Se a integração falhar, retorna 422 com a mensagem do erro e a etiqueta não é gerada.
Códigos de retorno:
- 200: sucesso (PDF da etiqueta).
- 400: parâmetro/modelo inválido.
- 401: token ausente, expirado ou inválido.
- 403: o pedido não pertence à loja autenticada.
- 404: pedido não encontrado.
- 422: falha ao integrar a pré-reversa com os Correios (etiqueta não gerada).
Modelos aceitos:
- A4: A4 para transportadora.
- BOBINA: bobina para transportadora.
- A4-Correios: A4 para Correios.
- BOBINA-Correios: bobina para Correios.
Exemplo:
- https://www.allpost.com.br/api/v1/reversa/etiqueta/{idPedidoReversa}/BOBINA-Correios
- https://www.allpost.com.br/api/v1/reversa/etiqueta/{idPedidoReversa}/A4?baixar=sim
Retorna o binário do PDF (Content-Type: application/pdf). Por padrão é exibido inline; use baixar=sim para forçar o download.
O isolamento é feito automaticamente pela loja do token.
Correios sem protocolo de rastreio: quando a transportadora do envio é Correios e o pedido ainda não possui protocolo/código de rastreio, o allPost integra automaticamente a pré-reversa com os Correios (gera o protocolo) antes de emitir a etiqueta. Se a integração falhar, retorna 422 com a mensagem do erro e a etiqueta não é gerada.
Códigos de retorno:
- 200: sucesso (PDF da etiqueta).
- 400: parâmetro/modelo inválido.
- 401: token ausente, expirado ou inválido.
- 403: o pedido não pertence à loja autenticada.
- 404: pedido não encontrado.
- 422: falha ao integrar a pré-reversa com os Correios (etiqueta não gerada).
Parâmetros de Path
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| idPedidoReversa | string | Sim | Identificador do pedido de reversa. |
| modelo | string | Não | Modelo da etiqueta: A4, BOBINA, A4-Correios ou BOBINA-Correios (default: A4). |
| baixar | string | Não | Use "sim" para forçar o download (attachment). Sem o parâmetro o PDF é exibido inline. |
| tipoReversa | string | Não | Tipo usado na integração com Correios quando ainda não há protocolo de rastreio (default: "Postagem em agência"). |
Parâmetros de Retorno
| Campo | Tipo | Descrição |
|---|---|---|
| (binário) | application/pdf | Conteúdo binário do PDF da etiqueta. Não retorna JSON em caso de sucesso; o corpo da resposta é o próprio arquivo PDF. |
Response
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: inline; filename="etiqueta_35240712345678000199550010000012341000012349.pdf"
%PDF-1.4
... (conteúdo binário do PDF) ...