このページは英語から翻訳されています。英語版が正式な情報源です。翻訳内容に不一致がある場合は、英語版を参照してください。
ラベルドキュメントを取得する
配送ラベルを作成した後、GET /labels/{id}を使用して印刷可能なエアウェイビルドキュメントを取得します。単一の識別子またはカンマ区切りの識別子を渡してバッチ取得できます。このガイドでは、取得フロー、バッチリクエスト、ドキュメント形式、および実用的な考慮事項について説明します。
ドキュメントURLを取得する
ラベル作成レスポンスのidを使用します:
レスポンス
200 OK
| フィールド | 説明 |
|---|---|
id | ラベルのUUID(リクエストパラメータと同じ)。 |
customerOrderNumber | このラベルに関連付けられた顧客注文番号。 |
url | エアウェイビルドキュメントの直接ダウンロードURL。 |
labelFormat | ドキュメント形式:pdfまたはpng。 |
ダウンロードして印刷する
返されたurlからドキュメントをダウンロードします:
ドキュメントの動作
- 永続URL — ドキュメントURLは有効期限がありません。URLを保存して、いつでもドキュメントをダウンロードできます。
- 形式 — ドキュメントは、配送業者とラベル設定に応じて、PDFまたはPNGで提供されます。
- 再取得 —
GET /labels/{id}を複数回呼び出しても、同じURLが返されます。このエンドポイントは本質的にべき等です。
バッチ取得
カンマ区切りの識別子を渡すことで、1回のリクエストで複数のラベルドキュメントを取得できます。ラベルUUIDと顧客注文番号を混在させることができます。バッチレスポンス
200 OK
| フィールド | 説明 |
|---|---|
labels | 正常に解決されたラベルドキュメントの配列。見つからないまたは失敗したラベルは省略されます。 |
labels[].id | ラベルのUUID。 |
labels[].customerOrderNumber | このラベルに関連付けられた顧客注文番号。 |
labels[].url | エアウェイビルドキュメントの直接ダウンロードURL。 |
labels[].labelFormat | ドキュメント形式:pdfまたはpng。 |
見つからないまたは失敗したラベルはレスポンスから暗黙的に省略されます。返された
labels配列をリクエストした識別子と比較して、解決されなかったものを検出してください。エラーハンドリング
| ステータス | 意味 | アクション |
|---|---|---|
| 200 | ドキュメントURLを取得しました | urlフィールドからダウンロードしてください |
| 403 | アクセス拒否 | ラベルが別のアカウントに属しています |
| 404 | ラベルが見つかりません | ラベルIDが正しいか確認してください |
| 502 | 上流サービスエラー | エクスポネンシャルバックオフでリトライしてください |
次のステップ
出荷を追跡する
ラベルを印刷して荷物に貼付した後、出荷状況を監視します。
エラーハンドリング
すべてのHTTPステータスコードとエラーレスポンス形式の完全なリファレンス。