開発者向けサポート

/members

必要権限

  • privacy

提供メソッド

GET

サンプル
リクエスト
GET members.json?select=MEMBER_ID,LOGINID,ZIP&query=[{"column":"DEL_DATE","operator":"is_null"}]
レスポンス
200 OK

[
	{"MEMBER_ID": 1,"ZIP": "1830052","LOGINID": "login1"},
	{"MEMBER_ID": 2,"ZIP": null,"LOGINID": "login2"}
]
リクエスト文説明
クエリーパラメータ

select
取得する列名を指定します。指定しない場合は MEMBER_ID,L_NAME,F_NAME,L_KANA,F_KANA,PC_MOBILE_KBN,REGIST_LANG,ZIP,ADDR1,ADDR2,ADDR3,SEX,BIRTH,TEL,LOGINID,PC_MAIL,MOBILE_MAIL,DEL_DATE,TAIKAI_DATE を指定した場合と同じ動作をします。
"count(*)"のみを指定した時は、会員のリストではなく、条件にマッチする件数を返します。このとき結果は次の形式になります。[{"count(*)": 件数数値}]
query
検索条件をJSON形式で指定します。詳細はデータアクセスAPIのページの共通パラメータを参照してください。
query_for_metadata
メタデータ用の検索条件をJSON形式で指定します。詳細はデータアクセスAPIのページの共通パラメータを参照してください。query等他の検索条件パラメータも同時に指定した場合、and条件での検索となります。
現在対応しているoperatorはequalsのみです。column_prefix、column_postfix、coalesce、operand、to_char_formatは未対応です。
result_count
検索結果の取得数を指定します。1～100で指定してください。未指定の場合、結果は20件分返します。
page
取得するページ番号 ((page-1)*resultCount)+1件目からpage*resultCount件目までのデータが取得対象となります。未指定の場合は1が指定されたものとして動作します。
login_id
指定したログインIDが一致する会員情報を検索します。
point_record_id
指定したポイント履歴IDに一致するポイント履歴情報を持つ会員情報を検索します。
sort_by
検索結果のソート方法として以下を指定できます。未指定の場合は会員IDの昇順となります。
name
姓（漢字）,名（漢字）で昇順にソートします。
search_group
GROUPBY句で指定するカラムを指定します。
query_type
request_bodyを指定することで、JSON形式で指定した検索条件データをBodyから受け取ります。

応答値説明
ボディー文字列

会員情報を格納したJSON値を返します。

POST

サンプル
リクエスト
POST members.json

{"PC_MOBILE_KBN":1,"L_NAME":"えびす","F_NAME":"まーと","metadata":{"KEY1":"VALUE1","KEY2":"VALUE2"}}
レスポンス
200 OK

{"result": 1}
リクエスト文説明
ボディー文字列

会員の情報を格納したJSON文字列、形式はGETと同一です。

data_type
未設定
会員の登録を行います。
update_by_query
条件を指定して会員情報を更新します。（会員ランク、自由項目のみ更新可能です）
check_password
ログインID、パスワードを指定し、ログインIDに対応する会員のパスワードとの照合を行います。
multi_update
複数の会員情報の更新を行う場合に指定します。一度に更新できる件数は1000件までになります。
update_member_tag
パラメータで指定した会員の会員自動タグを洗い替えします。
内部処理が別トランザクションになるためトランザクション処理中には利用できません。
自動タグ入替時にエラーが発生した場合、店舗管理者にエラーメールが送信されます。
should_hash_password
data_type未設定で会員登録を行う場合に有効です。trueを指定した場合、パスワードのハッシュ化を行います。
なお、パスワードの登録を行う際には弊社にて設定が必要です。
should_check_details
data_type未設定で会員登録を行う場合に有効です。trueを指定した場合、ログインIDの最小桁数チェックやメールアドレスの形式チェックのような画面からの登録同様の詳細チェックが行われます。
execute_member_api_flg
data_type未設定で会員登録を行う場合に有効です。trueを指定すると、会員登録外部API連携を行います。初期設定「会員データ連携OUT 接続先URL」に連携先URLが指定されている必要があります。is_return_member_resultにはtrueを指定してください。

応答値説明
ボディー文字列

is_return_member_id:trueの場合、登録した会員ID
is_return_member_result:trueの場合、登録結果を格納したオブジェクト
上記以外:登録件数