トッピンググループ一覧取得

GET

/topping_groups

• サンドボックス
• 本番

トッピンググループ一覧を取得します

Authorizations

• AppAccessToken
  waiter.menus:read

Parameters

Query Parameters

limit

integer

default: 20 >= 1 <= 100

取得件数

Example

20

sort

string

default: id

ソート順

• id: トッピンググループID
• name: トッピンググループ名

Example

id

page

integer

default: 1 >= 1

ページ番号

Example

1

Responses

200

OK

Array<object>

ToppingGroup

トッピンググループ

object

id

required

トッピンググループID

string

name

トッピンググループ名

string

createdIn

作成元サービス

string

nullable

Allowed values: waiter pos headquarters

rule

選択条件

• null:条件なし

object

condition

条件

• all: 全体
• category: カテゴリ毎

string

Allowed values: all category

max

上限

integer

>= 1 <= 999

min

下限

integer

<= 999

Examples

[
  {
    "id": "7",
    "name": "ハンバーグトッピング",
    "createdIn": "waiter",
    "rule": {
      "condition": "all",
      "max": 2,
      "min": 0
    }
  },
  {
    "id": "8",
    "name": "シチュートッピング",
    "createdIn": "waiter",
    "rule": null
  }
]

Headers

Link

string

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

400

Bad Request

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

object

title

required

string

type

required

string

status

integer

detail

string