Shopify PDF-API voor apps en backendprocessen
Roep gPdf aan vanuit een Shopify-app of backendproces om order-PDF's, facturen, pakbonnen, retourdocumenten en etiketten te genereren uit gemapte Shopify-data.
/api/v1/pdf/render Gebruik een Shopify-app of e-commercebackend om order-, klant-, product-, fulfilment- en retourdata te mappen naar gPdf JSON- of templatedata en geef deterministische PDF's terug, zonder te claimen dat dit een native Shopify app-store-integratie is.
Wanneer deze API past
- U bouwt een Shopify-app, eigen backend of fulfilmentproces dat externe API's kan aanroepen.
- Uw app ontvangt al Shopify-data over orders, fulfilment, klanten of producten.
- U hebt facturen, pakbonnen, retourdocumenten, magazijnetiketten of PDF-bijlagen nodig.
- U wilt een stabiel template_id-contract voor winkelierspecifieke documentlayouts.
Wat dit niet vervangt
- U verwacht dat gPdf een officiële Shopify-app of app-storevermelding is.
- U wilt dat gPdf in een winkel van een winkelier wordt geïnstalleerd, OAuth afhandelt of direct op webhooks abonneert.
- U hebt verzendtarieven, portoaankoop, voorraadbeheer of UI-functies voor winkeliers van gPdf nodig.
Welk endpoint aanroepen
/api/v1/pdf/render
JSON Render is het standaardpad voor deze workflow.
/api/v1/template-render
Gebruik dit wanneer de workflow een verwant API-pad, templatecontract of capability lookup nodig heeft.
Minimale request
POST /api/v1/template-render - appbackend stuurt gemapte Shopify-orderdata naar een gepubliceerde template.
{
"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 }
]
}
]
}
Wat gPdf afhandelt
- PDF-rendering vanuit Shopify-afgeleide JSON die door uw appbackend is gemapt.
- Template Render voor winkeliers- of merkspecifieke documentlayouts.
- Barcodes, QR-codes, tabellen, totalen, afbeeldingen, etiketten en pakbonstructuren.
- Stateless PDF-generatie via de publieke gPdf-API's.
Wat uw systeem beheert
- Shopify-appcode, OAuth, webhooks, UI voor winkeliers en distributie via de app-store.
- Mapping van order-, fulfilment-, klant-, retour-, product- en belastingdata.
- Winkelierconfiguratie, templatekeuze, aflevering, opslag en retries.
Productiechecklist
- Bewaar Shopify-credentials en gPdf API-tokens in de backend, niet in browsercode.
- Map Shopify-data naar expliciete renderdata of een templatedataschema.
- Gebruik Template Render voor winkelierspecifieke layouts nadat deze zijn goedgekeurd.
- Sla gegenereerde PDF's of brondata op volgens het proces van de winkelier.
- Documenteer dat uw app gPdf aanroept, niet dat gPdf een officiële Shopify-app is.
Grenzen van de claim
- Claim geen publieke officiële Shopify-app zolang die niet bestaat.
- gPdf voert geen Shopify OAuth, appinstallatie, webhooks of instellingen voor winkeliers uit.
- Het aanroepende systeem beheert Shopify-datamapping en e-commercebedrijfsregels.
Integratiemodel
Het zuivere Shopify-integratiemodel is backend-naar-backend. Uw app ontvangt of haalt Shopify-data op, mapt die naar een gPdf DocumentRequest of templatedata-object, roept gPdf aan en retourneert of bewaart de PDF volgens het proces van uw winkelier.
Zo blijft de publieke claim correct: gPdf is de API voor PDF-generatie die uw Shopify-app kan aanroepen. Het is geen publieke officiële Shopify-app zolang dat afzonderlijke appproduct niet bestaat.
Template Render past bij layouts van winkeliers
E-commerce-PDF’s worden vaak winkelierspecifiek: branding, artikeltabellen, retourinstructies, etiketblokken, cadeau-notities en gelokaliseerde tekst. Met Template Render kan uw app die layouts in gepubliceerde templates bewaren, terwijl de app alleen de gemapte orderdata verstuurt.
Houd platformlogica in de app
OAuth, webhooks, instellingen voor winkeliers, fulfilmentstatus, voorraad, retourregels en distributie via de app-store blijven in uw Shopify-app. gPdf moet de uiteindelijke renderdata ontvangen en de PDF produceren.
FAQ
- Is gPdf een officiële Shopify-app?
- Nee. Deze pagina is bedoeld voor apps en backends die gPdf aanroepen. Presenteer gPdf niet als officiële Shopify app-store-integratie zolang dat product niet bestaat.
- Waar moet de gPdf API-aanroep plaatsvinden?
- Roep gPdf aan vanuit uw backend of appserver, waar Shopify-credentials en gPdf API-tokens beschermd zijn.
- Moeten Shopify-PDF's JSON Render of Template Render gebruiken?
- Gebruik JSON Render voor aangepaste gegenereerde layouts. Gebruik Template Render wanneer een winkelier- of merklayout is goedgekeurd en aanroepende systemen alleen data moeten sturen.
- Handelt gPdf Shopify-webhooks af?
- Nee. Uw app ontvangt webhooks, mapt de data en bepaalt wanneer er wordt gerenderd. gPdf rendert alleen de PDF-request die het ontvangt.