メニュー一覧取得

GET

/menus

サンドボックス
本番

メニュー一覧を取得します。

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

Authorizations

AppAccessToken
waiter.menus:read

Parameters

Query Parameters

type

string

default: all

Allowed values: all normal plan course

[フィルタ]メニュー種別

all: 全て
normal: 単品
plan: プラン
course: コース

Example

normal

category_id

string

カテゴリーID

Example

with_custom_order

string

default: none

Allowed values: all none

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

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

Example

none

limit

integer

default: 20 >= 1 <= 100

取得件数

Example

sort

string

default: sort_no

ソート順

sort_no: ソート番号
id: メニューID
name: メニュー名

Example

sort_no

page

integer

default: 1 >= 1

ページ番号

Example

Responses

200

Array

Menu

メニュー情報

object

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

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

Examples

[
  {
    "id": "1",
    "name": "サラダ",
    "kana": "サラダ",
    "type": "normal",
    "categoryId": "3",
    "note": "",
    "sortNo": 1,
    "applyDatetime": null,
    "customId": "1",
    "isOpenPrice": false,
    "createdIn": "waiter",
    "prices": [
      {
        "taxRate": 10,
        "taxType": "normal",
        "amount": "690",
        "tax": "include",
        "primary": true
      }
    ]
  },
  {
    "id": "2",
    "name": "スープ",
    "kana": "スープ",
    "type": "normal",
    "categoryId": "3",
    "note": "",
    "sortNo": 2,
    "applyDatetime": null,
    "customId": null,
    "isOpenPrice": false,
    "createdIn": "waiter",
    "prices": [
      {
        "taxRate": 10,
        "taxType": "normal",
        "amount": "490",
        "tax": "include",
        "primary": true
      }
    ]
  }
]

[
  {
    "id": "1",
    "name": "サラダ",
    "kana": "サラダ",
    "type": "normal",
    "categoryId": "3",
    "note": "",
    "sortNo": 1,
    "applyDatetime": null,
    "customId": "1",
    "customOrder": {
      "customId": "1",
      "customName": "ドレッシング",
      "contents": [
        {
          "customContentId": "2",
          "customContentName": "胡麻ドレッシング",
          "sortNo": 1
        },
        {
          "customContentId": "3",
          "customContentName": "和風ドレッシング",
          "sortNo": 2
        },
        {
          "customContentId": "5",
          "customContentName": "フレンチドレッシング",
          "sortNo": 3
        }
      ]
    },
    "isOpenPrice": false,
    "createdIn": "waiter",
    "prices": [
      {
        "taxRate": 10,
        "taxType": "normal",
        "amount": "690",
        "tax": "include",
        "primary": true
      }
    ]
  },
  {
    "id": "2",
    "name": "スープ",
    "kana": "スープ",
    "type": "normal",
    "categoryId": "3",
    "note": "",
    "sortNo": 2,
    "applyDatetime": null,
    "customId": null,
    "customOrder": null,
    "isOpenPrice": false,
    "createdIn": "waiter",
    "prices": [
      {
        "taxRate": 10,
        "taxType": "normal",
        "amount": "490",
        "tax": "include",
        "primary": true
      }
    ]
  }
]

Headers

Link

string

<前のURI>; rel="prev", <次のURI>; rel="next"

400

Bad Request

リクエストパラメーターが不正
- 不正な値が指定された場合

object

title

required

string

type

required

string

status

integer

detail

string