ラベルドキュメントを取得する
配送ラベルを作成した後、GET /labels/{id}を使用して印刷可能なエアウェイビルドキュメントを取得します。このガイドでは、取得フロー、ドキュメント形式、および実用的な考慮事項について説明します。
ドキュメントURLを取得する
ラベル作成レスポンスのidを使用します:
レスポンス
200 OK
| フィールド | 説明 |
|---|---|
id | ラベルのUUID(リクエストパラメータと同じ)。 |
url | エアウェイビルドキュメントの直接ダウンロードURL。 |
labelFormat | ドキュメント形式:pdfまたはpng。 |
ダウンロードして印刷する
返されたurlからドキュメントをダウンロードします:
ドキュメントの動作
- 永続URL — ドキュメントURLは有効期限がありません。URLを保存して、いつでもドキュメントをダウンロードできます。
- 形式 — ドキュメントは、配送業者とラベル設定に応じて、PDFまたはPNGで提供されます。
- 再取得 —
GET /labels/{id}を複数回呼び出しても、同じURLが返されます。このエンドポイントは本質的にべき等です。
エラーハンドリング
| ステータス | 意味 | アクション |
|---|---|---|
| 200 | ドキュメントURLを取得しました | urlフィールドからダウンロードしてください |
| 403 | アクセス拒否 | ラベルが別のアカウントに属しています |
| 404 | ラベルが見つかりません | ラベルIDが正しいか確認してください |
| 502 | 上流サービスエラー | エクスポネンシャルバックオフでリトライしてください |