Shopify PDF API für Apps und Backend-Workflows
Rufen Sie gPdf aus einer Shopify-App oder einem Backend-Workflow auf, um Bestell-PDFs, Rechnungen, Packlisten, Retouren und Labels aus gemappten Shopify-Daten zu erzeugen.
/api/v1/pdf/render Nutzen Sie eine Shopify-App oder ein E-Commerce-Backend, um Bestell-, Kunden-, Produkt-, Fulfillment- und Retourendaten in gPdf JSON oder Template-Daten zu mappen und anschließend deterministische PDFs zurückzugeben, ohne eine native Shopify-App-Store-Integration zu beanspruchen.
Wann diese API passt
- Sie bauen eine Shopify-App, ein privates Backend oder einen Fulfillment-Workflow, der externe APIs aufrufen kann.
- Ihre App erhält bereits Shopify-Bestell-, Fulfillment-, Kunden- oder Produktdaten.
- Sie benötigen Rechnungen, Packlisten, Retourendokumente, Lagerlabels oder PDF-Anhänge.
- Sie möchten einen stabilen template_id-Vertrag für händlerspezifische Dokumentlayouts.
Was sie nicht ersetzt
- Sie erwarten, dass gPdf eine offizielle Shopify-App oder ein App-Store-Listing ist.
- Sie benötigen, dass gPdf in einem Händler-Shop installiert wird, OAuth verarbeitet oder Webhooks direkt abonniert.
- Sie benötigen Versandtarife, Portokauf, Bestandsmanagement oder Händler-UI-Funktionen von gPdf.
Welchen Endpoint aufrufen
/api/v1/pdf/render
JSON Render ist der Standardpfad für diesen Workflow.
/api/v1/template-render
Nutzen Sie dies, wenn der Workflow den zugehörigen API-Pfad, einen Template-Vertrag oder eine Capability-Abfrage braucht.
Minimaler Request
POST /api/v1/template-render - App-Backend sendet gemappte Shopify-Bestelldaten an eine veröffentlichte Vorlage.
{
"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 }
]
}
]
}
Was gPdf übernimmt
- PDF-Rendering aus Shopify-abgeleitetem JSON, das Ihr App-Backend mappt.
- Template Render für händler- oder markenspezifische Dokumentlayouts.
- Barcodes, QR-Codes, Tabellen, Summen, Bilder, Labels und Packlistenstrukturen.
- Zustandslose PDF-Generierung über die öffentlichen gPdf APIs.
Was Ihr System verantwortet
- Shopify-App-Code, OAuth, Webhooks, Händler-UI und App-Store-Distribution.
- Mapping von Bestell-, Fulfillment-, Kunden-, Retouren-, Produkt- und Steuerdaten.
- Händlerkonfiguration, Template-Auswahl, Zustellung, Speicherung und Retries.
Produktions-Checkliste
- Halten Sie Shopify-Zugangsdaten und gPdf API Tokens im Backend, nicht im Browser-Code.
- Mappen Sie Shopify-Daten in einen expliziten Render-Payload oder ein Template-Datenschema.
- Nutzen Sie Template Render für händlerspezifische Layouts nach Freigabe.
- Speichern Sie generierte PDFs oder Quelldaten gemäß dem Händlerworkflow.
- Dokumentieren Sie, dass Ihre App gPdf aufruft, nicht dass es eine offizielle gPdf Shopify-App ist.
Aussagegrenzen
- Beanspruchen Sie keine öffentliche offizielle Shopify-App, solange sie nicht existiert.
- gPdf führt kein Shopify OAuth, keine App-Installation, keine Webhooks und keine Händler-Einstellungen aus.
- Der Aufrufer verantwortet Shopify-Datenmapping und E-Commerce-Geschäftsregeln.
Integrationsmodell
Das saubere Shopify-Integrationsmodell ist Backend-zu-Backend. Ihre App erhält oder lädt Shopify-Daten, mappt sie in einen gPdf DocumentRequest oder ein Template-Datenobjekt, ruft gPdf auf und gibt das PDF gemäß Ihrem Händlerworkflow zurück oder speichert es.
So bleibt die öffentliche Aussage korrekt: gPdf ist die PDF-Generierungs-API, die Ihre Shopify-App aufrufen kann. Es ist keine öffentliche offizielle Shopify-App, solange dieses separate App-Produkt nicht existiert.
Template Render passt zu Händlerlayouts
E-Commerce-PDFs werden oft händlerspezifisch: Branding, Artikeltabellen, Retourenanweisungen, Label-Blöcke, Geschenknotizen und lokalisierter Text. Template Render ermöglicht Ihrer App, diese Layouts in veröffentlichten Vorlagen zu halten, während die App nur die gemappten Bestelldaten sendet.
Plattformlogik bleibt in der App
OAuth, Webhooks, Händler-Einstellungen, Fulfillment-Status, Bestand, Retourenregeln und App-Store-Distribution bleiben in Ihrer Shopify-App. gPdf sollte die finalen Renderdaten erhalten und das PDF erzeugen.
FAQ
- Ist gPdf eine offizielle Shopify-App?
- Nein. Diese Seite richtet sich an Apps und Backends, die gPdf aufrufen. Stellen Sie gPdf nicht als offizielle Shopify-App-Store-Integration dar, solange dieses Produkt nicht existiert.
- Wo sollte der gPdf API-Aufruf stattfinden?
- Rufen Sie gPdf aus Ihrem Backend oder App-Server auf, wo Shopify-Zugangsdaten und gPdf API Tokens geschützt sind.
- Sollten Shopify-PDFs JSON Render oder Template Render nutzen?
- Nutzen Sie JSON Render für individuell generierte Layouts. Nutzen Sie Template Render, wenn ein Händler- oder Markenlayout freigegeben ist und Aufrufer nur Daten senden sollen.
- Verarbeitet gPdf Shopify-Webhooks?
- Nein. Ihre App empfängt Webhooks, mappt die Daten und entscheidet, wann gerendert wird. gPdf rendert nur den PDF-Request, den es erhält.