役割・役職登録

POST

/roles

サンドボックス
本番

役割・役職を登録します。

対象プラン

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

Authorizations

AppAccessToken
pos.staffs:write
UserAccessToken
pos.staffs:write

Request Body

object

roleName

required

役割名・役職名

役割名・役職名

string

<= 30 characters

note

説明

string

<= 255 characters

functionControls

機能制限

機能制限：POS機能における役割・役職に対する機能制限の一覧です。

※ 本フィールドが未指定、null、空配列の場合は、すべての機能の制限区分が「1：使用不可」に設定されます。

機能IDが指定されていない機能についても、制限区分は「1：使用不可」に設定されます。

商品管理機能の個別設定（ID：2001〜2012）とスタッフ管理機能の個別設定（ID：7001〜7003）が指定されていない場合は、

「2：商品管理機能」と「7：スタッフ管理機能」に設定された制限区分を上限として、その範囲内で可能な最大の制限区分が付与されます。

ただし、機能ID「7003：ログイン情報編集権限」は機能ID「7：スタッフ管理機能」の制限区分に「3：編集」が設定されている場合でも、「4：すべて」の制限区分が付与されます。

Array<object>

object

functionId

required

機能ID

機能ID：制限対象機能のIDです。

1:トップページ機能
2:商品管理機能 ※ 下記2000番台にある商品管理機能個別設定が存在する場合は、個別設定権限の方が優先して適用されます。
3:日次処理機能
4:取引履歴機能
5:売上分析機能（1:使用不可または 2:閲覧または 4:すべてのみ）
6:店舗管理機能
7:スタッフ管理機能 ※ 下記7000番台にあるスタッフ管理機能個別設定が存在する場合は、個別設定権限の方が優先して適用されます。
8:予算管理機能
9:会員管理機能
10:スマレジストア機能（1:使用不可または 4:すべてのみ）
11:値札発行機能（1:使用不可または 4:すべてのみ）（非推奨）※ 商品管理機能個別設定へ移行するため将来的に入力チェックでエラーとなる予定です。商品管理機能個別設定（2012:値札発行）の設定が存在する場合、個別設定権限の方が優先して適用されます。
12:各種設定機能
13:原価表示機能
14:一括削除機能
15:アプリ通知機能
16:PL管理機能
18:ポイント管理機能
19:売上分析機能 - 集計パターン保存・削除権限（1:使用不可または 4:すべてのみ）
20:レジ端末印刷機能（1:使用不可または 2:閲覧または 4:すべてのみ）
2001:商品管理機能 - 商品
2002:商品管理機能 - 部門
2003:商品管理機能 - 仕入先
2004:商品管理機能 - 在庫調整
2005:商品管理機能 - お気に入り商品（アイコン）（1:使用不可または 4:すべてのみ）
2006:商品管理機能 - 価格変更履歴（1:使用不可または 2:閲覧または 4:すべてのみ）
2007:商品管理機能 - セール
2008:商品管理機能 - オプショングループ
2009:商品管理機能 - バンドル販売
2010:商品管理機能 - 販売商品パターン
2011:商品管理機能 - 属性
2012:商品管理機能 - 値札発行（1:使用不可または 4:すべてのみ）
2013:商品管理機能 - CSV権限（1:使用不可または 4:すべてのみ）
2101:商品管理機能 - 商品CSV権限（1:使用不可または 4:すべてのみ）
2102:商品管理機能 - 部門CSV権限（1:使用不可または 4:すべてのみ）
2103:商品管理機能 - 仕入先CSV権限（1:使用不可または 4:すべてのみ）
2104:商品管理機能 - 在庫調整CSV権限（1:使用不可または 4:すべてのみ）
2106:商品管理機能 - 価格変更履歴CSV権限（1:使用不可または 4:すべてのみ）
2107:商品管理機能 - セールCSV権限（1:使用不可または 4:すべてのみ）
2111:商品管理機能 - 属性CSV権限（1:使用不可または 4:すべてのみ）
3001:日次処理機能 - CSV・PDF権限（1:使用不可または 4:すべてのみ）
4001:取引履歴機能 - CSV・PDF権限（1:使用不可または 4:すべてのみ）
5001:売上分析機能 - CSV権限（1:使用不可または 4:すべてのみ）
6001:店舗管理機能 - CSV権限（1:使用不可または 4:すべてのみ）
7001:スタッフ管理機能 - スタッフ
7002:スタッフ管理機能 - 役割・役職
7003:スタッフ管理機能 - ログイン情報編集権限（1:使用不可または 4:すべてのみ）
7004:スタッフ管理機能 - CSV権限（1:使用不可または 4:すべてのみ）
7101:スタッフ管理機能 - スタッフCSV権限（1:使用不可または 4:すべてのみ）
8001:予算管理機能 - CSV権限（1:使用不可または 4:すべてのみ）
9001:会員管理機能 - CSV権限（1:使用不可または 4:すべてのみ）
10001:スマレジストア機能 - CSV権限（1:使用不可または 4:すべてのみ）

