カテゴリー取得

GET

/categories/{category_id}

curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/waiter/categories/example?with_children=none' \
  --header 'Authorization: Bearer <token>'

• サンドボックス
• 本番

カテゴリー情報を取得します

Authorizations

• AppAccessToken
  waiter.menus:read

Parameters

Path Parameters

category_id

required

string

カテゴリーID

Query Parameters

with_children

string

default: none

Allowed values: all none

子カテゴリー情報を含むかを指定します。

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

Example

none

Responses

200

OK

Media typeapplication/json

CategoryParent

object

id

required

カテゴリーID

string

name

カテゴリー名

string

abbr

略称

string

sortNo

ソート番号

integer

parentId

親カテゴリーID

string

nullable

createdIn

作成元サービス

string

nullable

Allowed values: waiter pos headquarters

children

子カテゴリーリスト

Array<object>

CategoryChild

カテゴリー情報

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",
  "children": [
    {
      "id": "12",
      "name": "季節の彩ケーキ特集",
      "abbr": "季節ケーキ",
      "sortNo": 2,
      "parentId": "2",
      "createdIn": "waiter"
    }
  ]
}

{
  "id": "2",
  "name": "デザート",
  "abbr": "デザート",
  "sortNo": 1,
  "parentId": null,
  "createdIn": "waiter"
}

400

Bad Request

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

Media typeapplication/json

object

title

required

string

type

required

string

status

integer

detail

string

Example^generated

{
  "title": "example",
  "type": "example",
  "status": 1,
  "detail": "example"
}

404

指定したデータが存在しない場合

Media typeapplication/json

object

title

required

string

type

required

string

status

integer

detail

string

Example^generated

{
  "title": "example",
  "type": "example",
  "status": 1,
  "detail": "example"
}