futureshopオンラインマニュアル
運用サポート平日10:00～17:00
06-6485-6485

会員検索API

指定した会員情報の取得を行います。

まずはじめに、「概要」「共通仕様」について、futureshop APIv2についてをご覧ください。

基本仕様

  • 会員情報を最大100件まで一覧で取得できます。
  • futureshop omni-channelご利用店舗様でもご利用いただけます。（他の会員に関する登録・編集・削除APIはご利用いただけません。）

＜目次＞

更新/更新予定

※日付が「予定日」のものは、更新内容が変わる可能性がございます。

更新日/予定日 更新内容 更新理由
2024.01.24 レスポンス 以下を追加
listUnsubscribeLinkMail
listUnsubscribeLinkMobileMail		 Gmail メール送信者のガイドライン「ワンクリック登録解除」対応のため

------------------------------------------------------
【出力仕様修正】※2024.01.10追記
「出力形式」の修正　　「String」　→　「Text」 		参照

更新履歴はAPI更新履歴一覧をご覧ください。

URL

https://{APIドメイン}/admin-api/v1/member

HTTPメソッド

GET

リクエストヘッダー

アクセストークンなどの詳細はアクセストークンによる認証を参照してください。

リクエストボディ

なし

パラメータ

key 項目名 必須 内容
memberId 会員ID カンマ区切りで複数指定可能
createDateStart 登録日時(start) 「yyyy-mm-ddThh:mm:ss」形式
createDateEnd 登録日時(end) 「yyyy-mm-ddThh:mm:ss」形式
updateDateStart 最終更新日時(start) 「yyyy-mm-ddThh:mm:ss」形式
updateDateEnd 最終更新日時(end) 「yyyy-mm-ddThh:mm:ss」形式

レスポンス

※「文字数」について：ユーザー画面から入力される会員情報とデータをそろえるため、「byte」ではなく「文字数」としております。
※外部ID連携に関する情報は、2022.02現在検索できません。

key 項目名 必須 型 文字数（※） 内容
nextUrl ネクストURL String - 100件を超過する結果の場合、次のデータ取得のURLを返却（※）
memberList 会員リスト ◯ Array - 会員ごとに配列出力。最大100件
memberId 会員ID String 20
companyName 会社名 String 100
companyNameKana 会社名(フリガナ) String 100
departmentName 部署名 String 100
departmentNameKana 部署名(フリガナ) String 100
companyTelNo 会社電話番号 String 13 -(半角)区切り
companyFaxNo 会社ファックス番号 String 13 -(半角)区切り
lastName 姓 String 200
firstName 名 String 200
lastNameKana 姓(フリガナ) String 200
firstNameKana 名(フリガナ) String 200
mail Eメールアドレス String 200
mobileMail 携帯メールアドレス String 200
zipCode 郵便番号 String 7 3桁 -(半角) 4桁
prefecture 都道府県区分 String 9 ※prefecture出力内容
address1 住所１(市区町村) String 100
address2 住所２(番地) String 100
address3 住所３(建物名) String 100
telNoMain 電話番号 String 13 -(半角)区切り
telNoAlternate 昼間の連絡先番号 String 13 -(半角)区切り
faxNo ファックス番号 String 13 -(半角)区切り
gender 性別区分 String 11 UNSPECIFIED：指定なし
MALE：男性
FEMALE：女性
birthday 生年月日 String 10 「yyyy-mm-dd」形式
nickName ニックネーム String 50
newsletter メールマガジンの購読 String 3 YES：購読
NO：非購読
mobileNewsletter モバイルメルマガ受信可否 String 3 YES：可
NO：否
storeCode よく行くお店コード String 10 設定＞実店舗店舗＞（よく行くお店）一覧＞店舗設定-店舗コード／【CC未利用・移行中】構築＞実店舗設定＞新規登録・編集-店舗コード
※会員情報「よく行くお店」を登録時の「店舗コード」が出力されます。
directMail 郵便DM可否 String 3 YES：可
NO：否
remarks 備考 Text -
memberStageName 会員ステージ String 30
memberStageAutoConfig 会員ステージ自動更新 String 3 ON:有効
OFF:無効
additionalItem1 追加属性項目1 Text -
additionalItem2 追加属性項目2 Text -
additionalItem3 追加属性項目3 Text -
additionalItem4 追加属性項目4 Text -
additionalItem5 追加属性項目5 Text -
additionalItem6 追加属性項目6 Text -
additionalItem7 追加属性項目7 Text -
additionalItem8 追加属性項目8 Text -
additionalItem9 追加属性項目9 Text -
additionalItem10 追加属性項目10 Text -
additionalItem11 追加属性項目11 Text -
additionalItem12 追加属性項目12 Text -
additionalItem13 追加属性項目13 Text -
additionalItem14 追加属性項目14 Text -
additionalItem15 追加属性項目15 Text -
additionalItem16 追加属性項目16 Text -
additionalItem17 追加属性項目17 Text -
additionalItem18 追加属性項目18 Text -
additionalItem19 追加属性項目19 Text -
additionalItem20 追加属性項目20 Text -
registrationRoute 登録経路 String 6 PC：パソコン
MOBILE：モバイル
ADMIN：管理画面
SP：スマートフォン
API：API
dateRegistered 登録日時 String 19 「yyyy-mm-ddThh:mm:ss」形式
dateLastLogin 最終ログイン日時 String 19 「yyyy-mm-ddThh:mm:ss」形式
dateLastUpdated 最終更新日時 String 19 「yyyy-mm-ddThh:mm:ss」形式
listUnsubscribeLinkMail ListUnsubscribeLink（メイン） ◯ Text -

