バージョニング

このガイドでは、Merchant API でバージョン管理、リリース、さまざまなバージョンのライフサイクルがどのように処理されるかについて説明します。

バージョニング体系

Merchant API は、サブ API レベルでバージョニング戦略を採用しています。つまり、Merchant API 内の個々のコンポーネントまたはサービスには、独自のバージョン ライフサイクルがあります。

バージョニングの形式と表示

  • 安定版のサブ API バージョン: サブ API が安定版の場合、そのすべてのメソッドは安定版です。安定したサブ API バージョンは vX で表されます(v1、v2 など)。これらは、本番環境向けのメジャー バージョンです。

  • アルファ版のサブ API バージョン: サブ API がアルファ版の場合、そのすべてのメソッドはアルファ版です。アルファ版のサブ API バージョンは vXalpha で表されます(v1alpha、v2alpha など)。これらは、テストと迅速な反復を目的とした早期アクセスの試験運用版です。アルファ版には安定性が保証されず、ライフタイムも保証されません。アルファ版は、30 日前の通知で変更または廃止できます。

バージョンの変更

  • メジャー バージョンの増分(v1 から v2 など): 下位互換性のない破壊的変更が示されます。この場合は、デベロッパーによる対応が必要になります。新しいバージョン番号が付与されるのは、安定版サブ API の互換性のない変更のみです。たとえば、v1 から v2 に変更します。

  • マイナー変更: 下位互換性のある追加や修正は、既存のメジャー バージョンの変更として表示されます。このような変更は、そのメジャー バージョンのリリースノートに詳しく記載されています。サブ API への非破壊的な追加は、最新の安定版のアルファ版チャンネルにリリースされるか、最新の安定版に直接リリースされます。

廃止

古い Merchant サブ API のバージョンは、定期的にサポートを終了します。安定版メジャー バージョン(vX)については、公式のサポート終了のお知らせから 12 か月間のサポート終了期間を設定します。

たとえば、Products サブ API の v1 が 2026 年 1 月 15 日に非推奨になった場合、2027 年 1 月 15 日より前に廃止されることはありません。この日以降、以前のバージョンのサブ API は使用できなくなります。

サブ API のバージョンとライフサイクルのステータス

次の表に、Merchant API の各サブ API の最新バージョンを示します。

サブ API アルファ版 ベータ版 ステータス
アカウント 利用不可 v1 ベータ版 v1 ベータ版が有効
プロダクト 利用不可 v1 ベータ版 v1 ベータ版が有効
商品の入力 利用不可 v1 ベータ版 v1 ベータ版が有効
ローカル在庫 利用不可 v1 ベータ版 v1 ベータ版が有効
地域別在庫 利用不可 v1 ベータ版 v1 ベータ版が有効
データソース 利用不可 v1 ベータ版 v1 ベータ版が有効
プロモーション 利用不可 v1 ベータ版 v1 ベータ版が有効
レポート 利用不可 v1 ベータ版 v1 ベータ版が有効
コンバージョン 利用不可 v1 ベータ版 v1 ベータ版が有効
通知 利用不可 v1 ベータ版 v1 ベータ版が有効
クチコミ 利用不可 v1 ベータ版 v1 ベータ版が有効
配送設定 利用不可 v1 ベータ版 v1 ベータ版が有効
Product Studio v1 alpha 利用不可 v1 アルファ版が有効

ベスト プラクティス

  • リリースノートや最新情報を定期的に確認し、新しいバージョン、メジャー アップデート、改善点、サブ API のリリースと非推奨化に関するお知らせをご確認ください。
  • サブ API に 2 つ以上の安定版がある場合は、常に最新バージョンを使用することをおすすめします。
  • ネットワークの問題、レート制限、新しいサブ API バージョンで導入される可能性のある新しいエラーコードやメッセージなど、さまざまなサブ API エラーを適切に処理するようにアプリケーションを設計します。
  • サブ API バージョンのサポートが終了するまで待ってからアップグレードの計画を開始しないでください。新しいバージョンが利用可能になり次第、評価とテストを開始します。
  • サブ API のロードマップに関する機能リクエストや懸念事項については、質問やフィードバックをお寄せください。Merchant API チームにテクニカル サポートを依頼する方法については、Merchant API に関するヘルプをご覧ください。