string

Allowed values: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 18 19 20 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2101 2102 2103 2104 2106 2107 2111 3001 4001 5001 6001 7001 7002 7003 7004 7101 8001 9001 10001

controlDivision

required

制限区分

制限区分：対象機能に対する制限区分です。（1:使用不可、2:閲覧、3:編集、4:すべて）

string

Allowed values: 1 2 3 4

inventoryFunctionControls

在庫機能制限

対象プラン リテールビジネス

在庫機能制限：在庫機能における役割・役職に対する機能制限の一覧です。

※ 本フィールドが未指定、null、空配列の場合は、すべての機能の制限区分が「1：使用不可」に設定されます。

機能IDが指定されていない機能についても、制限区分は「1：使用不可」に設定されます。

Array<object>

object

functionId

required

機能ID

機能ID：制限対象機能のIDです。

1:発注管理機能
2:発注設定機能
3:入荷管理機能
4:出庫管理機能
5:入庫管理機能
6:棚卸機能
7:在庫分析機能
8:在庫高機能（1:使用不可または 2:閲覧のみ）
9:在庫一覧機能（1:使用不可または 2:閲覧または 4:すべてのみ）
10:ロス管理機能
11:出荷管理機能
12:棚卸完了権限（1:使用不可または 4:すべてのみ）
16:在庫一覧機能 - CSV・PDFダウンロード権限（1:使用不可または 4:すべてのみ）
17:ロス管理機能 - CSVダウンロード権限（1:使用不可または 4:すべてのみ）
18:発注管理機能 - CSV・PDFダウンロード権限（1:使用不可または 4:すべてのみ）
19:入荷管理機能 - CSV・PDFダウンロード権限（1:使用不可または 4:すべてのみ）
20:出荷管理機能 - CSV・PDFダウンロード権限（1:使用不可または 4:すべてのみ）
21:入庫管理機能 - CSV・PDFダウンロード権限（1:使用不可または 4:すべてのみ）
22:出庫管理機能 - CSV・PDFダウンロード権限（1:使用不可または 4:すべてのみ）
23:棚卸機能 - CSV・PDFダウンロード権限（1:使用不可または 4:すべてのみ）
24:在庫分析機能 - CSVダウンロード権限（1:使用不可または 4:すべてのみ）

string

Allowed values: 1 2 3 4 5 6 7 8 9 10 11 12 16 17 18 19 20 21 22 23 24

controlDivision

required

制限区分

制限区分：対象機能に対する制限区分です。（1:使用不可、2:閲覧、3:編集、4:すべて）

string

Allowed values: 1 2 3 4

alertFunctionControls

アラート機能制限

対象プラン リテールビジネス

アラート機能制限：在庫アラートにおける役割・役職に対する機能制限の一覧です。

※ 本フィールドが未指定、null、空配列の場合は、すべての機能の制限区分が「1：使用不可」に設定されます。

機能IDが指定されていない機能についても、制限区分は「1：使用不可」に設定されます。

Array<object>

object

alertType

required

アラート種別

アラート種別：制限対象アラートの種別です。（1:在庫切れ、2:発注点）

string

Allowed values: 1 2

controlDivision

required

制限区分

制限区分：対象機能に対する制限区分です。（0:使用不可、1:使用可）

string

Allowed values: 0 1

Example

