メインコンテンツへスキップ

ラベルドキュメントを取得する

配送ラベルを作成した後、GET /labels/{id}を使用して印刷可能なエアウェイビルドキュメントを取得します。このガイドでは、取得フロー、ドキュメント形式、および実用的な考慮事項について説明します。

ドキュメントURLを取得する

ラベル作成レスポンスのidを使用します:
curl https://api.flexforward.com/labels/f47ac10b-58cc-4372-a567-0e02b2c3d479 \
  -H "Authorization: Bearer YOUR_API_TOKEN"

レスポンス

200 OK
{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "url": "https://label-cdn.yunexpress.cn/labels/YT2503010001.pdf",
  "labelFormat": "pdf"
}
フィールド説明
idラベルのUUID(リクエストパラメータと同じ)。
urlエアウェイビルドキュメントの直接ダウンロードURL。
labelFormatドキュメント形式:pdfまたはpng

ダウンロードして印刷する

返されたurlからドキュメントをダウンロードします:
curl -o label.pdf "https://label-cdn.yunexpress.cn/labels/YT2503010001.pdf"

ドキュメントの動作

  • 永続URL — ドキュメントURLは有効期限がありません。URLを保存して、いつでもドキュメントをダウンロードできます。
  • 形式 — ドキュメントは、配送業者とラベル設定に応じて、PDFまたはPNGで提供されます。
  • 再取得GET /labels/{id}を複数回呼び出しても、同じURLが返されます。このエンドポイントは本質的にべき等です。

エラーハンドリング

ステータス意味アクション
200ドキュメントURLを取得しましたurlフィールドからダウンロードしてください
403アクセス拒否ラベルが別のアカウントに属しています
404ラベルが見つかりませんラベルIDが正しいか確認してください
502上流サービスエラーエクスポネンシャルバックオフでリトライしてください

次のステップ