トッピング一覧取得

GET

/toppings

• サンドボックス
• 本番

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

Authorizations

• AppAccessToken
  waiter.menus:read

Parameters

Query Parameters

group_id

string

トッピンググループID

Example

1

category_id

string

カテゴリーID

Example

1

limit

integer

default: 20 >= 1 <= 100

取得件数

Example

20

sort

string

default: sort_no

ソート順

• sort_no: ソート番号
• id: トッピングID
• name: トッピング名

Example

sort_no

page

integer

default: 1 >= 1

ページ番号

Example

1

Responses

200

OK

Array

Topping

トッピング情報

object

id

required

トッピングID

string

name

トッピング名

string

kana

トッピング名（カナ）

string

categoryId

カテゴリーID

string

note

トッピング説明

string

sortNo

ソート番号

integer

applyDatetime

適用開始日時[YYYY-MM-DDThh:mm:ssTZD]

string

nullable

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": "101",
    "name": "胡麻",
    "kana": "ゴマ",
    "categoryId": "3",
    "note": "",
    "sortNo": 1,
    "applyDatetime": null,
    "isOpenPrice": false,
    "createdIn": "waiter",
    "prices": [
      {
        "taxRate": 10,
        "taxType": "normal",
        "amount": "30",
        "tax": "exclude",
        "primary": true
      }
    ]
  },
  {
    "id": "102",
    "name": "わさび",
    "kana": "ワサビ",
    "categoryId": "3",
    "note": "",
    "sortNo": 2,
    "applyDatetime": null,
    "isOpenPrice": false,
    "createdIn": "waiter",
    "prices": [
      {
        "taxRate": 10,
        "taxType": "normal",
        "amount": "70",
        "tax": "exclude",
        "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