Shopify PDF API untuk aplikasi dan workflow backend
Panggil gPdf dari aplikasi Shopify atau workflow backend untuk membuat PDF order, invoice, packing slip, return, dan label dari data Shopify yang sudah dipetakan.
/api/v1/pdf/render Memakai aplikasi Shopify atau backend ecommerce untuk memetakan data order, pelanggan, produk, fulfillment, dan return ke JSON gPdf atau data template, lalu mengembalikan PDF deterministik tanpa mengklaim integrasi native Shopify app-store.
Kapan memakai API ini
- Anda membangun aplikasi Shopify, private backend, atau workflow fulfillment yang dapat memanggil API eksternal.
- Aplikasi Anda sudah menerima data order, fulfillment, pelanggan, atau produk dari Shopify.
- Anda membutuhkan invoice, packing slip, dokumen return, label gudang, atau attachment PDF.
- Anda menginginkan kontrak template_id yang stabil untuk layout dokumen spesifik merchant.
Apa yang tidak digantikan
- Anda mengharapkan gPdf menjadi app Shopify resmi atau listing app-store.
- Anda membutuhkan gPdf terpasang di toko merchant, menangani OAuth, atau subscribe webhook secara langsung.
- Anda membutuhkan shipping rates, pembelian ongkir, inventory management, atau fitur merchant UI dari gPdf.
Endpoint yang dipanggil
/api/v1/pdf/render
JSON Render adalah jalur default untuk workflow ini.
/api/v1/template-render
Gunakan saat workflow butuh jalur API terkait, kontrak template, atau capability lookup.
Request minimal
POST /api/v1/template-render - backend aplikasi mengirim data order Shopify yang sudah dipetakan ke template yang dipublikasikan.
{
"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 }
]
}
]
}
Yang ditangani gPdf
- Render PDF dari JSON turunan Shopify yang dipetakan backend aplikasi Anda.
- Template Render untuk layout dokumen spesifik merchant atau brand.
- Barcode, QR code, tabel, total, gambar, label, dan struktur packing slip.
- PDF generation stateless melalui API publik gPdf.
Yang dikelola sistem Anda
- Kode aplikasi Shopify, OAuth, webhook, merchant UI, dan distribusi app-store.
- Mapping data order, fulfillment, pelanggan, return, produk, dan pajak.
- Konfigurasi merchant, pemilihan template, delivery, storage, dan retry.
Checklist produksi
- Simpan credential Shopify dan token API gPdf di backend, bukan kode browser.
- Petakan data Shopify ke payload render eksplisit atau schema data template.
- Gunakan Template Render untuk layout spesifik merchant setelah approval.
- Simpan PDF yang digenerate atau source data sesuai workflow merchant.
- Dokumentasikan bahwa integrasinya adalah aplikasi Anda yang memanggil gPdf, bukan app Shopify resmi gPdf.
Batas klaim
- Jangan mengklaim app Shopify resmi publik kecuali produk itu benar-benar ada.
- gPdf tidak menjalankan OAuth Shopify, instalasi app, webhook, atau pengaturan merchant.
- Caller memiliki mapping data Shopify dan aturan bisnis ecommerce.
Model integrasi
Model integrasi Shopify yang bersih adalah backend-to-backend. Aplikasi Anda menerima atau mengambil data Shopify, memetakannya ke DocumentRequest gPdf atau objek data template, memanggil gPdf, lalu mengembalikan atau menyimpan PDF sesuai workflow merchant Anda.
Ini menjaga klaim publik tetap akurat: gPdf adalah PDF generation API yang dapat dipanggil aplikasi Shopify Anda. gPdf bukan app Shopify resmi publik kecuali produk app terpisah itu memang ada.
Template Render cocok untuk layout merchant
PDF ecommerce sering menjadi spesifik merchant: branding, tabel item, instruksi return, blok label, gift note, dan teks lokal. Template Render memungkinkan aplikasi Anda menyimpan layout tersebut dalam template yang dipublikasikan sementara aplikasi hanya mengirim data order yang sudah dipetakan.
Jaga logika platform di aplikasi
OAuth, webhook, pengaturan merchant, status fulfillment, inventory, aturan return, dan distribusi app-store tetap berada di aplikasi Shopify Anda. gPdf sebaiknya menerima data render final dan menghasilkan PDF.
FAQ
- Apakah gPdf app resmi Shopify?
- Tidak. Halaman ini untuk aplikasi dan backend yang memanggil gPdf. Jangan menyajikan gPdf sebagai integrasi app-store Shopify resmi kecuali produk itu ada.
- Di mana panggilan API gPdf sebaiknya dilakukan?
- Panggil gPdf dari backend atau app server Anda, tempat credential Shopify dan token API gPdf terlindungi.
- Sebaiknya PDF Shopify memakai JSON Render atau Template Render?
- Gunakan JSON Render untuk layout kustom yang digenerate. Gunakan Template Render ketika layout merchant atau brand disetujui dan caller cukup mengirim data.
- Apakah gPdf menangani webhook Shopify?
- Tidak. Aplikasi Anda menerima webhook, memetakan data, dan memutuskan kapan merender. gPdf hanya merender request PDF yang diterimanya.