コンテンツにスキップ
スマレジ・プラットフォームAPI リファレンス

トッピング取得

GET
/toppings/{topping_id}
curl --request GET \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/waiter/toppings/example \
  --header 'Authorization: Bearer <token>'

トッピング情報を取得します

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
topping_id
required
string

トッピングID

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
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
Exampleレスポンス例
{
  "id": "12",
  "name": "チーズ",
  "kana": "チーズ",
  "categoryId": "5",
  "note": "",
  "sortNo": 1,
  "applyDatetime": "2020-07-01T10:00:00+09:00",
  "isOpenPrice": false,
  "createdIn": "waiter",
  "prices": [
    {
      "taxRate": 10,
      "taxType": "normal",
      "amount": "50",
      "tax": "exclude",
      "primary": true
    }
  ]
}

404

Section titled “404”

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

Media typeapplication/json
object
title
required
string
type
required
string
status
integer
detail
string
Examplegenerated
{
  "title": "example",
  "type": "example",
  "status": 1,
  "detail": "example"
}