O gPdf é um app oficial da Shopify?

Não. Esta página é para apps e backends que chamam o gPdf. Não apresente o gPdf como integração oficial da Shopify App Store a menos que esse produto exista.

Onde a chamada à API do gPdf deve acontecer?

Chame o gPdf a partir do seu backend ou servidor do app, onde credenciais da Shopify e tokens da API gPdf ficam protegidos.

PDFs Shopify devem usar JSON Render ou Template Render?

Use JSON Render para layouts personalizados gerados por código. Use Template Render quando um layout de lojista ou marca estiver aprovado e os chamadores precisarem enviar apenas dados.

O gPdf processa webhooks da Shopify?

Não. Seu app recebe webhooks, mapeia os dados e decide quando renderizar. O gPdf apenas renderiza a requisição de PDF que recebe.

Plataformas de e-commerce

API de PDF para Shopify em apps e fluxos de backend

Chame o gPdf a partir de um app Shopify ou fluxo de backend para gerar PDFs de pedido, faturas, romaneios, devoluções e etiquetas com dados Shopify mapeados.

API PRINCIPAL JSON Render

ENDPOINT /api/v1/pdf/render

SISTEMAS Backend de app Shopify / Backend de ecommerce / OMS / Fluxo de fulfillment

Testar no Playground Ler a documentação

Tarefa a resolver

Usar um app Shopify ou backend de ecommerce para mapear dados de pedido, cliente, produto, fulfillment e devolução para JSON do gPdf ou dados de modelo, retornando PDFs determinísticos sem afirmar uma integração nativa com a Shopify App Store.

Quando usar esta API

Você está construindo um app Shopify, backend privado ou fluxo de fulfillment que pode chamar APIs externas.
Seu app já recebe dados de pedido, fulfillment, cliente ou produto da Shopify.
Você precisa de faturas, romaneios, documentos de devolução, etiquetas de armazém ou anexos PDF.
Você quer um contrato template_id estável para layouts de documento específicos de cada lojista.

O que ela não substitui

Você espera que o gPdf seja um app oficial da Shopify ou uma listagem na app store.
Você precisa que o gPdf seja instalado na loja do lojista, trate OAuth ou assine webhooks diretamente.
Você precisa de tarifas de envio, compra de postagem, gestão de estoque ou recursos de UI para lojistas fornecidos pelo gPdf.

Qual endpoint chamar

PRINCIPAL

/api/v1/pdf/render

JSON Render é o caminho padrão para este fluxo.

SECUNDÁRIO 1

/api/v1/template-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 - backend do app envia dados mapeados de pedido Shopify para um modelo publicado.

{
  "template_id": "packing_list",
  "data": [
    {
      "order_number": "#1042",
      "customer_name": "Example Buyer",
      "ship_to": "1200 Market St, San Francisco, CA",
      "items": [
        { "sku": "TSHIRT-BLK-M", "name": "Black T-shirt", "quantity": 2 },
        { "sku": "MUG-WHT", "name": "White mug", "quantity": 1 }
      ]
    }
  ]
}

O que a gPdf faz

Renderização de PDF a partir de JSON derivado da Shopify e mapeado pelo backend do seu app.
Template Render para layouts de documento específicos de lojista ou marca.
Códigos de barras, QR codes, tabelas, totais, imagens, etiquetas e estruturas de romaneio.
Geração de PDF sem estado por meio das APIs públicas do gPdf.

O que seu sistema controla

Código do app Shopify, OAuth, webhooks, UI do lojista e distribuição na app store.
Mapeamento de dados de pedido, fulfillment, cliente, devolução, produto e impostos.
Configuração do lojista, seleção de modelo, entrega, armazenamento e retentativas.

Checklist de produção

Mantenha credenciais da Shopify e tokens da API gPdf no backend, não no código do navegador.
Mapeie dados da Shopify para um corpo de renderização explícito ou schema de dados de modelo.
Use Template Render para layouts específicos de lojista depois da aprovação.
Armazene PDFs gerados ou dados de origem conforme o fluxo do lojista.
Documente que a integração é seu app chamando o gPdf, não um app oficial Shopify do gPdf.

Limites da promessa

Não declare um app público oficial da Shopify se ele não existir.
O gPdf não executa OAuth da Shopify, instalação de app, webhooks nem configurações de lojista.
O chamador controla o mapeamento de dados Shopify e as regras de negócio de ecommerce.

Modelo de integração

O modelo limpo de integração Shopify é backend com backend. Seu app recebe ou busca dados da Shopify, mapeia esses dados para um DocumentRequest do gPdf ou objeto de dados de modelo, chama o gPdf e retorna ou armazena o PDF conforme o fluxo do lojista.

Isso mantém a declaração pública correta: o gPdf é a API de geração de PDF que seu app Shopify pode chamar. Ele não é um app público oficial da Shopify, a menos que esse produto separado exista.

Template Render combina com layouts de lojistas

PDFs de ecommerce muitas vezes se tornam específicos por lojista: marca, tabelas de itens, instruções de devolução, blocos de etiqueta, recados de presente e texto localizado. Template Render permite que seu app mantenha esses layouts em modelos publicados enquanto envia apenas os dados mapeados do pedido.

Mantenha a lógica da plataforma no app

OAuth, webhooks, configurações do lojista, estado de fulfillment, inventário, regras de devolução e distribuição na app store permanecem no seu app Shopify. O gPdf deve receber os dados finais de renderização e produzir o PDF.

FAQ

O gPdf é um app oficial da Shopify?: Não. Esta página é para apps e backends que chamam o gPdf. Não apresente o gPdf como integração oficial da Shopify App Store a menos que esse produto exista.
Onde a chamada à API do gPdf deve acontecer?: Chame o gPdf a partir do seu backend ou servidor do app, onde credenciais da Shopify e tokens da API gPdf ficam protegidos.
PDFs Shopify devem usar JSON Render ou Template Render?: Use JSON Render para layouts personalizados gerados por código. Use Template Render quando um layout de lojista ou marca estiver aprovado e os chamadores precisarem enviar apenas dados.
O gPdf processa webhooks da Shopify?: Não. Seu app recebe webhooks, mapeia os dados e decide quando renderizar. O gPdf apenas renderiza a requisição de PDF que recebe.