コンテンツにスキップ

メニュー

POST
/webhook-menus
curl --request POST \
--url https://api.smaregi.dev/TARGET-CONTRACT-ID/waiter/webhook-menus \
--header 'Content-Type: application/json' \
--data '{ "contractId": "smaregi", "event": "waiter:menus", "action": "created", "menuIds": [ "1", "2", "3" ] }'

プラットフォームAPIで参照できるメニューの登録、更新、削除を通知します。

【以下の送信条件は waiter-server ver.2.46.0 (2026年10月上旬リリース予定) で追加予定】

単品メニュー(type=normal)はサブメニュー専用フラグ(submenuOnly)を持つため、その値に応じた送信条件と action は以下のとおりです。

操作または変更 action
submenuOnly=false で登録 created
submenuOnly=true で登録 送信しない
false から false への更新 updated
false から true への更新 deleted
true から false への更新 created
true から true への更新 送信しない
削除前が false のメニューを削除 deleted
削除前が true のメニューを削除 送信しない

複数メニューの action が異なる場合は、action ごとに分けて通知します。

Smaregi-Event
string

イベント名 waiter:menus

Media typeapplication/json
object
contractId
契約ID
string
event
イベント
string
action
アクション
  • created: 登録
  • updated: 更新
  • deleted: 削除
string
menuIds
メニューIDリスト
array
Examples
Exampleリクエスト例
{
"contractId": "smaregi",
"event": "waiter:menus",
"action": "created",
"menuIds": [
"1",
"2",
"3"
]
}

OK