会員必須項目設定取得

GET

/customer_required_column_setting

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/customer_required_column_setting?value=0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/customer_required_column_setting?value=0' \
  --header 'Authorization: Bearer <token>'

会員必須項目設定を取得します。

対象プラン

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

Authorizations

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

Parameters

Query Parameters

fields

array

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

sort

string

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

指定可能なパラメータ

displaySequence：表示順序

limit

integer

上限数

page

integer

ページ

column_name

string

カラム名

value

string

Allowed values: 0 1

設定値：会員登録・更新時に必須項目とするかどうかの設定値。 (0:任意、1:必須)

Responses

200

取得成功

application/json

Array<object>

object

columnName

カラム名

string

initialValue

初期値：会員登録・更新時に必須項目とするかどうかの初期値。 (0:任意、1:必須)

string

value

設定値：会員登録・更新時に必須項目とするかどうかの設定値。 (0:任意、1:必須)

string

displaySequence

表示順序

string

insDateTime

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

string

updDateTime

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

string

Example

[
  {
    "columnName": "string",
    "initialValue": "string",
    "value": "string",
    "displaySequence": "string",
    "insDateTime": "string",
    "updDateTime": "string"
  }
]