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

トッピングの販売状態・残数一覧取得

GET
/topping_conditions/stores/{store_id}
curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/waiter/topping_conditions/stores/1?topping_ids=11%2C12%2C13&category_id=1&updated_from=2023-10-01T00%3A00%3A00%2B09%3A00&limit=20&sort=topping_id&page=1' \
  --header 'Authorization: Bearer <token>'

店舗で取り扱うトッピングの販売状態・残数一覧を取得します。

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
store_id
required
string

店舗ID

Example
1

Query Parameters

Section titled “Query Parameters”
topping_ids
Array<string>
<= 100 items

トッピングID
カンマ区切りで複数のパラメータを指定できます。

Example
?topping_ids=11,12,13
category_id
string

カテゴリーID

Example
1
updated_from
string format: date-time

更新日時(RFC3339の日付形式)[YYYY-MM-DDThh:mm:ssTZD]
指定日時以降に販売状態・残数が更新されたトッピングを取得します。

Example
2023-10-01T00:00:00+09:00
limit
integer
default: 20 >= 1 <= 100

取得件数

Example
20
sort
string
default: topping_id

ソート順

  • topping_id: トッピングID
  • category_id: カテゴリーID
Example
topping_id
page
integer
default: 1 >= 1

ページ番号

Example
1

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
Array
ToppingCondition
object
toppingId

トッピングID

string
condition

販売状態

  • orderable: 販売可
  • soldout: 売切
string
Allowed values: orderable soldout
quantity

残数

integer
nullable
Examples
Exampleレスポンス例
[
  {
    "toppingId": "1",
    "condition": "orderable",
    "quantity": 3
  },
  {
    "toppingId": "2",
    "condition": "orderable",
    "quantity": null
  },
  {
    "toppingId": "3",
    "condition": "soldout",
    "quantity": 0
  },
  {
    "toppingId": "4",
    "condition": "soldout",
    "quantity": 2
  }
]

Headers

Section titled “Headers”
Link
string

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

403

Section titled “403”

店舗が休止中の場合

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

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