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

トッピンググループ取得

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

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
topping_group_id
required
string

トッピンググループID

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
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
Exampleレスポンス例
{
  "id": "7",
  "name": "ハンバーグトッピング",
  "createdIn": "waiter",
  "rule": {
    "condition": "all",
    "max": 2,
    "min": 0
  }
}

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"
}