メニューインテグレーション
メニューインテグレーション
メニューインテグレーションは、出前館のメニュー構成を加盟店システムから扱うためのAPIを提供します。 このページでは、まず「メニューパターン」と「メニューパターンツリー」の関係を説明し、 そのうえでデベロッパーが実際に行う操作の流れに沿って、利用できるAPIを案内します。
メニューパターンとメニューパターンツリーの概念
メニューパターン
メニューパターンは、どのメニューセットを使うかを識別するための単位です。いわば「箱」や「まとまりの名前」にあたります。
メニューパターンツリー
メニューパターンツリーは、メニューパターンの中に入る実際のメニュー構成です。カテゴリ、商品、サイズ、オプションなど、表示・販売に必要な中身を持ちます。
店舗との関係
作成したメニューパターンは、店舗に紐付けることで実際に利用されます。
メニューパターンとメニューパターンツリーの比較


API連携でできること
自社システムから出前館に登録されているメニュー情報の参照・更新を行うことができます。
これにより、加盟店管理画面での手動更新を減らし、メニュー運用の効率化と反映速度の向上が可能になります。
主要機能
| メニューパターン登録・管理情報連携 | ・メニューパターンの登録 ・メニューパターンの一覧取得 ・メニューパターンの削除 |
メニューパターンの作成、確認を行うAPIを提供します。 メニューパターンを登録、一覧取得、削除することができます。 |
APIリファレンス(登録) APIリファレンス(一覧取得) APIリファレンス(削除) |
|---|---|---|---|
| メニューパターンツリー設定・参照情報連携 | ・メニューパターンツリーの更新 ・メニューパターンツリーの照会 |
メニュー構成の更新、参照を行うAPIを提供します。 メニューパターンに紐づくカテゴリ(メニュー)、商品、サイズ、オプション、オプショングループなどすべての情報を参照・更新できます。 |
APIリファレンス(更新) APIリファレンス(照会) |
| メニューパターンツリー反映状況連携 | ・メニューパターンツリーの反映状況取得 |
更新結果の確認を行うAPIを提供します。 非同期で更新されるメニューパターンツリーの反映状況を確認することができます。 |
APIリファレンス |
| メニューパターンの店舗適用情報連携 | ・メニューパターンと店舗の紐付け更新 ・メニューパターンと店舗の紐付け一覧取得 |
店舗への適用を行うAPIを提供します。 メニューパターンと店舗の紐付けを参照・更新することができます。 |
APIリファレンス(更新) APIリファレンス(一覧取得) |
APIの利用の流れ
①メニューパターンを用意する(メニューパターン登録API)
②メニュー構成の中身を設定、確認する(メニューパターンツリー更新API)
③更新結果を確認する(メニューパターンツリー反映状況取得API)
④店舗に適用する(メニューパターン・店舗紐付け更新AP

※同一のメニューパターンに対するメニューパターンツリー更新は繰り返し可能です。既存のメニューパターンの構成の中身を更新したい場合は①は不要です。※メニューパターンが既に店舗と紐付いている場合でも、メニューパターンツリーの更新は可能です。その場合は④は不要です。
認証認可
認証認可に関しては、こちらをご確認ください。