gPdf เป็น official Shopify app หรือไม่

ไม่ หน้านี้สำหรับ apps และ backends ที่เรียก gPdf อย่านำเสนอ gPdf เป็น official Shopify app-store integration เว้นแต่ product นั้นมีอยู่จริง

ควรเรียก gPdf API จากที่ไหน

เรียก gPdf จาก backend หรือ app server ของคุณ ซึ่ง Shopify credentials และ gPdf API tokens ได้รับการป้องกัน

Shopify PDFs ควรใช้ JSON Render หรือ Template Render

ใช้ JSON Render สำหรับ custom generated layouts ใช้ Template Render เมื่อ layout ของ merchant หรือ brand ได้รับอนุมัติและ caller ควรส่งเฉพาะ data

gPdf จัดการ Shopify webhooks หรือไม่

ไม่ app ของคุณรับ webhooks, map data และตัดสินใจว่าจะ render เมื่อใด gPdf เพียงเรนเดอร์ PDF request ที่ได้รับ

แพลตฟอร์ม e-commerce

Shopify PDF API สำหรับ apps และ backend workflows

เรียก gPdf จาก Shopify app หรือ backend workflow เพื่อสร้าง order PDFs, invoices, packing slips, returns และ labels จากข้อมูล Shopify ที่ map แล้ว

PRIMARY API JSON Render

ENDPOINT /api/v1/pdf/render

SYSTEMS Shopify app backend / ecommerce backend / OMS / fulfillment workflow

ลองใน Playground อ่านเอกสาร

งานที่ต้องทำให้เสร็จ

ใช้ Shopify app หรือ ecommerce backend map ข้อมูล order, customer, product, fulfillment และ return เป็น gPdf JSON หรือ template data แล้วส่งกลับ PDF แบบ deterministic โดยไม่อ้างว่าเป็น native Shopify app-store integration

ควรใช้ API นี้เมื่อใด

คุณกำลังสร้าง Shopify app, private backend หรือ fulfillment workflow ที่เรียก external APIs ได้
app ของคุณได้รับ Shopify order, fulfillment, customer หรือ product data อยู่แล้ว
คุณต้องการ invoices, packing slips, return documents, warehouse labels หรือ PDF attachments
คุณต้องการ contract แบบ template_id ที่เสถียรสำหรับ layout เอกสารเฉพาะ merchant

สิ่งที่ไม่ได้ทดแทน

คุณคาดหวังให้ gPdf เป็น official Shopify app หรือ app-store listing
คุณต้องการให้ gPdf ติดตั้งใน merchant store, handle OAuth หรือ subscribe webhooks โดยตรง
คุณต้องการ shipping rates, postage purchase, inventory management หรือ merchant UI features จาก gPdf

ควรเรียก endpoint ใด

PRIMARY

/api/v1/pdf/render

JSON Render คือ path หลักสำหรับเวิร์กโฟลว์นี้.

SECONDARY 1

/api/v1/template-render

ใช้เมื่อเวิร์กโฟลว์ต้องการ API path ที่เกี่ยวข้อง สัญญาเทมเพลต หรือการค้นหา capability.

Minimal request

POST /api/v1/template-render - app backend ส่ง mapped Shopify order data ไปยัง published 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 }
      ]
    }
  ]
}

gPdf จัดการอะไร

การเรนเดอร์ PDF จาก JSON ที่ derived จาก Shopify และถูก map โดย app backend ของคุณ
Template Render สำหรับ layout เอกสารเฉพาะ merchant หรือ brand
barcodes, QR codes, tables, totals, images, labels และโครงสร้าง packing-slip
การสร้าง PDF แบบ stateless ผ่าน public gPdf APIs

ระบบของคุณรับผิดชอบอะไร

Shopify app code, OAuth, webhooks, merchant UI และ app-store distribution
การ map order, fulfillment, customer, return, product และ tax data
merchant configuration, template selection, delivery, storage และ retries

Production checklist

เก็บ Shopify credentials และ gPdf API tokens ไว้ใน backend ไม่ใช่ browser code
map Shopify data เป็น explicit render payload หรือ template data schema
ใช้ Template Render สำหรับ layout เฉพาะ merchant หลังอนุมัติ
จัดเก็บ generated PDFs หรือ source data ตาม merchant workflow
ระบุให้ชัดว่า integration คือ app ของคุณเรียก gPdf ไม่ใช่ official gPdf Shopify app

ขอบเขตของ claim

อย่าอ้างว่าเป็น public official Shopify app เว้นแต่ product นั้นมีอยู่จริง
gPdf ไม่รัน Shopify OAuth, app installation, webhooks หรือ merchant settings
caller เป็นเจ้าของ Shopify data mapping และ ecommerce business rules

Integration model

รูปแบบ Shopify integration ที่สะอาดคือ backend-to-backend app ของคุณรับหรือ fetch Shopify data, map เป็น gPdf DocumentRequest หรือ template data object, เรียก gPdf แล้ว return หรือ store PDF ตาม merchant workflow ของคุณ

วิธีนี้ทำให้ public claim ถูกต้อง: gPdf คือ PDF generation API ที่ Shopify app ของคุณเรียกได้ ไม่ใช่ public official Shopify app เว้นแต่จะมี app product แยกต่างหากจริง

Template Render เหมาะกับ merchant layouts

PDF ของ ecommerce มักกลายเป็นเฉพาะ merchant: branding, item tables, return instructions, label blocks, gift notes และ localized text Template Render ทำให้ app ของคุณเก็บ layout เหล่านั้นใน published templates ขณะที่ app ส่งเฉพาะ mapped order data

เก็บ platform logic ไว้ใน app

OAuth, webhooks, merchant settings, fulfillment state, inventory, return rules และ app-store distribution ยังอยู่ใน Shopify app ของคุณ gPdf ควรรับ final render data แล้วสร้าง PDF

FAQ

gPdf เป็น official Shopify app หรือไม่: ไม่ หน้านี้สำหรับ apps และ backends ที่เรียก gPdf อย่านำเสนอ gPdf เป็น official Shopify app-store integration เว้นแต่ product นั้นมีอยู่จริง
ควรเรียก gPdf API จากที่ไหน: เรียก gPdf จาก backend หรือ app server ของคุณ ซึ่ง Shopify credentials และ gPdf API tokens ได้รับการป้องกัน
Shopify PDFs ควรใช้ JSON Render หรือ Template Render: ใช้ JSON Render สำหรับ custom generated layouts ใช้ Template Render เมื่อ layout ของ merchant หรือ brand ได้รับอนุมัติและ caller ควรส่งเฉพาะ data
gPdf จัดการ Shopify webhooks หรือไม่: ไม่ app ของคุณรับ webhooks, map data และตัดสินใจว่าจะ render เมื่อใด gPdf เพียงเรนเดอร์ PDF request ที่ได้รับ