客層一覧取得

GET

/customer_groups

• サンドボックス
• 本番

客層情報一覧を取得します。

対象プラン

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

Authorizations

• AppAccessToken
  pos.transactions:read
• UserAccessToken
  pos.transactions:read

Parameters

Query Parameters

fields

array

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

sort

string

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

指定可能なパラメータ

• customerGroupId：客層ID
• customerGroupSectionId：客層セクションID
• displaySequence：表示順

limit

integer

上限数

page

integer

ページ

customer_group_section_id

string

客層セクションID

display_flag

string

Allowed values: 0 1

表示フラグ：端末で表示するか判定 (0：表示しない、1：表示する)

Responses

200

取得成功

Array<object>

object

customerGroupId

客層ID

string

customerGroupSectionId

客層セクションID

string

label

ラベル

string

displayFlag

表示フラグ：端末で表示するか判定 (0：表示しない、1：表示する)

string

Allowed values: 0 1

displaySequence

表示順

string

insDateTime

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

string

updDateTime

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

string

Example

[
  {
    "customerGroupId": "string",
    "customerGroupSectionId": "string",
    "label": "string",
    "displayFlag": "0",
    "displaySequence": "string",
    "insDateTime": "string",
    "updDateTime": "string"
  }
]