社員ランク一覧取得

GET

/staff_ranks

サンドボックス
本番

社員ランクの一覧を取得します。

※ 会員本部連携をご利用の場合、会員の社員ランクは使用できないため、本APIもご利用になれません。

対象プラン

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

Authorizations

AppAccessToken
pos.customers:read
UserAccessToken
pos.customers:read

Parameters

Query Parameters

fields

array

検索パラメータ（カンマ区切りで指定可）
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可

sort

string

並び順（カンマ区切りで指定可）

指定可能なパラメータ

staffRank：社員ランク。社員ランクを一意に識別する番号であり、管理画面における「コード」に該当します。
displaySequence：表示順。一覧表示時の並び順の優先順位です。
updDateTime：更新日時。登録時・更新時の日時

limit

integer

上限数

page

integer

ページ

staff_rank

string

社員ランク：社員ランクを一意に識別する番号であり、管理画面における「コード」に該当します。

display_flag

string

有効／無効：表示区分。（0:無効、1:有効）

Responses

200

取得成功

Array<object>

object

staffRank

社員ランク：社員ランクを一意に識別する番号であり、管理画面における「コード」に該当します。

string

staffRankFullName

名称：社員ランクの正式名称です。

string

staffRankDisplayName

表示名称：社員販売時に表示される名称です。未設定の場合は「名称」がそのまま表示されます。

string

displayFlag

有効／無効：表示区分。（0:無効、1:有効）

string

displaySequence

表示順：一覧表示時の並び順の優先順位です。

string

staffDiscountRate

社員販売割引率：社員販売を行う際に適用される割引率を入力します。

string

useProductStaffDiscountRateDivision

商品マスタ社員販売割引率利用区分：社員販売の割引率に商品マスタの社員販売割引率を適用するかを設定します。（0:利用しない、1:利用する）

string

staffApplicationSellingPriceDivision

社員販売適用価格区分：セール期間中の社員販売をする際、適用される価格を設定します。（0:セール価格と社員販売割引率を掛け合わせて適用、1:セール価格と社員販売価格を比較して安い方を適用、2:セール価格と社員販売価格を比較して高い方を適用）

string

insDateTime

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

string

updDateTime

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

string

Example

[
  {
    "staffRank": "string",
    "staffRankFullName": "string",
    "staffRankDisplayName": "string",
    "displayFlag": "string",
    "displaySequence": "string",
    "staffDiscountRate": "string",
    "useProductStaffDiscountRateDivision": "string",
    "staffApplicationSellingPriceDivision": "string",
    "insDateTime": "string",
    "updDateTime": "string"
  }
]

400

契約IDが会員本部連携が有効な契約のものである場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "会員本部連携が有効な契約では社員ランクはご利用できないため、本APIもご利用できません。",
  "status": 400
}