{
  "roleName": "string",
  "note": "string",
  "functionControls": [
    {
      "functionId": "1",
      "controlDivision": "1"
    }
  ],
  "inventoryFunctionControls": [
    {
      "functionId": "1",
      "controlDivision": "1"
    }
  ],
  "alertFunctionControls": [
    {
      "alertType": "1",
      "controlDivision": "0"
    }
  ]
}

Responses

200

更新成功

object

roleId

役割・役職ID

string

roleName

役割名・役職名

string

note

説明

string

insDateTime

作成日時：登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

updDateTime

更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

functionControls

機能制限：POS機能における役割・役職に対する機能制限の一覧です。

Array<object>

object

functionId

機能ID：制限対象機能のIDです。

1:トップページ機能
2:商品管理機能 ※ 下記2000番台にある商品管理機能個別設定が存在する場合は、個別設定権限の方が優先して適用されます。
3:日次処理機能
4:取引履歴機能
5:売上分析機能（1:使用不可または 2:閲覧または 4:すべてのみ）
6:店舗管理機能
7:スタッフ管理機能 ※ 下記7000番台にあるスタッフ管理機能個別設定が存在する場合は、個別設定権限の方が優先して適用されます。
8:予算管理機能
9:会員管理機能
10:スマレジストア機能（1:使用不可または 4:すべてのみ）
11:値札発行機能（1:使用不可または 4:すべてのみ）（非推奨）※ 商品管理機能個別設定（2012:値札発行）の設定が存在する場合、個別設定権限の方が優先して適用されます。
12:各種設定機能
13:原価表示機能
14:一括削除機能
15:アプリ通知機能
16:PL管理機能
18:ポイント管理機能
19:売上分析機能 - 集計パターン保存・削除権限（1:使用不可または 4:すべてのみ）
20:レジ端末印刷機能（1:使用不可または 2:閲覧または 4:すべてのみ）
2001:商品管理機能 - 商品
2002:商品管理機能 - 部門
2003:商品管理機能 - 仕入先
2004:商品管理機能 - 在庫調整
2005:商品管理機能 - お気に入り商品（アイコン）（1:使用不可または 4:すべてのみ）
2006:商品管理機能 - 価格変更履歴（1:使用不可または 2:閲覧または 4:すべてのみ）
2007:商品管理機能 - セール
2008:商品管理機能 - オプショングループ
2009:商品管理機能 - バンドル販売
2010:商品管理機能 - 販売商品パターン
2011:商品管理機能 - 属性
2012:商品管理機能 - 値札発行（1:使用不可または 4:すべてのみ）
2013:商品管理機能 - CSV権限（1:使用不可または 4:すべてのみ）
2101:商品管理機能 - 商品CSV権限（1:使用不可または 4:すべてのみ）
2102:商品管理機能 - 部門CSV権限（1:使用不可または 4:すべてのみ）
2103:商品管理機能 - 仕入先CSV権限（1:使用不可または 4:すべてのみ）
2104:商品管理機能 - 在庫調整CSV権限（1:使用不可または 4:すべてのみ）
2106:商品管理機能 - 価格変更履歴CSV権限（1:使用不可または 4:すべてのみ）
2107:商品管理機能 - セールCSV権限（1:使用不可または 4:すべてのみ）
2111:商品管理機能 - 属性CSV権限（1:使用不可または 4:すべてのみ）
3001:日次処理機能 - CSV・PDF権限（1:使用不可または 4:すべてのみ）
4001:取引履歴機能 - CSV・PDF権限（1:使用不可または 4:すべてのみ）
5001:売上分析機能 - CSV権限（1:使用不可または 4:すべてのみ）
6001:店舗管理機能 - CSV権限（1:使用不可または 4:すべてのみ）
7001:スタッフ管理機能 - スタッフ
7002:スタッフ管理機能 - 役割・役職
7003:スタッフ管理機能 - ログイン情報編集権限（1:使用不可または 4:すべてのみ）
7004:スタッフ管理機能 - CSV権限（1:使用不可または 4:すべてのみ）
7101:スタッフ管理機能 - スタッフCSV権限（1:使用不可または 4:すべてのみ）
8001:予算管理機能 - CSV権限（1:使用不可または 4:すべてのみ）
9001:会員管理機能 - CSV権限（1:使用不可または 4:すべてのみ）
10001:スマレジストア機能 - CSV権限（1:使用不可または 4:すべてのみ）

