物流・ラベル
EC のリバースロジスティクスのための返品ラベル API
EC またはサポートデータから、ラベルサイズのページ、バーコード、テンプレート再印刷に対応した返品ラベルと返品案内PDFを生成します。
主 API JSON Render
ENDPOINT
/api/v1/pdf/render 対象システム EC バックエンド / 返品ポータル / OMS / 3PL バックエンド
解決する業務課題
RMA、顧客、品目、返送先、バーコードデータから返品ラベルPDFまたは返品案内シートをレンダリングし、返品ポータルが顧客に再現性のある文書を提供できるようにします。
この API が合う場合
- 自社システムがすでに RMA と返品承認を作成済みの場合。
- 配送会社または返品システムが、ラベルに必要なデータまたは追跡データをすでに提供している場合。
- ダウンロード、メール送信、再印刷ができる PDF ラベルまたは案内シートが必要な場合。
- 同じ返品ラベルレイアウトを Template Render で再利用したい場合。
置き換えないもの
- gPdf に返品の承認、送料の購入、配送会社での出荷作成をさせたい場合。
- 配送会社 API の直接オーケストレーションが必要な場合。
- ZPL などのプリンターコマンド出力が必要な場合。
呼び出す endpoint
/api/v1/pdf/render
JSON Render がこのワークフローの標準パスです。
/api/v1/template-render
関連 API パス、テンプレート契約、または機能確認が必要な場合に使います。
最小リクエスト
POST /api/v1/pdf/render - RMA バーコード付き返品ラベル。
{
"pages": [
{
"size": "label_4_6_in",
"elements": [
{
"type": "text",
"x": 5,
"y": 8,
"content": "RETURN TO",
"style": { "font_size": 9, "font_family": "NotoSans-Regular" }
},
{
"type": "text",
"x": 5,
"y": 18,
"content": "Acme Returns\n500 Dock Door 4\nColumbus OH 43215",
"style": { "font_size": 11, "font_family": "NotoSans-Regular" }
},
{
"type": "barcode",
"format": "code128",
"content": "RMA-2026-77881",
"x": 5,
"y": 70,
"width": 88,
"height": 20,
"barcode_text": { "enabled": true, "position": "bottom" }
}
]
}
]
}
gPdf が担当すること
- ラベルサイズの返品ラベルと案内ページ向け PDF レンダリング。
- バーコード、テキスト、住所、RMA、サービスブロック。
- 承認済み返品ラベルまたは案内レイアウト向けのテンプレート連携。
- 顧客の再ダウンロードとサポート再印刷向けの再現性ある出力。
自社システムが担当すること
- 返品可否、RMA ステータス、配送会社アカウント、送料、追跡番号、顧客向けメッセージ。
- 正しいバーコード値、返送先住所、品目参照、返品受付期間のルール。
- メール配信、ポータルダウンロード、サポート監査証跡。
本番前チェックリスト
- レンダリング前に、返品データを配送会社または返品プロバイダーで検証する。
- 顧客または店舗が使うものと同じ用紙でラベルを印刷・スキャンする。
- X-Request-Id を含め、RMA から PDF までのトレースをサポートログに保存する。
- 顧客視点で、繰り返しダウンロードしても同じ結果になるようにする。
- ラベルレンダリングと返金承認ロジックを分ける。
対応範囲の境界
- gPdf は返品ラベルPDFをレンダリングしますが、返品を承認したり送料を購入したりしません。
- 配送会社の受け入れ確認とバーコード値の正しさは自社側に残ります。
- 公開 API は PDF を返します。ZPL や直接プリンターコマンドではありません。
リバースロジスティクスには明確な責任分担が必要
返品ラベルは、顧客体験と配送会社のルールを組み合わせます。gPdf が担うのは PDF レンダリングです。返品可否、RMA ステータス、追跡、配送会社向けデータ、顧客コミュニケーションは返品システム側で管理します。
連携の中でこの境界を見えるようにしておきます。先に返品判断を生成し、確定したデータから文書をレンダリングしてください。
FAQ
- gPdf は返品出荷を作成しますか？
- いいえ。配送会社または返品プラットフォームが出荷と必要なデータを作成します。gPdf はそのデータを PDF にレンダリングします。
- 返品ラベルはテンプレートから生成できますか？
- はい。返品ラベルまたは案内レイアウトが承認されたら Template Render を使います。
- PDF に返品案内を含められますか？
- はい。同じレンダリングリクエストで、レイアウトに応じてラベルページ、案内ページ、またはその両方を作成できます。
- gPdf は配送会社の認定を置き換えますか？
- いいえ。配送会社の受け入れ確認、スキャナーテスト、バーコード値のルールは自社の責任です。