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

概要


エンドポイント

サンドボックス

https://api.smaregi.dev/{契約ID}/pos

本番

https://api.smaregi.jp/{契約ID}/pos


ページネーション

一度に返すアイテム数は 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/{契約ID}/pos/products/?limit=10&page=1&sort=productCode:desc



Plan

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

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


Authentication

OAuth2

スマレジ・プラットフォームAPI POSで定義しているscope一覧です。

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: https://id.smaregi.dev/app/{contractId}/token
Refresh URL: https://id.smaregi.dev/app/{contractId}/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.staffs:read -

    スタッフの参照ができます。

  • pos.losses:read -

    ロスの参照ができます。

  • pos.orders:read -

    発注/入荷/出荷の参照ができます。

  • pos.transfers:read -

    店間移動(入出庫)の参照ができます。

  • pos.stocktaking:read -

    棚卸の参照ができます。

部門

部門一覧取得

部門情報一覧を取得します。

Plans:
スタンダード・プレミアム・プレミアムプラス・フードビジネス・リテールビジネス
sortで使用可能なパラメータ ■categoryId:部門ID
■categoryCode:部門コード
■level:階層レベル
■displaySequence:表示順
■updDateTime:更新日時