このページは英語から翻訳されています。英語版が正式な情報源です。翻訳内容に不一致がある場合は、英語版を参照してください。
変更履歴
Flex Forward APIおよびドキュメントの主な変更を新しい順に記載しています。2026年7月
変更
- ドキュメント / OpenAPI: 公開認証ガイダンスを修正。顧客連携では
x-rr-apikeyとx-rr-apitokenの両方を送信する必要があります。Bearerトークンの例と公開OpenAPIのbearerAuthスキームを顧客向け認証方法として削除しました。 - 認証: API認証情報は、従来のメールによるトークン申請に代わり、Return Helper User Portal の Settings → Signing Key and API Token から取得します。
2026年6月
Added
- エンドポイント:
GET /couriers— アカウントで利用可能な配送業者コードを一覧表示。返されたcode値を、ラベル作成時または配送業者プロダクトの一覧取得時のcourierとして使用します。
2026年5月
Added
- エンドポイント:
GET /products— 物流業者ごとの利用可能な配送プロダクトを一覧表示。返されたプロダクトコードをラベル作成時に使用します。 - 認証: Flex Forwardリクエスト向けにAPIキー+トークンヘッダー認証(
x-rr-apikey/x-rr-apitoken)を記載。 - エンドポイント:
GET /labels/{id}— カンマ区切りの識別子(ラベルUUIDまたは顧客注文番号)によるバッチ取得に対応。見つからないまたは失敗したラベルはレスポンスから省略されます。 - レスポンス:
GET /labels/{id}のレスポンスにcustomerOrderNumberフィールドを追加。
Changed
- 破壊的変更:
shipperAccountIdをラベル作成リクエストから削除。serviceオブジェクトで不要になりました。 - API仕様: 全エンドポイントに詳細な説明、例、オペレーションIDを追加。
- ドキュメント: クイックスタートガイド、リクエストサンプル、その他の修正を改善。
v1.0.0
Flex Forward APIおよび開発者ドキュメントの初回パブリックリリース。Added
- エンドポイント:
POST /labels(配送ラベル作成)、GET /labels/{id}(ラベル文書URL取得)、GET /tracking/{id}(配送追跡取得) - 本番配送業者: YunExpress(グローバル越境EC配送ルート)
- 冪等性:
idempotencyKeyによるラベル作成の重複防止機能を組み込み - 統一追跡: 正規化されたステータスタグ(
Pending、InfoReceived、InTransit、Delivered、Exception、Cancelled、Unknown)および全配送業者共通の構造化チェックポイントフォーマット - 認証: 本番環境と開発環境で個別の認証情報を使用するAPIキー+トークンヘッダー認証(
x-rr-apikey/x-rr-apitoken) - ドキュメント: クイックスタートガイド、認証リファレンス、エラーハンドリングガイド、冪等性とリトライパターン、環境の詳細、コアコンセプト、バージョニングポリシー、FAQ