Overview

スマレジ・プラットフォームAPI POS仕様書 ver.1.0.0

概要

エンドポイント

サンドボックス

https://api.smaregi.dev/{contract_id}/pos

本番

https://api.smaregi.jp/{contract_id}/pos

Path Parameters	説明
contract_id	対象の契約ID

ページネーション

一度に返すアイテム数は limitパラメータで指定でき、上限は1000個です。
取得する対象ページは page で指定できます( 1 始まり)。
並び順はsortパラメータで指定可能です。

QUERY PARAMETER	型	値の範囲	初期値
limit	integer	1 〜 1000	100
page	integer	1 〜	1
sort	string	`パラメータ名指定` カンマ区切り複数指定可、`並び替え順指定`「パラメータ名:desc」での指定が可能	（各APIで主キーとなるID）:asc

リクエスト例）商品一覧、10件ずつ表示の1ページ目、並び順がproductCodeの降順の場合

https://api.smaregi.dev/{contract_id}/pos/products/?limit=10&page=1&sort=productCode:desc

対象プラン

APIを利用するシステムのユーザーがご利用中のプランにより、実行できるAPIや、取得・登録・更新できるパラメータの種類が異なります。
APIを利用可能なプランについては各APIのページをご確認ください。
プランの種類は以下の通りです。

スタンダード
プレミアム
プレミアムプラス
フードビジネス
リテールビジネス

ユーザー権限

ユーザー権限による実行制御は「役割・役職による制御」、「所属店舗による制御」の2種類があります。

役割・役職による制御

ユーザーがスタッフとして属している役割・役職によりAPIの実行を制御します。
また、各APIの項目に「UserAccessToken」と記載があるものはスコープに対応する機能による制御も行います。
例）
役割・役職の取引履歴機能が「閲覧」の場合、取引取得APIは実行可能、取引登録APIはエラーになります。

スタッフの役割・役職は管理画面で設定可能です。
役割・役職の各機能の権限は管理画面、APIで設定可能です。
スマレジ・ヘルプ：スタッフの権限を設定する（役割・役職）

所属店舗による制御

ユーザーがスタッフとして所属している店舗の情報のみ取得・登録・更新・削除が可能です。
制御の詳細は各APIのページをご確認ください。

Information

OpenAPI version: 3.0.2

Authentication

AppAccessToken

アプリアクセストークン。

Security scheme type: oauth2

Flow type: clientCredentials

Token URL: https://id.smaregi.dev/app/{contract_id}/token

Scopes:

pos.products:read - 商品/部門の参照ができます。
pos.products:write - 商品/部門の更新ができます。
pos.customers:read - 会員/ポイントの参照ができます。
pos.customers:write - 会員/ポイントの更新ができます。
pos.stock:read - 在庫の参照ができます。
pos.stock:write - 在庫の更新ができます。
pos.stock-changes:read - 在庫変動履歴の参照ができます。
pos.transactions:read - 取引/予算/精算/日次締め情報の参照ができます。
pos.transactions:write - 取引/予算/精算/日次締め情報の更新ができます。
pos.suppliers:read - 仕入先の参照ができます。
pos.suppliers:write - 仕入先の更新ができます。
pos.stores:read - 店舗の参照ができます。
pos.stores:write - 店舗の更新ができます。
pos.terminals:print - レジ端末のプリンターから印刷ができます。
pos.terminals:notify - レジ端末へのメッセージ通知ができます。
pos.staffs:read - スタッフの参照ができます。
pos.staffs:write - スタッフの更新ができます。
pos.losses:read - ロスの参照ができます。
pos.losses:write - ロスの更新ができます。
pos.orders:read - 発注/入荷/出荷の参照ができます。
pos.orders:write - 発注/入荷/出荷の更新ができます。
pos.transfers:read - 店間移動(入出庫)の参照ができます。
pos.transfers:write - 店間移動(入出庫)の更新ができます。
pos.stocktaking:read - 棚卸の参照ができます。

UserAccessToken

ユーザーアクセストークン。
管理画面における制御と同等の、ユーザー（＝スタッフ）の所属店舗による制御や、属する役割・役職に設定された各種権限に基づく実行制御が適用されます。