コンテンツにスキップ
スマレジ・プラットフォームAPI リファレンス
検索
Ctrl
K
キャンセル
テーマの選択
ダーク
ライト
自動
スタートガイド
はじめに
アクセストークンの取得
よくある質問
スマレジAPIとスマレジプラットフォームAPIの違い
スマレジ・プラットフォームAPI 共通仕様
API 仕様書
POS 仕様書
Overview
部門
部門一覧取得
GET
部門登録
POST
部門取得
GET
部門削除
DELETE
部門更新
PATCH
部門グループ
部門グループ一覧取得
GET
部門グループ登録
POST
部門グループ削除
DELETE
部門グループ更新
PATCH
商品
商品一覧取得
GET
商品登録
POST
商品一括登録
POST
商品一括更新
PATCH
商品取得
GET
商品削除
DELETE
商品更新
PATCH
商品価格一覧取得
GET
店舗商品価格一覧取得
GET
商品価格削除
DELETE
商品価格変更履歴一覧取得
GET
商品自由項目一覧取得
GET
商品自由項目削除
DELETE
商品属性一覧取得
GET
商品属性更新
PUT
商品属性削除
DELETE
商品属性項目一覧取得
GET
商品属性項目登録
POST
商品属性項目削除
DELETE
商品属性項目更新
PATCH
商品取扱店舗一覧取得
GET
店舗取扱商品一覧取得
GET
在庫引当商品一覧取得
GET
在庫引当商品削除
DELETE
商品自由項目ラベル一覧取得
GET
商品自由項目ラベル更新
PUT
商品自由項目ラベル削除
DELETE
商品画像一覧取得
GET
商品画像登録
PUT
商品画像削除
DELETE
商品アイコン画像登録
PUT
商品アイコン画像削除
DELETE
セール
セール一覧取得
GET
セール登録
POST
セール削除
DELETE
セール更新
PATCH
セール店舗一覧取得
GET
セール店舗登録
POST
セール店舗削除
DELETE
セール店舗更新
PATCH
セール商品一覧取得
GET
セール商品登録
POST
セール商品削除
DELETE
セール商品更新
PATCH
オプショングループ
オプショングループ一覧取得
GET
オプショングループ登録
POST
オプショングループ取得
GET
オプショングループ削除
DELETE
オプショングループ更新
PATCH
オプショングループ商品削除
DELETE
バンドル販売
バンドル販売一覧取得
GET
バンドル販売登録
POST
バンドル販売取得
GET
バンドル販売削除
DELETE
バンドル販売更新
PATCH
バンドル販売商品削除
DELETE
会員
会員一覧取得
GET
会員登録
POST
会員一括登録
POST
会員一括更新
PATCH
会員取得
GET
会員削除
DELETE
会員更新
PATCH
会員ポイント一覧取得
GET
会員ポイント更新
PATCH
会員ポイント相対値更新
POST
会員ポイント一括更新
PATCH
会員ポイント一括相対値更新
POST
会員必須項目設定取得
GET
会員ランク
会員ランク一覧取得
GET
会員ランク登録
POST
会員ランク削除
DELETE
会員ランク更新
PATCH
社員ランク
社員ランク一覧取得
GET
社員ランク登録
POST
社員ランク削除
DELETE
社員ランク更新
PATCH
在庫
在庫一覧取得
GET
在庫更新
PATCH
在庫相対値更新
POST
在庫一括更新
PATCH
在庫一括相対値更新
POST
在庫変動履歴取得
GET
取引
取引一覧取得
GET
取引登録
POST
取引取得
GET
取引更新
PATCH
取引取消
POST
取引返品取消
POST
取引会員更新
PATCH
取引明細一覧CSV作成
POST
取引明細取得
GET
取置き一覧取得
GET
取置き登録
POST
取置き取得
GET
取置き返品取消
POST
仮販売一覧取得
GET
仮販売登録
POST
仮販売取得
GET
仮販売削除
DELETE
仮販売状態変更
PATCH
回数券購入取引一覧取得
GET
回数券購入取引取得
GET
回数券使用
POST
予算
月別予算一覧取得
GET
日別予算取得
GET
日別予算登録
POST
日別予算削除
DELETE
日別予算更新
PATCH
スタッフ別予算一覧取得
GET
スタッフ別予算登録
POST
スタッフ別予算削除
DELETE
スタッフ別予算更新
PATCH
客層
客層セクション一覧取得
GET
客層セクション更新
PUT
客層一覧取得
GET
客層登録
POST
客層削除
DELETE
客層更新
PATCH
仕入先
仕入先一覧取得
GET
仕入先登録
POST
仕入先削除
DELETE
仕入先更新
PATCH
仕入先商品一覧取得
GET
仕入先商品登録
POST
仕入先商品削除
DELETE
仕入先区分
仕入先区分一覧取得
GET
仕入先区分登録
POST
仕入先区分削除
DELETE
仕入先区分更新
PATCH
店舗
店舗一覧取得
GET
店舗登録
POST
店舗取得
GET
店舗削除
DELETE
店舗更新
PATCH
店舗分類項目関連取得
GET
店舗分類項目関連削除
DELETE
商品発注点一覧取得
GET
商品発注点設定
POST
店舗分類
店舗分類一覧取得
GET
店舗分類登録
POST
店舗分類削除
DELETE
店舗分類更新
PATCH
店舗分類項目一覧取得
GET
店舗分類項目登録
POST
店舗分類項目削除
DELETE
店舗分類項目更新
PATCH
レジ端末
レジ端末一覧取得
GET
レジ端末登録
POST
レジ端末削除
DELETE
レジ端末更新
PATCH
レジ端末印刷
POST
レジ端末通知
POST
スタッフ
スタッフ一覧取得
GET
スタッフ取得
GET
役割・役職
役割・役職一覧取得
GET
役割・役職登録
POST
役割・役職取得
GET
役割・役職削除
DELETE
役割・役職更新
PATCH
精算
精算一覧取得
GET
精算実行
POST
日次締め情報
日次締め情報一覧取得
GET
日次締め実行
POST
消費税率
消費税率一覧取得
GET
軽減税率
軽減税率一覧取得
GET
但し書き（領収証）
但し書き（領収証）一覧取得
GET
支払方法
支払方法一覧取得
GET
支払方法登録
POST
支払方法取得
GET
支払方法削除
DELETE
支払方法更新
PATCH
店舗取扱支払方法一覧取得
GET
支払方法分類
支払方法分類一覧取得
GET
支払方法分類登録
POST
支払方法分類削除
DELETE
支払方法分類更新
PATCH
個別アプリ専用支払方法
個別アプリ専用支払方法一覧取得
GET
個別アプリ専用支払方法登録
POST
個別アプリ専用支払方法削除
DELETE
値引／割引区分
値引／割引区分一覧取得
GET
クーポン
クーポン一覧取得
GET
クーポン登録
POST
クーポン取得
GET
クーポン削除
DELETE
クーポン更新
PATCH
クーポン商品登録
POST
クーポン商品削除
DELETE
クーポン商品更新
PATCH
CAT/CCTカード会社
CAT/CCTカード会社一覧取得
GET
Webhook
部門
POST
部門グループ
POST
商品
POST
商品画像
POST
セール
POST
オプショングループ
POST
オプショングループ商品
POST
バンドル販売
POST
バンドル販売商品
POST
仕入先
POST
仕入先商品
POST
仕入先区分
POST
店舗
POST
レジ端末
POST
スタッフ
POST
役割・役職
POST
日別予算
POST
会員
POST
会員ポイント
POST
会員ランク
POST
社員ランク
POST
取引
POST
クーポン取引
POST
取置き
POST
仮販売
POST
精算処理
POST
締め処理
POST
客層
POST
在庫
POST
支払方法
POST
支払方法分類
POST
クーポン
POST
クーポン商品
POST
在庫管理 仕様書
Overview
ロス
ロス一覧取得
GET
ロス登録
POST
ロス取得
GET
ロス削除
DELETE
ロス更新
PATCH
ロス明細取得
GET
ロス区分一覧取得
GET
ロス区分登録
POST
ロス区分削除
DELETE
ロス区分更新
PATCH
発注
発注一覧取得
GET
発注登録
POST
発注取得
GET
発注削除
DELETE
発注更新
PATCH
発注対象商品取得
GET
発注対象店舗取得
GET
入荷
入荷一覧取得
GET
入荷登録
POST
入荷取得
GET
入荷更新
PATCH
入荷明細取得
GET
出荷
出荷一覧取得
GET
出荷登録
POST
出荷取得
GET
出荷削除
DELETE
出荷更新
PATCH
出荷明細取得
GET
入庫
入庫一覧取得
GET
入庫取得
GET
入庫更新
PATCH
入庫明細取得
GET
出庫
出庫一覧取得
GET
出庫登録
POST
出庫依頼登録
POST
出庫取得
GET
出庫削除
DELETE
出庫更新
PATCH
出庫承認
PATCH
出庫修正依頼
POST
修正依頼中出庫一覧取得
GET
修正依頼中出庫取得
GET
出庫修正依頼削除
DELETE
出庫修正依頼完了
POST
出庫明細取得
GET
棚卸
棚卸一覧取得
GET
棚卸対象部門取得
GET
棚卸対象商品取得
GET
棚卸在庫一覧取得
GET
Webhook
ロス
POST
ロス区分
POST
発注
POST
入荷
POST
出荷
POST
入庫
POST
出庫
POST
棚卸
POST
受注管理 仕様書
Overview
受注
受注登録
POST
受注登録（出荷済）
POST
受注取得
GET
受注キャンセル
PATCH
入金更新
PATCH
入金取消
PATCH
受注店舗
受注店舗登録
POST
受注店舗取得
GET
受注店舗削除
DELETE
在庫
在庫一覧取得
GET
Webhook
受注
POST
ウェイター 仕様書
Overview
店舗
店舗一覧取得
GET
店舗取得
GET
店舗のスタッフ一覧取得
GET
店舗のメニュー一覧取得
GET
店舗のメニュー取得
GET
店舗のトッピンググループ一覧取得
GET
店舗のトッピンググループ取得
GET
カテゴリー
カテゴリー一覧取得
GET
カテゴリー取得
GET
メニュー
メニュー一覧取得
GET
メニュー取得
GET
トッピング
トッピング一覧取得
GET
トッピング取得
GET
トッピンググループ
トッピンググループ一覧取得
GET
トッピンググループ取得
GET
お好みオーダー
お好みオーダー一覧取得
GET
お好みオーダー取得
GET
客層
客層一覧取得
GET
テーブル利用
Overview
テーブル利用履歴一覧取得
GET
チェックイン
POST
テーブル利用履歴取得
GET
注文
POST
注文キャンセル
PUT
キャンセル
PUT
チェックアウト
PUT
注文
注文取得
GET
注文明細更新
PATCH
営業状況
店舗の営業状況取得
GET
メニューの販売状態・残数一覧取得
GET
トッピングの販売状態・残数一覧取得
GET
スタッフ呼び出し
スタッフ呼び出し
POST
予約
Overview
予約一覧取得
GET
予約登録
POST
予約取得
GET
予約削除
DELETE
予約更新
PATCH
印刷
Overview
注文伝票印刷
POST
キッチン伝票印刷
POST
Webhook
メニュー
POST
トッピング
POST
お好みオーダー
POST
テーブル利用
POST
注文
POST
メニューの販売状態・残数
POST
トッピングの販売状態・残数
POST
予約
POST
タイムカード 仕様書
Overview
従業員
従業員一覧取得
GET
従業員基本情報登録
POST
従業員取得
GET
従業員基本情報更新
PATCH
従業員利用OFF可否一括事前判定
GET
従業員利用ON/OFF更新
PUT
従業員賃金設定登録
POST
従業員賃金設定更新
PUT
従業員賃金設定削除
DELETE
従業員所属事業所登録・更新
PUT
従業員所属事業所削除
DELETE
従業員所属グループ登録・更新
PUT
従業員所属グループ削除
DELETE
勤怠
勤怠実績一覧取得
GET
勤怠（事業所別）
日別勤怠（事業所別合計）取得
GET
月別勤怠（事業所別合計）取得
GET
時間別勤怠（事業所別合計）取得
GET
出勤中の従業員取得
GET
勤怠（従業員別）
日別勤怠（従業員別）取得
GET
月別勤怠（従業員別）取得
GET
勤怠登録
POST
勤怠更新
PUT
勤怠削除
DELETE
従業員事業所
従業員事業所取得
GET
事業所
事業所取得
GET
事業所一覧取得
GET
勤務パターン
勤務パターン一覧
GET
役割
役割一覧取得
GET
従業員グループ
従業員グループ取得
GET
役職
役職一覧取得
GET
打刻
出勤打刻
POST
退勤打刻
PUT
応援打刻
PUT
休憩開始
PUT
休憩終了
PUT
給与
月別給与一覧取得
GET
月別給与明細取得
GET
月別賞与一覧取得
GET
月別賞与明細取得
GET
給与確定
PUT
日報
日報一覧取得
GET
日報取得
GET
日報更新
PUT
日報登録
POST
日報削除
DELETE
日報タグ
日報タグ一覧取得
GET
日報タグ登録
POST
日報タグ更新
PUT
日報タグ削除
DELETE
日報タグ集計取得（従業員別）
GET
日報タグ集計取得（タグ別）
GET
日報タググループ一覧取得
GET
日報タグ区分一覧取得
GET
休暇
休暇設定一覧取得
GET
従業員休暇設定一覧取得
GET
従業員休暇履歴取得
GET
従業員休暇一覧取得
GET
従業員休暇登録
POST
従業員休暇更新
PUT
従業員休暇削除
DELETE
設定
基本設定取得
GET
従業員区分一覧取得
GET
従業員区分取得
GET
契約
契約情報取得
GET
テーマの選択
ダーク
ライト
自動
Overview
テーブル利用
Section titled “テーブル利用”
外部システム連携先にチェックイン・チェックアウト・キャンセルは連携されません