会員ランク一覧取得

GET

/customer_ranks

• サンドボックス
• 本番

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

対象プラン

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

Authorizations

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

Parameters

Query Parameters

fields

array

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

sort

string

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

指定可能なパラメータ

• rank：会員ランク
• displaySequence：表示順

limit

integer

上限数

page

integer

ページ

rank

string

会員ランク

display_flag

string

Allowed values: 0 1

有効／無効：端末で表示するかを設定。（0:無効、1:有効）

Responses

200

取得成功

Array<object>

object

rank

会員ランク

string

name

名称

string

pointGivingUnitPrice

ポイント付与単位：ポイントを付与する単位（金額）

string

pointGivingUnit

付与ポイント数：付与するポイント数

string

displaySequence

表示順

string

displayFlag

有効／無効：端末で表示するかを設定。（0:無効、1:有効）

string

insDateTime

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

string

updDateTime

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

string

Example

[
  {
    "rank": "string",
    "name": "string",
    "pointGivingUnitPrice": "string",
    "pointGivingUnit": "string",
    "displaySequence": "string",
    "displayFlag": "string",
    "insDateTime": "string",
    "updDateTime": "string"
  }
]