＜Gmail メール送信者のガイドライン「ワンクリック登録解除」用＞

「メールアドレス（メイン）」宛てにメールを送付する際に、出力内容をメールヘッダ（List-Unsubscribe）に記述してください。
クリックされると、「メルマガ受信可否：否（02）」となります。
listUnsubscribeLinkMobileMail ListUnsubscribeLink（モバイル） ◯ Text -

＜Gmail メール送信者のガイドライン「ワンクリック登録解除」用＞

「メールアドレス（モバイル）」宛てにメールを送付する際に、出力内容をメールヘッダ（List-Unsubscribe）に記述してください。
クリックされると、「モバイルメール受信可否：否（02）」となります。
nextUrlに関する補足

「/v1/member」の後に次のデータを取得するためのパラメータが付与されたURLが返却されます。
（例）「/admin-api/v1/member?createDateStart=2019-10-11T00:00:00&cursor=121」
URLに替えて、nextUrlをGETしていただければ、次の100件のデータを取得できます。

prefecture出力内容
出力 出力 出力 出力
HOKKAIDO 北海道 AOMORI 青森県 AKITA 秋田県 IWATE 岩手県
MIYAGI 宮城県 YAMAGATA 山形県 FUKUSHIMA 福島県 IBARAKI 茨城県
TOCHIGI 栃木県 GUNMA 群馬県 SAITAMA 埼玉県 CHIBA 千葉県
KANAGAWA 神奈川県 TOKYO 東京都 YAMANASHI 山梨県 NIIGATA 新潟県
NAGANO 長野県 SHIZUOKA 静岡県 AICHI 愛知県 MIE 三重県
GIFU 岐阜県 TOYAMA 富山県 ISHIKAWA 石川県 FUKUI 福井県
OSAKA 大阪府 KYOTO 京都府 SHIGA 滋賀県 NARA 奈良県
WAKAYAMA 和歌山県 HYOGO 兵庫県 OKAYAMA 岡山県 HIROSHIMA 広島県
YAMAGUCHI 山口県 TOTTORI 鳥取県 SHIMANE 島根県 KAGAWA 香川県
TOKUSHIMA 徳島県 EHIME 愛媛県 KOCHI 高知県 FUKUOKA 福岡県
SAGA 佐賀県 NAGASAKI 長崎県 KUMAMOTO 熊本県 OITA 大分県
MIYAZAKI 宮崎県 KAGOSHIMA 鹿児島県 OKINAWA 沖縄県 OTHER その他

エラーレスポンス

エラー発生時に以下のレスポンスが返却されます。

key 項目名 必須 型 byte 内容
status ステータス ○ String -
errors エラーリスト ○ Array -
code コード ○ String -
path パス ○ String - エラーが発生したパラメータ名が出力されます
message メッセージ ○ String -
エラーコード
コード メッセージ 説明
InvalidValue memberIdの指定が不正です 数値以外を指定した場合に返却されます。
TooLong memberIdは20文字以内で指定してください １会員の会員IDが20文字を超過した場合に返却されます。
InvalidDateFormat createDateStartの日付フォーマットを正しく指定してください 「yyyy-mm-ddThh:mm:ss」形式ではない場合に返却されます。
InvalidDateFormat createDateEndの日付フォーマットを正しく指定してください 「yyyy-mm-ddThh:mm:ss」形式ではない場合に返却されます。
InvalidDateRange createDateStartはcreateDateEndより前の日時を指定してください 会員登録日時の開始日時が終了日時よりも未来日付の場合に返却されます。
InvalidDateFormat updateDateStartの日付フォーマットを正しく指定してください 「yyyy-mm-ddThh:mm:ss」形式ではない場合に返却されます。
InvalidDateFormat updateDateEndの日付フォーマットを正しく指定してください 「yyyy-mm-ddThh:mm:ss」形式ではない場合に返却されます。
InvalidDateRange updateDateStartはupdateDateEndより前の日時を指定してください 会員更新日時の開始日時が終了日時よりも未来日付の場合に返却されます。

サンプル

{
    "status": "failed",
    "errors": [
        {
            "code": " InvalidDateFormat ",
            "path": " createDateStart ",
            "message": "typesの指定が不正です"
        }
    ]
}