VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Documentos

Gerar o documento

Mostra o modelo com dados de exemplo, preenche com os dados de um pedido real e baixa o resultado pronto para imprimir.

Três formas de ver um modelo preenchido. preview usa dados de exemplo fixos (uma cliente "Maria Silva", pedido VND-2026-00123), útil enquanto você edita. render usa um pedido real, indicado em entity_id. pdf baixa o resultado como um arquivo HTML que abre a janela de impressão do navegador, de onde o usuário salva como PDF.

Pré-visualizar

GET/api/v1/admin/documents/{id}/previewAdmin

Pré-visualizar com dados de exemplo

Parâmetros de caminho

iduuidobrigatório
Id do modelo (UUID).

Exemplo de requisição (preview)

Resposta (preview)

200HTML preenchido

Campos da resposta

htmlstring
O HTML do modelo com os marcadores trocados pelos dados de exemplo.

Erros (preview)

StatusQuandoCorpo
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
404O modelo não existe.{"error":"document not found"}
500Falha inesperada no servidor.{"error":"failed to ..."}

Gerar de um pedido

POST/api/v1/admin/documents/{id}/renderAdmin

Gerar o documento de um pedido

Parâmetros de caminho

iduuidobrigatório
Id do modelo (UUID).

Parâmetros de consulta

entity_iduuidobrigatório
Id do pedido (UUID) cujos dados preencherão o modelo.

Exemplo de requisição (render)

Resposta (render)

200HTML preenchido

Campos da resposta

htmlstring
O HTML com os dados do pedido.

Erros (render)

StatusQuandoCorpo
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
400Falta entity_id.{"error":"entity_id query parameter is required"}
404O modelo não existe.{"error":"document not found"}
500O pedido não existe (hoje volta como 500, não 404) ou falha ao preencher.{"error":"failed to render document","detail":"fetch order data: order not found: ..."}

Baixar para imprimir

GET/api/v1/admin/documents/{id}/pdfAdmin

Baixar o documento pronto para imprimir

Parâmetros de caminho

iduuidobrigatório
Id do modelo (UUID).

Parâmetros de consulta

entity_iduuid
Id do pedido. Sem ele, o arquivo traz os dados de exemplo.

Exemplo de requisição (pdf)

Resposta (pdf)

200Arquivo HTML para impressão

Campos da resposta

(corpo)text/html
Um documento HTML completo, com estilo de impressão e um script que abre a janela de impressão ao carregar. Cabeçalhos: Content-Type: text/html; charset=utf-8 e Content-Disposition: attachment; filename="document-{id}[-{entity_id}].html".

Erros (pdf)

StatusQuandoCorpo
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
500Modelo ou pedido inexistente, ou falha ao preencher. Aqui um modelo inexistente também volta 500.{"error":"failed to render document","detail":"document not found"}
A rota /pdf não gera um PDF

O servidor não tem um motor de HTML para PDF. O arquivo é HTML com um script que chama a impressão do navegador. Em integrações sem navegador, use render e gere o PDF com a sua própria ferramenta.

Erros de pedido inexistente

render e pdf com um entity_id que não existe respondem 500, não 404. Valide o id do pedido antes com Consultar pedido.

Veja também

  • Criar e editar modelos
  • Variáveis disponíveis
  • Faturas de pedido
Anterior
Criar e editar modelos
Próxima
Scripts da loja
Nesta página
  • Pré-visualizar
  • Exemplo de requisição (preview)
  • Resposta (preview)
  • Erros (preview)
  • Gerar de um pedido
  • Exemplo de requisição (render)
  • Resposta (render)
  • Erros (render)
  • Baixar para imprimir
  • Exemplo de requisição (pdf)
  • Resposta (pdf)
  • Erros (pdf)
  • Veja também
bash
curl "$BASE_URL/api/v1/admin/documents/3204f98e-2c66-42d5-baee-bbc191a1b063/preview" \
  -H "Authorization: Bearer $TOKEN"
text
<!doctype html>
<html lang="pt-BR"><head><meta charset="utf-8">
<title>Document 3204f98e-...</title>
<script>window.addEventListener('load', function(){ setTimeout(function(){ window.print(); }, 250); });</script>
</head><body><h1>Pedido PILOT-20261011-0009</h1>...</body></html>
bash
curl -X POST "$BASE_URL/api/v1/admin/documents/3204f98e-2c66-42d5-baee-bbc191a1b063/render?entity_id=6af86ed3-d949-474d-8e04-513c6e83bfe4" \
  -H "Authorization: Bearer $TOKEN"
bash
curl "$BASE_URL/api/v1/admin/documents/3204f98e-2c66-42d5-baee-bbc191a1b063/pdf?entity_id=6af86ed3-d949-474d-8e04-513c6e83bfe4" \
  -H "Authorization: Bearer $TOKEN"
json
{
  "html": "<h1>Pedido VND-2026-00123</h1><p>Maria Silva total R$ 182,00</p>"
}
json
{
  "html": "<h1>Pedido PILOT-20261011-0009</h1><p>Docs Cliente total R$ 52,66</p>"
}