バージョニングガイド

概要

※このバージョンニングガイドはデベロッパーサイトに公開している機能を対象にします。
出前館のAPIはエンドポイント単位でバージョンが指定されます。
機能の追加・変更・削除に関するリリース情報はリリースノートにてお知らせ致します。

下位互換性のある修正に関しては各APIドキュメントとAPIリファレンスの更新と共にリリースされます。

下位互換性のない修正に関してはAPIドキュメントとAPIリファレンスは新・旧でページが別途用意されます。旧資料に関してはDeprecatedマークが付きます。旧機能のAPIドキュメントとAPIリファレンスの保持期限はありませんが、リリースから180日以内に新規機能への移行を推奨します。
かつ、Deprecatedになったバージョンに関しては新規のAPI連携を不可とし、利用についても積極的な修正やサポートはいたしかねます。

---

API

下位互換性のある（互換性を損なわない）変更

• APIを追加する
• HTTPメソッドを追加する
• 必須ではないリスエストフィールドを追加する
• 必須リクエストフィールドを非必須に変更する
• レスポンスフィールドを追加する
• 必須ではないレスポンスフィールドを必須に変更する
• 列挙型の値を追加する
• エラーコードやエラーメッセージを追加する

下位互換性のない（互換性を損なう）変更

• APIを削除する
• HTTPメソッドを変更・削除する
• 必須リクエストフィールドを追加する
• 必須ではないリクエストフィールドを必須に変更する
• 既存リクエストフィールド名やタイプを変更する
• リクエストフィールドを削除する
• 必須レスポンスフィールドを非必須に変更する
• 既存レスポンスフィールド名やタイプを変更する
• レスポンスフィールドを削除する
• 列挙型の値を変更・削除する
• URL形式を変更する
• エラーコードやエラーメッセージを変更・削除する

Webhook

加盟店システム構成により、以下の例に一致しない場合があります。

下位互換性のある（互換性を損なわない）変更

• HTTPメソッドを削除する
• リクエストフィールドを追加する
• 必須ではないリクエストフィールドを必須に変更する
• 必須ではないレスポンスフィールドを追加する
• 必須レスポンスフィールドを非必須に変更する
• レスポンスフィールドを削除する
• 列挙型の値を追加する

下位互換性のない（互換性を損なう）変更

• HTTPメソッドを追加・変更する
• 必須リクエストフィールドを非必須に変更する
• 既存リクエストフィールド名やタイプを変更する
• リクエストフィールドを削除する
• 必須レスポンスフィールドを追加する
• 必須ではないレスポンスフィールドを必須に変更する
• 既存レスポンスフィールド名やタイプを変更する
• 列挙型の値を変更・削除する
• URL形式を変更する

※上記に記載がない場合でも、加盟店システムに影響がない変更は下位互換性のある変更として、加盟店システムに影響がある変更は下位互換性のない変更として扱います。