Ecommerce platforms
Shopify アプリバックエンド向け PDF API
Shopify PDF API: ブラウザレンダリングなしでShopify の注文・フルフィルメントデータから PDF を生成する。gPdf の描画責任と自社の業務データ責任を明確に分けます。
主 API JSON Render
ENDPOINT
/api/v1/pdf/render 対象システム Shopify アプリバックエンド / EC バックエンド / OMS / フルフィルメントワークフロー
解決する業務課題
Shopify の注文・フルフィルメントデータから PDF を生成する。自社システムが業務データとルールを持ち、gPdf はそれを PDF として再現性高く出力します。
この API が合う場合
- 自社システムがShopify PDFに必要なデータをすでに持っており、PDF レスポンスが必要です。
- ブラウザベースの HTML to PDF ではなく、/api/v1/pdf/render の JSON Render を使いたい場合。
- レイアウト、バーコード、テキスト、メタデータを構造化データから再現可能に生成したい場合。
- 本番投入前に Playground や CI でペイロードを再現検証したい場合。
置き換えないもの
- Chromium を使った任意 HTML to PDF 変換が必要な場合。
- 生データから業務上・法的な意味を gPdf に推定させたい場合。
- 毎回レイアウトを送るより公開済み template_id 契約のほうが適している場合。
呼び出す endpoint
/api/v1/pdf/render
JSON Render がこのワークフローの標準パスです。
/api/v1/template-render
関連 API パス、テンプレート契約、または機能確認が必要な場合に使います。
最小リクエスト
/api/v1/pdf/render - Shopify PDFの最小リクエスト。
{
"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 が担当すること
- 構造化リクエストからShopify PDFをレンダリングします。
- 必要に応じて PDF ページ、テキスト、表、線、図形、画像、ベクターバーコードを描画します。
- 再印刷、監査、バックエンド自動化に向いた再現性のある PDF を返します。
- 失敗時は API-XXX コードと req_id を含む共通エラー形式を返します。
自社システムが担当すること
- 業務データ、フィールドマッピング、文書の意味付け。
- レスポンス後の検証、冪等性、ファイル名、保存、追跡。
- レンダリング前の税務、コンプライアンス、顧客、プラットフォーム固有ルール。
本番前チェックリスト
- 本番呼び出しには request ID と timeout を設定します。
- OpenAPI、ドキュメント、Golden PDF テストでペイロードを検証します。
- API ベース URL と bearer token は設定化し、ソースコードに埋め込みません。
- 重要レイアウトは実データと境界ケースでテストします。
- 検証証跡と再出力に必要な情報を自社システム側に保持します。
対応範囲の境界
- gPdf はShopify PDFをレンダリングしますが、業務上の正しさは自社システムの責任です。
- このページは適切な gPdf API パスを示すもので、追加のワークフロー専用 endpoint ではありません。
- 外部認証、受け入れ判定、現場の運用承認はレンダラーの範囲外です。
このワークフローと gPdf の関係
Shopify PDF API は、公開 gPdf API を使う本番向けワークフローです。リクエストでは、データ、レイアウト、settings、PDF に描画する要素を明示します。gPdf が担当するのはレンダリングであり、データの業務判断ではありません。
API パスと責任境界
多くの場合、/api/v1/pdf/render の JSON Render が出発点になります。マスターデータ、検証、保存、業務ルールは自社システム側に残ります。つまり、gPdf は PDF を生成し、アプリケーションが意味とプロセスを制御します。
本番化の確認
Shopify PDFは、ワークフローに応じて実データ、プリンター、スキャナー、検証エンジン、受信側システムで確認してください。サポート、監査、再出力に使えるよう request ID と検証証跡を保存します。
FAQ
- Shopify PDF API は専用 endpoint ですか？
- いいえ。このページは /api/v1/pdf/render と関連する gPdf API をこのワークフローでどう使うかを説明します。
- 自社システムは何を用意しますか？
- 業務データ、フィールドマッピング、検証、本番ルールは自社システムが用意します。gPdf は PDF 生成を担当します。
- Template Render はいつ使いますか？
- レイアウトが固定され、呼び出し側が template_id と data[] だけを送ればよい段階で Template Render を使います。
- 本番前に何を確認しますか？
- 実データ、境界ケース、検証、PDF を読む・印刷する・保管する後続システムで確認します。