Overview
スマレジ・プラットフォームAPI 在庫管理 仕様書 (ver.1.0.0)
Section titled “スマレジ・プラットフォームAPI 在庫管理 仕様書 (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のページをご確認ください。
- OpenAPI version: 3.0.2