Uygulamalar ve backend iş akışları için Shopify PDF API'si
Shopify verisinden sipariş PDF'leri, faturalar, packing slip'ler, iade belgeleri ve etiketler oluşturmak için gPdf'i Shopify app'inizden veya backend iş akışınızdan çağırın.
/api/v1/pdf/render Shopify app'i veya e-ticaret backend'i kullanarak sipariş, müşteri, ürün, sipariş karşılama ve iade verisini gPdf JSON ya da şablon verisine eşlemek; native Shopify App Store entegrasyonu iddiası olmadan deterministik PDF'ler döndürmek.
Bu API ne zaman kullanılır
- Harici API çağırabilen bir Shopify app'i, private backend veya sipariş karşılama iş akışı geliştiriyorsunuz.
- App'iniz Shopify sipariş, sipariş karşılama, müşteri veya ürün verisini zaten alıyor.
- Faturalar, packing slip'ler, iade belgeleri, depo etiketleri veya PDF ekleri gerekiyor.
- Satıcıya özel belge yerleşimleri için kararlı bir template_id sözleşmesi istiyorsunuz.
Neyin yerine geçmez
- gPdf'in official Shopify app'i veya App Store kaydı olmasını bekliyorsunuz.
- gPdf'in satıcı mağazasına kurulmasını, OAuth yönetmesini veya webhook'lara doğrudan abone olmasını istiyorsunuz.
- gPdf'ten gönderi ücretleri, taşıma ücreti satın alma, stok yönetimi veya satıcı arayüzü özellikleri bekliyorsunuz.
Hangi endpoint çağrılır
/api/v1/pdf/render
JSON Render bu iş akışı için varsayılan yoldur.
/api/v1/template-render
İş akışı ilgili API yoluna, template sözleşmesine veya capability sorgusuna ihtiyaç duyduğunda kullanın.
Minimum request
POST /api/v1/template-render - app backend'i eşlenmiş Shopify sipariş verisini yayınlanmış şablona gönderir.
{
"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 }
]
}
]
}
gPdf neyi üstlenir
- App backend'inizin eşlediği Shopify kaynaklı JSON'dan PDF render işlemi.
- Satıcıya veya markaya özel belge yerleşimleri için Template Render.
- Barkodlar, QR kodları, tablolar, toplamlar, görseller, etiketler ve packing-slip yapıları.
- Public gPdf API'leri üzerinden stateless PDF oluşturma.
Sisteminiz neyi yönetir
- Shopify app kodu, OAuth, webhook'lar, satıcı arayüzü ve App Store dağıtımı.
- Sipariş, sipariş karşılama, müşteri, iade, ürün ve vergi verisi eşlemesi.
- Satıcı yapılandırması, şablon seçimi, teslimat, depolama ve retry mantığı.
Production kontrol listesi
- Shopify kimlik bilgilerini ve gPdf API token'larını browser kodunda değil backend'de tutun.
- Shopify verisini açık bir render payload'una veya şablon veri şemasına eşleyin.
- Onay sonrası satıcıya özel yerleşimler için Template Render kullanın.
- Oluşturulan PDF'leri veya kaynak veriyi satıcı iş akışına göre saklayın.
- Entegrasyonun official gPdf Shopify app'i değil, gPdf'i çağıran sizin app'iniz olduğunu belgeleyin.
İddia sınırları
- Gerçekten yoksa official Shopify app'i iddiasında bulunmayın.
- gPdf Shopify OAuth, app installation, webhook'lar veya satıcı ayarları çalıştırmaz.
- Çağıran sistem Shopify verisi eşlemesini ve e-ticaret iş kurallarını sahiplenir.
Entegrasyon modeli
Temiz Shopify entegrasyon modeli backend-to-backend’dir. App’iniz Shopify verisini alır veya fetch eder, bunu gPdf DocumentRequest ya da şablon verisi nesnesine eşler, gPdf’i çağırır ve PDF’i satıcı iş akışına göre döndürür veya saklar.
Bu public iddiayı doğru sınırda tutar: gPdf, Shopify app’inizin çağırabileceği bir PDF oluşturma API’sidir. Ayrı bir app ürünü gerçekten yoksa official Shopify app’i değildir.
Template Render satıcı yerleşimleri için uygundur
E-ticaret PDF’leri çoğu zaman satıcıya özeldir: marka, ürün tabloları, iade talimatları, etiket blokları, hediye notları ve yerelleştirilmiş metin. Template Render, app yalnızca eşlenmiş sipariş verisi gönderirken bu yerleşimleri yayınlanmış şablonlarda tutmanızı sağlar.
Platform mantığını app içinde tutun
OAuth, webhook’lar, satıcı ayarları, sipariş karşılama durumu, stok, iade kuralları ve App Store dağıtımı Shopify app’inizde kalır. gPdf son render verisini alıp PDF üretmelidir.
SSS
- gPdf resmi bir Shopify app'i mi?
- Hayır. Bu sayfa gPdf'i çağıran app'ler ve backend'ler içindir. Ayrı ürün gerçekten var olmadıkça gPdf'i official Shopify App Store entegrasyonu olarak sunmayın.
- gPdf API çağrısı nerede yapılmalı?
- Shopify credentials ve gPdf API tokens korunduğu için gPdf'i backend veya app server'dan çağırın.
- Shopify PDF'leri JSON Render mı Template Render mı kullanmalı?
- Özel oluşturulan yerleşimler için JSON Render kullanın. Satıcı veya marka yerleşimi onaylandığında ve çağıran sistemler yalnızca veri göndermeliyse Template Render kullanın.
- gPdf Shopify webhook'lar işler mi?
- Hayır. App'iniz webhook'ları alır, veriyi eşler ve ne zaman render edileceğine karar verir. gPdf yalnızca aldığı PDF isteğini render eder.