gPdf
Nền tảng thương mại điện tử

API PDF cho ứng dụng Shopify và quy trình backend

Gọi gPdf từ ứng dụng Shopify hoặc quy trình backend để tạo PDF đơn hàng, hóa đơn, packing slips, returns và nhãn từ dữ liệu Shopify đã map.

API CHÍNH JSON Render
ENDPOINT /api/v1/pdf/render
HỆ THỐNG ứng dụng Shopify / backend thương mại điện tử / OMS / job queue
Thử trong Playground Đọc tài liệu
Việc cần giải quyết

Dùng ứng dụng Shopify hoặc backend thương mại điện tử để map dữ liệu order, customer, product, fulfillment và return thành JSON gPdf hoặc dữ liệu template, rồi trả về PDF xác định mà không tuyên bố native Shopify app-store integration.

Khi nào dùng API này

  • Ứng dụng hoặc backend của bạn đã đọc và map dữ liệu Shopify cần in.
  • Bạn cần hóa đơn, packing slips, returns, labels hoặc PDF vận hành.
  • Bạn muốn bố cục PDF ổn định mà không chạy trình duyệt.
  • Bạn có thể tự quản lý OAuth, webhook, app billing và logic Shopify.

Những gì không thay thế

  • Bạn cần gPdf là ứng dụng Shopify chính thức hoặc connector marketplace.
  • Bạn cần gPdf xử lý OAuth, webhook, app billing hoặc đồng bộ dữ liệu Shopify.
  • Bạn cần hệ thống OMS/fulfillment đầy đủ thay vì kết xuất PDF.

Endpoint cần gọi

CHÍNH

/api/v1/pdf/render

JSON Render là đường mặc định cho quy trình này.

PHỤ 1

/api/v1/template-render

Dùng khi quy trình cần API liên quan, hợp đồng mẫu hoặc truy vấn năng lực.

Request tối thiểu

POST /api/v1/pdf/render - PDF cho Shopify.

{
  "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 xử lý gì

  • Kết xuất PDF từ DocumentRequest hoặc dữ liệu template đã map từ Shopify.
  • Text, bảng, mã vạch, bố cục nhãn, metadata và template đầu ra.
  • Template Render cho bố cục merchant dùng lặp lại.
  • phản hồi PDF xác định cho email, download, print hoặc attachment.

Hệ thống của bạn quản lý gì

  • Shopify authentication, webhook, app permissions và dữ liệu order/customer/product.
  • Ánh xạ trường, business rules, fulfillment state và delivery quy trình.
  • Storage, retry, thiết lập của merchant và acceptance trong app của bạn.

Checklist đưa vào production

  1. Map trường Shopify sang schema gPdf một cách testable.
  2. Dùng template_id cho bố cục merchant ổn định.
  3. Log request ID cùng shop ID, order ID hoặc fulfillment ID.
  4. Kiểm tra với dữ liệu merchant thật và trường hợp item dài.
  5. Không tuyên bố native Shopify integration nếu đó là quy trình backend của bạn.

Ranh giới tuyên bố

  • gPdf kết xuất PDF; gPdf không phải Shopify app-store connector chính thức.
  • Shopify platform logic, OAuth, billing và webhooks thuộc ứng dụng của bạn.
  • Hệ thống gọi chịu trách nhiệm về dữ liệu và quyền truy cập Shopify.

Mô hình tích hợp

Mô hình đúng là ứng dụng hoặc backend của bạn map dữ liệu Shopify sang gPdf JSON hoặc dữ liệu template. gPdf không tự đọc Shopify, không quản lý OAuth và không đóng vai trò connector marketplace.

Template Render phù hợp với bố cục merchant

Khi bố cục hóa đơn, packing slip hoặc nhãn đã ổn định, Template Render giúp hệ thống gọi chỉ gửi trường nghiệp vụ theo template_id. Điều này phù hợp với thiết lập của merchant và các bố cục dùng lặp lại.

Giữ logic nền tảng trong ứng dụng

Giữ webhook, app billing, permissions, shop configuration và fulfillment state trong app của bạn. gPdf chỉ kết xuất PDF từ request đã hợp lệ.

FAQ

Đây có phải API PDF cho Shopify độc lập không?
Có. Trang này ánh xạ quy trình PDF cho Shopify vào endpoint công khai POST /api/v1/pdf/render. Hệ thống của bạn vẫn sở hữu dữ liệu nghiệp vụ, còn gPdf chỉ tạo PDF từ request hợp lệ.
Khi nào nên dùng Template Render?
Dùng Template Render khi bố cục đã được duyệt và bạn muốn gọi bằng template_id cùng data thay vì gửi toàn bộ tọa độ ở mỗi request.
API có trả PDF trực tiếp không?
Có. Khi kết xuất thành công, API trả về application/pdf. Khi lỗi, API dùng JSON error envelope chung với mã API-XXX và req_id.
Cần kiểm tra gì trước production?
Hãy kiểm tra bằng order thật, thiết lập của merchant, webhook flow và quyền ứng dụng Shopify của bạn.
Giải pháp API nhãn Amazon FBA JSON Render Giải pháp API PDF packing slip Template Render Giải pháp API nhãn hoàn trả JSON Render Giải pháp API PDF biên nhận JSON Render Giải pháp API PDF hóa đơn JSON Render Giải pháp API nhãn vận chuyển JSON Render Tham chiếu Tham chiếu Render API /docs/api-reference/ Tham chiếu Tham chiếu Template API /docs/template-api/ Tham chiếu PDF nhãn vận chuyển /use-cases/shipping-labels/ Tham chiếu Thư viện mẫu /templates/ Tham chiếu Tạo PDF cho logistics và thương mại điện tử /blog/logistics-ecommerce-pdf-generation-fit/