メニューの販売状態・残数一覧取得

GET

/menu_conditions/stores/{store_id}

• サンドボックス
• 本番

店舗で取り扱うメニューの販売状態・残数一覧を取得します。

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

Authorizations

• AppAccessToken
  waiter.stores:read waiter.menus:read

Parameters

Path Parameters

store_id

required

string

店舗ID

Example

1

Query Parameters

menu_ids

Array<string>

<= 100 items

メニューID
カンマ区切りで複数のパラメータを指定できます。

Example

?menu_ids=1,2,3

type

string

default: all

Allowed values: all normal plan course

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

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

Example

all

category_id

string

カテゴリーID

Example

1

updated_from

string format: date-time

更新日時(RFC3339の日付形式)[YYYY-MM-DDThh:mm:ssTZD]
指定日時以降に販売状態・残数が更新されたメニューを取得します。

Example

2023-10-01T00:00:00+09:00

limit

integer

default: 20 >= 1 <= 100

取得件数

Example

20

sort

string

default: menu_id

ソート順

• menu_id: メニューID
• category_id: カテゴリーID

Example

menu_id

page

integer

default: 1 >= 1

ページ番号

Example

1

Responses

200

OK

Array

MenuCondition

object

menuId

メニューID

string

condition

販売状態

• orderable: 販売可
• soldout: 売切

string

Allowed values: orderable soldout

quantity

残数

integer

nullable

Examples

[
  {
    "menuId": "1",
    "condition": "orderable",
    "quantity": 5
  },
  {
    "menuId": "2",
    "condition": "orderable",
    "quantity": 10
  },
  {
    "menuId": "3",
    "condition": "soldout",
    "quantity": 0
  }
]

Headers

Link

string

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

403

店舗が休止中の場合

object

title

required

string

type

required

string

status

integer

detail

string

404

指定した店舗が存在しない場合

object

title

required

string

type

required

string

status

integer

detail

string