Information
- OpenAPI version:
3.0.2
Overview
スマレジ・プラットフォームAPI Waiter 仕様書 ver.1.0.0
Section titled “スマレジ・プラットフォームAPI Waiter 仕様書 ver.1.0.0”概要
エンドポイント
サンドボックス
https://api.smaregi.dev/{contract_id}/waiter本番
https://api.smaregi.jp/{contract_id}/waiter| Path Parameters | 説明 |
|---|---|
| contract_id | 対象の契約ID |
ソート
sortに「パラメータ名」で昇順、「パラメータ名:desc」で降順指定できます。
カンマ区切りで複数のパラメータ(昇順・降順)を指定できます。
ページネーション
一覧を取得するAPIでは1回で取得できる件数に上限があり、より多くの件数が必要となる場合はページまたはカーソルを指定する必要があります。
ページ
page に1から始まるページ番号を指定してください。
カーソル
cursor に取得する一覧の先頭にしたいデータの識別子を指定してください。
指定無し、または“-1“を指定して最初の一覧を取得できます。
存在しない識別子が指定された場合は結果が0件になります。
プラン
APIを利用するシステムのユーザーがご利用中のプランにより、実行できるAPIや使用できるパラメータの種類が異なります。 APIを利用可能なプランについては各APIの対象プランをご確認ください。 対象プランの記載のないAPIエンドポイントは、下記のすべてのプランでご利用いただけます。
プランの種類は以下の通りです。
- スタンダード
- フードビジネス
印刷
印刷の実行には利用店舗においてウェイターターミナルかサーバー印刷が利用可能な状態である必要があります。
ウェイターターミナルが利用可能な店舗では、ウェイターターミナルからの印刷が優先されます。
出力先プリンターの設定
出力先のプリンターは管理画面で設定可能です。
スマレジ・ウェイター ヘルプ：カテゴリーごとにレシートの出力先を設定する方法
印刷の指定
リクエストパラメータの orderPrints で伝票を印刷するかどうかを指定できます。
true: 印刷するfalse: 印刷しない
Authentication
Section titled “Authentication”AppAccessToken
Section titled “AppAccessToken”アプリアクセストークン
{contract_id} には対象の契約IDを指定してください。
Security scheme type: oauth2
Flow type: clientCredentials
Token URL: https://id.smaregi.dev/app/{contract_id}/token
Scopes:
- waiter.stores:read - 店舗の参照ができます
- waiter.stores:print - 店舗のプリンターから印刷ができます
- waiter.menus:read - カテゴリー/メニュー/トッピング/トッピンググループの参照ができます
- waiter.orders:read - 客層/テーブル利用履歴/注文の参照ができます
- waiter.orders:history - テーブル利用履歴一覧の参照ができます
- waiter.orders:write - テーブル利用の更新ができます
- waiter.staff-calls:write - スタッフ呼び出しが実行できます
- waiter.reservations:read - 予約の参照ができます
- waiter.reservations:write - 予約の更新ができます