コンテンツにスキップ
スマレジ・プラットフォームAPI 仕様書

店舗のメニュー取得

GET
/stores/{store_id}/menus/{menu_id}

店舗で取り扱うメニューを取得します。

コースメニューは、コース区分が「標準コース」の場合のみ取得可能です。「簡易コース」はサポートしておりません。

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
store_id
required
string

店舗ID

menu_id
required
string

メニューID

Query Parameters

Section titled “Query Parameters ”
with_custom_order
string
default: none
Allowed values: all none

お好みオーダー情報を含むかを指定します。

  • all: 全て含む
  • none: 含めない (キー customOrder を含めない)
Example
none

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

StoreMenu

店舗のメニュー

object
id
required

メニューID

string
name

メニュー名

string
kana

メニュー名（カナ）

string
type

メニュー種別

  • normal:単品
  • plan:プラン
  • course:コース
string
Allowed values: normal plan course
categoryId

カテゴリーID

string
note

メニュー説明

string
sortNo

ソート番号

integer
applyDatetime

適用開始日時[YYYY-MM-DDThh:mm:ssTZD]

string
nullable
customId

お好みオーダーID

string
nullable
customOrder

クエリパラメーターに with_custom_order=all を指定した場合、レスポンスに含まれます。

object
customId

お好みオーダーID

string
customName

お好みオーダー名

string
contents

お好みオーダー内容

Array
object
customContentId

お好みオーダー内容ID

string
customContentName

お好みオーダー内容名

string
sortNo

ソート番号

integer
isOpenPrice
  • true:注文時に価格決定する
  • false:設定価格で注文する
boolean
createdIn

作成元サービス

string
nullable
Allowed values: waiter pos headquarters
toppingGroupId

トッピンググループID
メニューが単品(type=normal)またはプラン(type=plan)の場合、レスポンスに含まれます。

string
nullable
prices
Array
PriceSetting
object
taxRate

税率

number
taxType

税種別

  • normal:標準
  • reduced:軽減
  • none:非課税
string
Allowed values: normal reduced none
amount

金額

string
tax

金額の税情報

  • include: 税込
  • exclude: 税抜
  • none: 非課税

※ 注文のリクエストボディで指定できる tax (金額の税情報)と単語が一致していませんのでご注意ください。

※ テーブル利用セクション、注文セクションのレスポンスに含まれる sellingPrice<NewOrderItemPrice> の tax (金額の税情報)と単語が一致していません。

string
Allowed values: include exclude none
primary

複数価格存在する場合の初期選択設定

  • true:初期選択値
  • false:初期選択でない
boolean
menus

プラン内メニュー
メニューがプラン(type=plan)の場合、レスポンスに含まれます。

Array<object>
MenuSimple

メニュー情報

object
id
required

メニューID

string
name

メニュー名

string
kana

メニュー名（カナ）

string
type

メニュー種別

  • normal:単品
  • plan:プラン
  • course:コース
string
Allowed values: normal plan course
categoryId

カテゴリーID

string
note

メニュー説明

string
sortNo

ソート番号

integer
applyDatetime

適用開始日時[YYYY-MM-DDThh:mm:ssTZD]

string
nullable
customId

お好みオーダーID

string
nullable
sections

セクションリスト
メニューがコース(type=course)の場合、レスポンスに含まれます。

Array<object>
object
name

セクション名

string
menus

セクション内メニュー

Array
object
id
required

メニューID

string
name

メニュー名

string
kana

メニュー名（カナ）

string
type

メニュー種別

  • normal:単品
  • plan:プラン
  • course:コース
string
Allowed values: normal plan course
categoryId

カテゴリーID

string
note

メニュー説明

string
sortNo

ソート番号

integer
applyDatetime

適用開始日時[YYYY-MM-DDThh:mm:ssTZD]

string
nullable
customId

お好みオーダーID

string
nullable
extraPrice

追加料金

string
Examples
{
  "id": "1",
  "name": "和風オムライス",
  "kana": "ワフウオムライス",
  "type": "normal",
  "categoryId": "3",
  "note": "だしベースのオムライスです。",
  "sortNo": 5,
  "applyDatetime": null,
  "customId": "7",
  "isOpenPrice": false,
  "createdIn": "waiter",
  "toppingGroupId": "2",
  "prices": [
    {
      "taxRate": 10,
      "taxType": "normal",
      "amount": "1100",
      "tax": "include",
      "primary": true
    },
    {
      "taxRate": 8,
      "taxType": "reduced",
      "amount": "1080",
      "tax": "include",
      "primary": false
    }
  ]
}

404

Section titled “404 ”

店舗が指定のメニューを取り扱わない場合

object
title
required
string
type
required
string
status
integer
detail
string