string

controlDivision

制限区分：対象機能に対する制限区分です。（1:使用不可、2:閲覧、3:編集、4:すべて）

string

inventoryFunctionControls

対象プラン リテールビジネス

在庫機能制限：在庫機能における役割・役職に対する機能制限の一覧です。

Array<object>

object

functionId

機能ID：制限対象機能のIDです。

1:発注管理機能
2:発注設定機能
3:入荷管理機能
4:出庫管理機能
5:入庫管理機能
6:棚卸機能
7:在庫分析機能
8:在庫高機能（1:使用不可または 2:閲覧のみ）
9:在庫一覧機能（1:使用不可または 2:閲覧または 4:すべてのみ）
10:ロス管理機能
11:出荷管理機能
12:棚卸完了権限（1:使用不可または 4:すべてのみ）
16:在庫一覧機能 - CSV・PDFダウンロード権限（1:使用不可または 4:すべてのみ）
17:ロス管理機能 - CSVダウンロード権限（1:使用不可または 4:すべてのみ）
18:発注管理機能 - CSV・PDFダウンロード権限（1:使用不可または 4:すべてのみ）
19:入荷管理機能 - CSV・PDFダウンロード権限（1:使用不可または 4:すべてのみ）
20:出荷管理機能 - CSV・PDFダウンロード権限（1:使用不可または 4:すべてのみ）
21:入庫管理機能 - CSV・PDFダウンロード権限（1:使用不可または 4:すべてのみ）
22:出庫管理機能 - CSV・PDFダウンロード権限（1:使用不可または 4:すべてのみ）
23:棚卸機能 - CSV・PDFダウンロード権限（1:使用不可または 4:すべてのみ）
24:在庫分析機能 - CSVダウンロード権限（1:使用不可または 4:すべてのみ）

string

controlDivision

制限区分：対象機能に対する制限区分です。（1:使用不可、2:閲覧、3:編集、4:すべて）

string

alertFunctionControls

対象プラン リテールビジネス

アラート機能制限：在庫アラートにおける役割・役職に対する機能制限の一覧です。

Array<object>

object

alertType

アラート種別：制限対象アラートの種別です。（1:在庫切れ、2:発注点）

string

controlDivision

制限区分：対象機能に対する制限区分です。（0:使用不可、1:使用可）

string

Example

{
  "roleId": "string",
  "roleName": "string",
  "note": "string",
  "insDateTime": "string",
  "updDateTime": "string",
  "functionControls": [
    {
      "functionId": "string",
      "controlDivision": "string"
    }
  ],
  "inventoryFunctionControls": [
    {
      "functionId": "string",
      "controlDivision": "string"
    }
  ],
  "alertFunctionControls": [
    {
      "alertType": "string",
      "controlDivision": "string"
    }
  ]
}

400

機能IDが機能制限内で重複した場合
機能IDが在庫機能制限内で重複した場合
アラート種別がアラート機能制限内で重複した場合
機能制限に対して設定できない制限区分が設定されている場合
在庫機能制限に対して設定できない制限区分が設定されている場合
在庫機能制限の機能ID 2:発注設定機能に制限区分 3:編集か 4:すべてのいずれも設定されておらず、かつアラート機能設定にて制限区分に 1:使用可が指定された機能が存在する場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "同一の機能IDが複数の機能制限に対して設定されています。(機能ID-{機能ID})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "同一の機能IDが複数の在庫機能制限に対して設定されています。(機能ID-{機能ID})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "同一のアラート種別が複数のアラート機能制限に対して設定されています。(アラート種別-{アラート種別})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定された制限区分はこの機能に対しては設定できません。(機能ID-{機能ID}, 制限区分-{制限区分})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定された制限区分はこの在庫機能に対しては設定できません。(機能ID-{機能ID}, 制限区分-{制限区分})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "在庫機能制限において 2:発注設定機能 が 3:編集 以上の制限区分の役割・役職に対してのみ、アラート機能制限の各機能の制限区分に 1:使用可 が設定できます。",
  "status": 400
}