API de romaneio em PDF para fluxos de fulfillment
Gere PDFs de romaneio a partir de dados de pedido, envio, caixa e itens para fluxos de fulfillment em ecommerce, 3PL, OMS e armazém.
/api/v1/template-render Renderizar romaneios a partir de dados de envio, destinatário, itens e caixas para que equipes de fulfillment possam imprimir ou anexar um documento consistente a cada pedido expedido.
Quando usar esta API
- Seu OMS ou WMS já tem itens do pedido, quantidades, dados do destinatário e identificadores do envio.
- Você precisa de um romaneio em PDF para estações de impressão no armazém ou inserções no pacote do cliente.
- Você quer um layout aprovado reutilizado entre armazéns, marcas ou canais de venda.
- Você pode precisar de código de barras ou QR code para consulta de pedido ou recebimento de devolução.
O que ela não substitui
- Você precisa comprar postagem, cotar um envio ou criar uma etiqueta de transportadora.
- Você precisa de gestão de estoque do armazém, não de renderização de documentos.
- Você precisa de semântica legal de fatura ou e-invoice.
Qual endpoint chamar
/api/v1/template-render
Template Render é o caminho padrão para este fluxo.
/api/v1/pdf/render
Use quando o fluxo precisar da API relacionada, de um contrato de template ou de uma consulta de capacidades.
Request mínimo
POST /api/v1/template-render - modelo packing_list com um envio.
{
"template_id": "packing_list",
"data": [
{
"shipment": {
"number": "PL-2026-1001",
"date": "2026-05-29"
},
"shipper": {
"name": "Acme Warehouse",
"address": "1200 Logistics Pkwy"
},
"consignee": {
"name": "Receiver Inc.",
"address": "123 Main St"
},
"items": [
{
"item_no": "1",
"description": "Replacement filter",
"quantity": "2",
"unit": "pcs",
"gross_weight": "1.2 kg",
"net_weight": "1.0 kg"
}
]
}
]
}
O que a gPdf faz
- Template Render para layouts de romaneio publicados.
- JSON Render para páginas de romaneio personalizadas durante design ou fluxos pontuais.
- Tabelas, linhas de itens, blocos de endereço, códigos de barras opcionais e saída em PDF.
- Reimpressões determinísticas quando os mesmos dados e o mesmo modelo são usados.
O que seu sistema controla
- Dados do pedido, quantidades dos itens, estado do envio, roteamento do armazém e mensagens ao cliente.
- Mapeamento de campos do modelo, roteamento para estações de impressão e política de reimpressão.
- Qualquer documento de transportadora, alfândega ou fatura que precise acompanhar o pacote.
Checklist de produção
- Teste as combinações mais longas de SKU, nome de item e endereço.
- Valide casos de item único, múltiplas caixas, backorder e envio parcial.
- Use Template Render depois que o layout do romaneio for aprovado.
- Registre template_id e X-Request-Id para cada solicitação de impressão de fulfillment.
- Mantenha a geração de etiqueta de transportadora separada da renderização do romaneio.
Limites da promessa
- O gPdf renderiza o PDF do romaneio; ele não gerencia estoque nem estado de fulfillment.
- Um romaneio não é automaticamente uma fatura fiscal nem um documento alfandegário.
- Compra de etiqueta de transportadora e cotação de envio permanecem fora do gPdf.
Romaneios combinam bem com o caminho por modelo
Romaneios costumam ter uma estrutura estável: remetente, destinatário, número do envio, linhas de itens e notas opcionais. Isso torna Template Render uma boa escolha depois que o layout é aprovado.
JSON Render continua importante durante o design. Ele permite que sua equipe
ajuste colunas, espaçamento, posição de códigos de barras e quebras de página
antes de publicar o contrato template_id estável.
FAQ
- Romaneio é um endpoint separado do gPdf?
- Não. Use Template Render para um modelo de romaneio aprovado ou JSON Render quando seu sistema descreve o layout diretamente.
- Romaneios podem incluir códigos de barras?
- Sim. O gPdf pode renderizar elementos de código de barras no PDF. Seu sistema controla os dados codificados do pedido, caixa ou devolução.
- O gPdf cria etiquetas de transportadora?
- Não. Etiquetas de transportadora são um fluxo separado. O gPdf renderiza PDFs a partir dos dados fornecidos pela sua transportadora ou sistema de envio.
- Uma requisição pode renderizar vários romaneios?
- Template Render aceita um array data para vários itens em uma única requisição, dentro dos limites públicos de API documentados para esse endpoint.