会員登録API
指定した会員を登録します。
まずはじめに、「概要」「共通仕様」について、futureshop APIv2についてをご覧ください。
ご注意事項
- futureshop omni-channelご利用店舗様はご利用いただけません。
基本仕様
- 1会員ずつ会員情報を登録できます。パスワードも登録可能です。
futureshop管理画面への会員の流し込み、情報更新にご利用ください。
＜目次＞
更新/更新予定
※日付が「予定日」のものは、更新内容が変わる可能性がございます。
| 更新日/予定日 | 更新内容 | 更新理由 | ||
|---|---|---|---|---|
| 2024.01.24 | レスポンス | 以下を追加 listUnsubscribeLinkMail listUnsubscribeLinkMobileMail |
Gmail メール送信者のガイドライン「ワンクリック登録解除」対応のため ------------------------------------------------------ 【出力仕様修正】※2024.01.10追記 「出力形式」の修正 「String」 → 「Text」 |
参照 |
更新履歴はAPI更新履歴一覧をご覧ください。
URL
https://{APIドメイン}/admin-api/v1/member
HTTPメソッド
POST
リクエストヘッダー
アクセストークンなどの詳細はアクセストークンによる認証を参照してください。
リクエストボディ(json)
下表で「必須」となっている項目以外は、設定＞購入者・会員情報＞顧客登録項目一覧にて、「利用設定（会員登録）」を「必須にする」を設定であっても登録不要です（APIでは必須項目ではありません）。
API経由で登録されなかった顧客登録項目一覧上での 「必須」項目は、お客様（消費者）がはじめてマイページを表示する際に、追加入力を求められます。
なお、「任意にする」を設定している項目も同様に、APIでは登録の必要はありません（必須ではない）。
| key | 項目名 | 必須 | 型 | byte | 内容 |
|---|---|---|---|---|---|
| registrationPointsEnabled | 会員登録ポイント付与 | ◯ | String | 3 | YES：API登録時にポイント付与 NO：ポイントを付与しない ------------------------------------------------------ ※YESの場合 設定＞ポイント＞ポイント基本設定-会員登録時付与ポイント／【CC未利用・移行中】運用＞ポイント＞ポイント基本設定-会員登録時付与ポイントのルールに基づいて付与されます。会員登録時付与ポイントが「未登録」の場合は、付与ポイントなし（0ポイント）となります。設定変更後、キャッシュにより反映までに数分かかる場合があります。 |
| companyName | 会社名 | String | 100 | ||
| companyNameKana | 会社名(フリガナ) | String | 100 | ||
| departmentName | 部署名 | String | 100 | ||
| departmentNameKana | 部署名(フリガナ) | String | 100 | ||
| companyTelNo | 会社電話番号 | String | 13 | -(半角)区切り | |
| companyFaxNo | 会社FAX番号 | String | 13 | -(半角)区切り | |
| lastName | 氏名(姓) | String | 200 | ||
| firstName | 氏名(名) | String | 200 | ||
| lastNameKana | フリガナ(姓) | String | 200 | ||
| firstNameKana | フリガナ(姓) | String | 200 | ||
| メールアドレス | ◯ | String | 200 | ||
| password | パスワード | String | 30 | パスワードを指定しない場合、パスワードリマインダーでパスワードを設定となります。 | |
| mobileMail | メールアドレス(モバイル) | String | 200 | 設定可能なドメイン @docomo.ne.jp @ezweb.ne.jp @i.softbank.jp @disney.ne.jp @d.vodafone.ne.jp @h.vodafone.ne.jp @t.vodafone.ne.jp @c.vodafone.ne.jp @r.vodafone.ne.jp @k.vodafone.ne.jp @n.vodafone.ne.jp @s.vodafone.ne.jp @q.vodafone.ne.jp @softbank.ne.jp @au.com |
|
| zipCode | 郵便番号 | String | 7 | 3桁 -(半角) 4桁 | |
| prefecture | 都道府県区分 | String | 9 | ※prefecture登録内容 | |
| address1 | 住所1 | String | 100 | ||
| address2 | 住所2 | String | 100 | ||
| address3 | 住所3 | String | 100 | ||
| telNoMain | 電話番号(メイン) | String | 13 | -(半角)区切り | |
| telNoAlternate | 電話番号(サブ) | String | 13 | -(半角)区切り | |
| faxNo | FAX番号 | 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 | 追加属性項目01 | Text | - | ||
| additionalItem2 | 追加属性項目02 | Text | - | ||
| additionalItem3 | 追加属性項目03 | Text | - | ||
| additionalItem4 | 追加属性項目04 | Text | - | ||
| additionalItem5 | 追加属性項目05 | Text | - | ||
| additionalItem6 | 追加属性項目06 | Text | - | ||
| additionalItem7 | 追加属性項目07 | Text | - | ||
| additionalItem8 | 追加属性項目08 | Text | - | ||
| additionalItem9 | 追加属性項目09 | 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 | - |
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 | その他 |
サンプル（リクエストボディ）
{
"registrationPointsEnabled": "YES",
"companyName": "フューチャーショップ",
"companyNameKana": "フューチャーショップ",
"departmentName": "営業部",
"departmentNameKana": "エイギョウブ",
"companyTelNo": "090-1111-2222",
"companyFaxNo": "080-2222-3333",
"lastName": "大阪",
"firstName": "太郎",
"lastNameKana": "オオサカ",
"firstNameKana": "タロウ",
"mail": "test@future-shop.co.jp",
"mobileMail": "test@docomo.ne.jp",
"zipCode": "532-0003",
"prefecture": "OSAKA",
"address1": "大阪市淀川区宮原",
"address2": "111",
"address3": "222",
"telNoMain": "090-1111-2222",
"telNoAlternate": "090-2222-3333",
"faxNo": "06-1111-2222",
"gender": "UNSPECIFIED",
"birthday": "2000-10-07",
"nickName": "ニックネーム",
"newsletter": "YES",
"mobileNewsletter": "NO",
"storeCode": "test",
"directMail": "NO",
"remarks": "備考欄",
"memberStageName": "ブロンズ",
"memberStageAutoConfig": "ON",
"additionalItem1": "追加属性項目01",
"additionalItem2": "追加属性項目02",
"additionalItem3": "追加属性項目03",
"additionalItem4": "追加属性項目04",
"additionalItem5": "追加属性項目05",
"additionalItem6": "追加属性項目06",
"additionalItem7": "追加属性項目07",
"additionalItem8": "追加属性項目08",
"additionalItem9": "追加属性項目09",
"additionalItem10": "追加属性項目10",
"additionalItem11": "追加属性項目11",
"additionalItem12": "追加属性項目12",
"additionalItem13": "追加属性項目13",
"additionalItem14": "追加属性項目14",
"additionalItem15": "追加属性項目15",
"additionalItem16": "追加属性項目16",
"additionalItem17": "追加属性項目17",
"additionalItem18": "追加属性項目18",
"additionalItem19": "追加属性項目19",
"additionalItem20": "追加属性項目20"
}
レスポンス
※「文字数」について：ユーザー画面から入力される会員情報とデータをそろえるため、「byte」ではなく「文字数」としております。
| key | 項目名 | 必須 | 型 | 文字数（※） | 内容 | |
|---|---|---|---|---|---|---|
| status | ステータス | ○ | String | - | 成功：success 失敗：failed |
|
| memberId | 会員ID | String | 20 | 成功：successの場合に出力 | ||
| errors | エラーリスト | Array | - | リクエストのエラー発生時に出力 | ||
| code | コード | ○ | String | - | ||
| path | パス | String | - | 入力値エラーの場合、対象のjson位置を出力 | ||
| message | メッセージ | ○ | String | - | エラーの概要が出力されます。 | |
エラーコード
| コード | メッセージ | 説明 |
|---|---|---|
| WrongFormat | リクエストデータがjson形式ではありません | json形式ではない場合に返却されます。 |
| Required | registrationPointsEnabledを指定してください | registrationPointsEnabledのパラメータが設定されていない場合に返却されます。 |
| InvalidValue | registrationPointsEnabledの指定が不正です | “YES”、”NO”以外の指定をした場合に返却されます。 |
| InvalidLength | passwordは4文字以上、30文字以内で指定してください | passwordの指定が4文字以上、30文字以内ではない場合に返却されます。 |
| InvalidValue | passwordの指定が不正です | passwordの指定が半角英数字記号ではない場合に返却されます。 |
| TooLong | companyNameは100文字以内で指定してください | companyNameが100文字を超過した場合に返却されます。 |
| TooLong | companyNameKanaは100文字以内で指定してください | companyNameKanaが100文字を超過した場合に返却されます。 |
| InvalidValue | companyNameKanaの指定が不正です | 全角カナ・全角英字・半角英字・ハイフン・中点以外の文字が設定されていた場合に返却されます。 |
| TooLong | departmentNameは100文字以内で指定してください | departmentNameが100文字を超過した場合に返却されます。 |
| TooLong | departmentNameKanaは100文字以内で指定してください | departmentNameKanaが100文字を超過した場合に返却されます。 |
| InvalidValue | departmentNameKanaの指定が不正です | 全角カナ・全角英字・半角英字・ハイフン・中点以外の文字が設定されていた場合に返却されます。 |
| InvalidValue | companyTelNoの指定が不正です | 電話番号の整合性チェックでエラーとなった場合に返却されます。 |
| InvalidValue | companyFaxNoの指定が不正です | 電話番号の整合性チェックでエラーとなった場合に返却されます。 |
| TooLong | lastNameは200文字以内で指定してください | lastNameが200文字を超過した場合に返却されます。 |
| TooLong | firstNameは200文字以内で指定してください | firstNameが200文字を超過した場合に返却されます。 |
| TooLong | lastNameKanaは200文字以内で指定してください | lastNameKanaが200文字を超過した場合に返却されます。 |
| InvalidValue | lastNameKanaの指定が不正です | 全角カナ・全角英字・半角英字・ハイフン・中点以外の文字が設定されていた場合に返却されます。 |
| TooLong | firstNameKanaは200文字以内で指定してください | firstNameKanaが200文字を超過した場合に返却されます。 |
| InvalidValue | lastNameKanaの指定が不正です | 全角カナ・全角英字・半角英字・ハイフン・中点以外の文字が設定されていた場合に返却されます。 |
| Required | mailを指定してください | mailのパラメータが設定されていない場合に返却されます。 |
| InvalidValue | mailの指定が不正です | メールアドレスの整合性チェックでエラーとなった場合に返却されます。 |
| InvalidValue | mobileMailの指定が不正です | メールアドレスの整合性チェックでエラーとなった場合に返却されます。 |
| InvalidDomain | mobileMailのドメインが不正です | 以下のドメイン以外を指定した場合に返却されます。 @docomo.ne.jp @ezweb.ne.jp @i.softbank.jp @disney.ne.jp @d.vodafone.ne.jp @h.vodafone.ne.jp @t.vodafone.ne.jp @c.vodafone.ne.jp @r.vodafone.ne.jp @k.vodafone.ne.jp @n.vodafone.ne.jp @s.vodafone.ne.jp @q.vodafone.ne.jp @softbank.ne.jp @au.com |
| DuplicateMail | mailとmobileMailに同じ内容は指定できません | mailとmobileMailを同じ値を指定した場合に返却されます。 |
| InvalidValue | zipCodeの指定が不正です | 3桁 -(半角) 4桁以外の指定をした場合に返却されます。 |
| InvalidValue | prefectureの指定が不正です | ※prefecture登録内容の都道府県コード以外を指定した場合に返却されます。 |
| TooLong | address1は100文字以内で指定してください | address1が100文字を超過した場合に返却されます。 |
| TooLong | address2は100文字以内で指定してください | address2が100文字を超過した場合に返却されます。 |
| TooLong | address3は100文字以内で指定してください | address3が100文字を超過した場合に返却されます。 |
| InvalidValue | telNoMainの指定が不正です | 電話番号の整合性チェックでエラーとなった場合に返却されます。 |
| InvalidValue | telNoAlternateの指定が不正です | 電話番号の整合性チェックでエラーとなった場合に返却されます。 |
| InvalidValue | faxNoの指定が不正です | 電話番号の整合性チェックでエラーとなった場合に返却されます。 |
| InvalidValue | genderの指定が不正です | 以下の性別コード以外を指定した場合に返却されます。 UNSPECIFIED MALE FEMALE |
| InvalidDateFormat | birthdayの日付フォーマットを正しく指定してください | 「yyyy-mm-dd」形式ではない場合、または存在しない日付の場合に返却されます。 |
| TooLong | nickNameは50文字以内で指定してください | nickNameが50文字を超過した場合に返却されます。 |
| InvalidValue | newsletterの指定が不正です | “YES”、”NO”以外の指定をした場合に返却されます。 |
| InvalidValue | mobileNewsletterの指定が不正です | “YES”、”NO”以外の指定をした場合に返却されます。 |
| InvalidValue | directMailの指定が不正です | “YES”、”NO”以外の指定をした場合に返却されます。 |
| TooLong | remarksは16,000文字以内で指定してください | remarksが16,000文字を超過した場合に返却されます。 |
| InvalidValue | memberStageAutoConfigの指定が不正です | “ON”、”OFF”以外の指定をした場合に返却されます。 |
| MailAlreadyRegistered | mailが重複しています | 指定したmailが他の会員が使用している場合に返却されます。 |
| MobileMailAlreadyRegistered | mobileMailが重複しています | 指定したmobileMailが他の会員が使用している場合に返却されます。 |
| StoreCodeNotFound | 指定された店舗コードが登録されていません | 設定＞実店舗店舗＞（よく行くお店）一覧＞店舗設定-店舗コード／【CC未利用・移行中】構築＞実店舗設定＞新規登録・編集-店舗コードに存在しない店舗コードを指定した場合に返却されます。 |
| MemberStageNotFound | 指定された会員ステージが登録されていません | 設定＞購入者・会員情報＞会員ステージ基本設定-会員ステージ設定／【CC未利用・移行中】構築＞会員管理＞会員ステージ基本設定に存在しない会員ステージを指定した場合に返却されます。 |
| NotAvailableOnOmniChannel | omni-channelご利用店舗では使用できません | futureshop omni-channelをご利用頂いている場合に返却されます。 |
サンプル
サンプル（エラー時）
{
"status": "failed",
"errors": [
{
"code": "Invalid",
"path": "storeCode",
"message": "storeCodeの指定が不正です"
}
]
}
サンプル（成功時）
{
"status": "success",
"memberId": "24"
}