このページは英語から翻訳されています。英語版が正式な情報源です。翻訳内容に不一致がある場合は、英語版を参照してください。
ラベルドキュメントを取得する
配送ラベルを作成した後、GET /labels/{id}を使用して印刷可能なエアウェイビルドキュメントを取得します。単一の識別子またはカンマ区切りの識別子を渡してバッチ取得できます。このガイドでは、取得フロー、バッチリクエスト、ドキュメント形式、および実用的な考慮事項について説明します。
ドキュメントURLを取得する
ラベル作成レスポンスのidを使用します。{id}には、ラベルのUUID、またはラベル作成時に指定したcustomerOrderNumberのいずれかを指定できます：
レスポンス
200 OK
ダウンロードして印刷する
返されたurlからドキュメントをダウンロードします：
ドキュメントの動作
- 時限付きURL —
urlは短命なダウンロードリンクです（現時点では約1時間有効ですが、変更される可能性があります）。永続化しないでください。ダウンロードが必要な際は、GET /labels/{id}を再度呼び出して新しいURLを取得してください。 - 形式 — ラベル作成時に
label.formatを"PDF"または"PNG"に設定してください。省略時はPDFが選択されます。GET /labels/{id}は選択された形式を小文字のlabelFormat: "pdf"または"png"として返しますが、形式自体を変更するものではありません。このページの例はPDFラベルを取得します。 - 再取得 — 呼び出すたびに同じドキュメントに対する新しいURLが返されます。ドキュメントの内容は不変ですが、URL文字列は変わります。
バッチ取得
カンマ区切りの識別子を渡すことで、1回のリクエストで複数のラベルドキュメントを取得できます。ラベルUUIDと顧客注文番号を混在させることができます。 識別子リストの処理方法：- パスパラメータはカンマで分割されます。各要素は前後の空白が除去され、空の要素は破棄され、重複は1つにまとめられます。そのため
a,,a, bはa,bとして扱われます。 - 残った識別子が1つの場合は単一ラベルのレスポンスが返ります（存在しなければ
404、配送業者への送信に失敗したラベルなら422）。2つ以上の場合は、以下で説明するlabels配列の形式で返ります。 - 存在しないラベルと配送業者への送信に失敗したラベルは、エラー項目なしで
labelsから省略されます。いずれの識別子も解決できない場合、リクエストは404を返します。 - 現時点では上限は設けられていません。バッチは小さく（数百ではなく数十件程度）保ってください。識別子ごとに配送業者からドキュメントを解決します。
バッチレスポンス
200 OK
見つからないまたは失敗したラベルはレスポンスから暗黙的に省略されます。返された
labels配列をリクエストした識別子と比較して、解決されなかったものを検出してください。エラーハンドリング
次のステップ
出荷を追跡する
ラベルを印刷して荷物に貼付した後、出荷状況を監視します。
エラーハンドリング
すべてのHTTPステータスコードとエラーレスポンス形式の完全なリファレンス。