​

変更履歴

Flex Forward APIおよびドキュメントの主な変更を新しい順に記載しています。

---

​

2026年10月

​

APIの変更

• EU向け商品識別子： shipment.parcels[].items[].attributes.productIdentifiers に、通関申告用の商品識別子を記載します。EU、モナコ、フランスの海外地域、または北アイルランド（郵便番号が BT で始まる地域）向けに発送する各商品には、mpid、nspid、spid をコードのリストとして指定してください。それ以外の地域では、いずれも任意です。説明ではコードの制約も明記しており、spid は空欄にできず、商品にバーコードがない場合に限り Y081 を使用できます。

---

​

2026年9月

​

APIの変更

• エンドポイント： GET /orders/{orderId} — 注文 1 件を、ラベル作成時に指定した配送業者詳細とあわせて取得します。レスポンスには、注文の輸送段階（status）、商業上の exceptionState、配送業者の識別子、申告した荷物の重量・寸法、配送業者への送信エラー（error）に加え、送信した注文番号、通関用識別番号、サービスオプション、配送業者オプションが含まれます。{orderId} には POST /labels が返したラベル id を指定します。このエンドポイントは UUID のみを受け付け、customerOrderNumber は使用できません。ラベル文書のみを返す GET /labels/{id} を補完するものです。
• 冪等性： 異なるリクエスト本文で idempotencyKey を再利用すると 409 IDEMPOTENCY_CONFLICT が返ります。同じキーと本文のリクエストは保存結果を再生します。保存されたリクエストのフィンガープリントを持たない古い記録は、従来どおりのリプレイ動作を維持します。
• ラベル形式： label.format は PDF と PNG に対応し、省略時は PDF になります。文書のレスポンスは、選択された形式を小文字の pdf または png として返します。
• 顧客注文番号： 指定値は 1〜40 文字の ASCII 英字、数字、-、_ のみを含む必要があり、大文字と小文字を区別し、アカウントごとに一意です。省略した場合はシステムが生成します。FlexForward は、配送業者の顧客参照として、また対応している場合は印字用として {clientCode}-{customerOrderNumber} を渡します。
• 商品価格： unitPrice.amount は少なくとも 0.01 である必要があります。無償のギフト、サンプル、販促用同梱物であっても、0 ではなく 0.01 以上の名目価格で申告する必要があります。unitPrice.currency は USD のみを受け付けます。通貨を省略した場合も USD を意味します。
• IOSS の取り扱い： customs.taxIds.ioss では、指定された空白でない値は前後の空白を除去したうえで使用されることが明記されました。この項目が省略されているか空欄で、仕向地が EU の課税国である場合は、FlexForward のデフォルト IOSS コードが自動的に適用されます。IOSS registrations に登録したコードは、リクエストで送信しない限り自動適用されません。FlexForward のデフォルトコードを適用する場合は、配送運賃とあわせて VAT 前払いとサービス料が計上されるため課金対象です。ここで独自のコードを指定した場合は課金されません。

​

ドキュメントの修正

• コアコンセプトのリソース表とインテグレーションフローに、注文リソースと GET /orders/{orderId} を追加しました。
• 国際配送ガイドを更新し、unitPrice.amount の最小値が 0.01 であること、および価値が 0 の税関申告は受け付けられないことを反映しました。
• IOSS の判定と課金を明確化しました。指定された customs.taxIds.ioss の値は保持され、この項目が省略されているか空欄で仕向地が EU の課税国である場合は FlexForward のデフォルト IOSS コードが自動適用されます。また、デフォルトコード経由は課金対象であり、独自のコードを指定した場合は課金されないことを明記しました。

​

ドキュメント保守

• 生成された 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

• service.shipperAccountId は現在オプションです。省略した場合、リクエストされた配送業者について、アカウントのデフォルトの配送アカウントでラベルが作成されます。引き続き送信するリクエストも問題なく動作します。
• 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