カテゴリー一覧取得

GET

/categories

• サンドボックス
• 本番

カテゴリー一覧を取得します

Authorizations

• AppAccessToken
  waiter.menus:read

Parameters

Query Parameters

level

string

default: none

Allowed values: 1 2 none

階層レベル

• none: 指定なし
• 1: 子カテゴリ以外
• 2: 子カテゴリ

Example

none

limit

integer

default: 20 >= 1 <= 100

取得件数

Example

20

sort

string

default: sort_no

ソート順

• sort_no: ソート番号
• id: カテゴリーID

Example

sort_no

page

integer

default: 1 >= 1

ページ番号

Example

1

Responses

200

OK

Array<object>

Category

カテゴリー情報

object

id

required

カテゴリーID

string

name

カテゴリー名

string

abbr

略称

string

sortNo

ソート番号

integer

parentId

親カテゴリーID

string

nullable

createdIn

作成元サービス

string

nullable

Allowed values: waiter pos headquarters

Examples

[
  {
    "id": "2",
    "name": "デザート",
    "abbr": "デザート",
    "sortNo": 1,
    "parentId": null,
    "createdIn": "waiter"
  },
  {
    "id": "3",
    "name": "ドリンク",
    "abbr": "ドリンク",
    "sortNo": 2,
    "parentId": null,
    "createdIn": "waiter"
  },
  {
    "id": "4",
    "name": "コールドドリンク",
    "abbr": "冷",
    "sortNo": 3,
    "parentId": "3",
    "createdIn": "waiter"
  },
  {
    "id": "5",
    "name": "ホットドリンク",
    "abbr": "温",
    "sortNo": 4,
    "parentId": "3",
    "createdIn": "waiter"
  },
  {
    "id": "12",
    "name": "季節の彩ケーキ特集",
    "abbr": "季節ケーキ",
    "sortNo": 5,
    "parentId": "2",
    "createdIn": "waiter"
  }
]

Headers

Link

string

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

400

Bad Request

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

object

title

required

string

type

required

string

status

integer

detail

string