制限事項
会員APIを利用する際は下記制限事項が適用されます。
- 各会員APIの実行処理結果を待たずに連続して会員情報の登録・更新・削除を行った場合の会員情報の整合性は保障されません。
- 会員情報取得APIを利用して会員のパスワードを取得することはできません。
- 会員情報に機種依存文字が含まれる場合の文字コード変換時の文字化けについては保障されません。
- 会員情報削除APIを利用して会員情報削除を行う場合、ショップの設定や会員の注文情報の状態により会員情報の削除を行えない場合があります。
前提条件
会員APIを利用するためには以下の条件を満たす必要があります。
- 会員データ連携機能の利用制限が解除されている必要があります。
- 会員データ連携設定画面で認証コードを発行、設定を保存している必要があります。
- HTTPSプロトコル(SSL)を使用して通信を行います。SNIにご対応ください。
ご利用前の準備
会員データ連携設定画面で会員APIを利用するための設定を行います。
会員データ連携機能の設定
- 会員データ連携設定メニュー
- 会員データ連携設定画面に遷移します。
- 認証コード
- 発行ボタン押下でアクセスURL発行時に利用する、新しい認証コードを発行し、入力不可のテキスト領域に認証コードを表示します。
- 保存ボタンが押下されるまでは発行した認証コードを保存しません。
- 一度も保存を行っていない場合は、認証を行えないため、会員APIの各機能を利用できません。
- 認証コードの登録の有無により発行ボタンの文言が切り替わります。
- 認証コードが保存されていない場合は「発行」を表示。
- 認証コードが保存されている場合は「再発行」を表示。
- 利用する会員APIの設定
- 会員APIの各機能の利用を許可するかを設定します。
- 会員情報参照・・・会員情報取得APIの利用可否を設定します。
- 会員情報登録・・・会員情報登録APIの利用可否を設定します。
- 会員情報変更・・・会員情報更新APIの利用可否を設定します。
- 会員情報削除・・・会員情報削除APIの利用可否を設定します。
- 「許可しない」を選択して設定を保存すると該当機能が利用できなくなります。
- 初期値は全て「利用する」
- 会員APIの各機能の利用を許可するかを設定します。
- 保存ボタン
- 上記で設定された会員データ連携の設定を保存します。
- 認証コードが発行されていない状態では設定を保存することができません。
- 認証コードが未発行の状態では会員APIの各機能を利用できません。
会員API利用時の処理フロー
下記が会員API利用時の概略図です。
会員API共通仕様
会員APIでは以下の共通の仕様があります。
- レスポンスの応答形式はXML形式とJSON形式から選択できます。
- レスポンスの応答形式が未指定の場合はXML形式を適用します。
- パラメータ送信時の文字コードはUTF-8を利用してください。
- 会員APIを利用するための前提条件を満たしていない場合はHEADERレスポンスのみを返却します。
- 会員APIに送信するパラメータ値にはURLエンコードを行ってください。
- レスポンスの応答形式がXMLの場合、会員APIからURLエンコードを行った値を返却するため、レスポンス取得時にURLデコードを行ってください。
- 各APIにアクセスする為のURLはアクセスURL発行APIを実行し、取得してください。
- アクセスURL発行APIの実行結果より取得したURLに対し、POSTメソッドでパラメータを送信してください。
処理結果として返却するステータスコードには以下の種類があります。
No | ステータスコード | 種別 | 区分 | 説明 | エラーメッセージ(※) |
---|---|---|---|---|---|
1 | 200 | 正常 | – | 送信された処理を正常に完了した場合に返却する。 | |
2 | E01 | 異常 | 認証エラー | 認証コードの不一致やアクセスURLの有効期限切れの場合に返却する。 | ショップID、または認証コードに誤りがあります。 URLが無効です。 |
3 | E02 | 異常 | 不正操作 | makeshop管理画面で許可した操作以外の操作のリクエストを取得した場合に返却する。 | 管理画面で許可されていない操作です。 |
4 | E03 | 異常 | 入力チェックエラー | 送信されたパラメータが不正な場合に返却する。 | 会員IDを入力してください。 入力された会員IDはご利用いただけません。 実行するAPIが指定されていません。 |
5 | E99 | 異常 | システムエラー | 会員情報登録、更新、削除などDB操作を伴う処理で致命的なエラーが発生した場合に返却する。 | 会員情報の登録に失敗しました。 |
- エラーメッセージ(※)の内容は変更になる可能性があるため、ステータスコードで処理結果を判定してください。
- 各APIアクセス時の必須パラメータ項目が設定されていない場合は、不正アクセスと見なし応答を返却しません。
- ショップの機能制限設定が解除されていない場合は、不正アクセスと見なし応答を返却しません。
XML形式のサンプルレスポンス
<?xml version="1.0" encoding="utf-8"?>
<result_data>
<status_code>200</status_code>
<access_token>85fabea79e90eb2b8cf51c326899252c</access_token>
<expire_date>20130913235959</expire_date>
<total_count>100</total_count>
<display_record_from>1</display_record_from>
<display_record_to>100</display_record_to>
<member_list>
<member>
<group_id/>
<member_id>usertest</member_id>
</member>
</member_list>
<member_id>usertest2</member_id>
<error_message/>
</result_data>
JSON形式のサンプルレスポンス
{"result_data":{"status_code":"200","total_count":0,"display_record_from":null,"display_record_to":null,"member_list":null,"error_message":null}}
アクセスURL発行APIの仕様
- 会員データ連携機能設定画面で発行した認証コードと呼び出す機能を指定し、各会員APIにアクセスするためのURLを発行する機能です。
- アクセスURL発行APIには下記URLに対して、POSTメソッドでパラメータを送信してください。
リクエストURL
https://www.makeshop.jp/api/member/auth/
返却されたアクセスURLの例
https://www.makeshop.jp/api/member/search/?shop_id=flowershop2015&access_token=7efc686ff0e9d79eff72cefc4bc1f563
送信パラメータ
No | 項目名 | パラメータ名 | 必須 | 属性 | 文字数 | 送信方法 | 説明 |
---|---|---|---|---|---|---|---|
1 | ショップID | shop_id | ○ | 半角英数字 | 4~12 | POST | makeshopの管理画面ログイン時に利用するショップID 例)shoptest |
2 | 認証コード | auth_code | ○ | 半角英数字 | 32 | POST | makeshop管理画面で発行、登録した認証コード 例)85fabea79e90eb2b8cf51c326899252c |
3 | 実行API | process | ○ | 半角英数字 | 6 | POST | search:会員情報取得API実行時に指定 entry:会員情報登録API実行時に指定 modify:会員情報更新API実行時に指定 delete:会員情報削除API実行時に指定 例)search |
4 | レスポンス形式 | response_format | 半角数値 | 1 | POST | xml:XML形式でレスポンスを返却 json:JSON形式でレスポンスを返却 未指定時はXML形式でレスポンスを返却 |
- ○:必須項目
戻りパラメータ
No | 項目名 | パラメータ名 | 種別 | 属性 | 文字数 | 説明 |
---|---|---|---|---|---|---|
1 | ステータスコード | status_code | ○ | 半角英数字 | 3 | 詳細についてはステータスコード一覧を参照 |
2 | アクセスURL | access_url | △※1 | 半角英数字 | – | 初回発行時より5分間有効となるURL |
3 | 有効期限 | expire_date | △※1 | 半角数値 | 14 | アクセスURLの有効期限 YYYYMMDDHHMMSS形式 |
4 | エラーメッセージ | error_message | △※2 | 全角文字 | 255 | エラーが発生した場合のみURLエンコード済みのエラーメッセージを格納 |
- ○:機能を利用できる場合、必ず返却する。
- △:項目パラメータのキー値は必ず返却するが、条件により値が空になる。
- ※1 送信パラメータを利用した認証に成功した場合、返却する。(認証エラーが発生した場合は空の値を返却)
- ※2 送信パラメータによる認証時にエラーが発生した場合、返却する。
会員情報取得API
会員情報を検索する機能です。
- ソート順が未指定の場合は会員登録日の昇順でソートした結果を返却します。
- 会員情報取得API実行で一度に返却可能な会員情報の件数は100件です。
- 100件を超える会員情報の一覧を取得する場合は表示ページを指定してください。
送信パラメータ
No | 項目名 | パラメータ名 | 必須 | 属性 | 文字数 | 送信方法 | 説明 |
---|---|---|---|---|---|---|---|
1 | レスポンス形式 | response_format | 半角数値 | 1 | POST | xml:XML形式でレスポンスを返却 json:JSON形式でレスポンスを返却 未指定時はXML形式でレスポンスを返却 |
|
2 | 会員ID | member_id | 半角英数字 | 4~12 | POST | ショップに登録されている会員ID 例)usertest |
|
3 | 会員グループID | group_id | 半角数値 | 2 | POST | ショップに登録されている会員グループID 例)1 |
|
4 | 会員登録日(FROM) | join_date_from | 半角数値 | 8 | POST | 会員をショップに登録した日付 YYYYMMDD形式 最大3カ月間を指定しての範囲検索が可能 例)20130507 |
|
5 | 会員登録日(TO) | join_date_to | 半角数値 | 8 | POST | 会員をショップに登録した日付 YYYYMMDD形式 例)20130806 |
|
6 | 削除会員表示 | display_delete_member | 半角数値 | 1 | POST | 0:論理削除会員を表示しない 1:論理削除会員を表示する 省略時は論理削除会員を表示しない |
|
7 | 最終更新日時(FROM) | last_update_date_from | 半角数値 | 14 | POST | 会員情報の更新日時 YYYYMMDDHHMMSS形式 30日以内に更新された会員が範囲検索可能 例)20200710123456 |
|
8 | 最終更新日時(TO) | last_update_date_to | 半角数値 | 14 | POST | 会員情報の更新日時 YYYYMMDDHHMMSS形式 30日以内に更新された会員が範囲検索可能 例)20200730123456 |
|
9 | 表示ページ | display_page | 半角数値 | 3 | POST | 検索結果が1回のレスポンスで返却出来ない場合にページを指定 | |
10 | ソート順 | sort_order | 半角数値 | 1 | POST | 0:会員登録日の昇順でソート 1:会員登録日の降順でソート 省略時は会員登録日の昇順でソート |
- ○:必須項目
戻りパラメータ
No | 項目名 | パラメータ名 | 種別 | 属性 | 文字数 | 説明 |
---|---|---|---|---|---|---|
1 | ステータスコード | status_code | ○ | 半角英数字 | 3 | 詳細についてはステータスコード一覧を参照 |
2 | 検索結果件数 | total_count | △※1 | 半角数値 | 3 | 検索条件に該当した会員情報の件数を格納 |
3 | 出力件数(FROM) | display_record_from | △※1 | 半角数値 | 3 | 出力する会員情報の開始行数を格納 |
4 | 出力件数(TO) | display_record_to | △※1 | 半角数値 | 3 | 出力する会員情報の終了行数を格納 |
5 | 会員グループID | group_id | △※1 | 半角数値 | 2 | |
6 | 会員グループ名 | group_name | △※1 | 全角文字 | 20 | URLエンコード済み |
7 | 会員ID | member_id | △※1 | 半角英数字 | 4~12 | |
8 | 会員名 | member_name | △※1 | 全角文字 | 20 | URLエンコード済み |
9 | 会員名(カナ) | member_name_kana | △※1 | 全角文字 | 20 | URLエンコード済み |
10 | メールアドレス | △※1 | 半角英数字 | 255 | URLエンコード済み | |
11 | メールマガジン受信可否 | email_magazine_receive | △※1 | 半角英数字 | 1 | Y:メールマガジンの配信を希望する N:メールマガジンの配信を希望しない |
12 | 性別 | sex | △※1 | 半角数値 | 1 | 0:男性 1:女性 2:無回答 |
13 | 生年月日 | birthday | △※1 | 半角数値 | 8 | YYYYMMDD形式 |
14 | 保有ショップポイント | member_point | △※1 | 半角数値 | 11 | 会員が保有しているショップポイントを格納 |
15 | 保有ショップポイント満了日 | member_point_expire_date | △※1 | 半角数値 | 8 | YYYYMMDD形式 |
16 | 紹介者ID | recommand_member_id | △※1 | 半角英数字 | 4~12 | 紹介者の会員IDを格納 |
17 | 郵便番号(自宅) | home_post | △※1 | 半角数値 | 7 | |
18 | 都道府県コード(自宅) | home_prefecture_code | △※1 | 半角数値 | 2 | 都道府県リストの番号を格納 |
19 | 都道府県文字列(自宅) | home_prefecture | △※1 | 全角文字 | 8 | URLエンコード済みの都道府県リストの都道府県名を格納 |
20 | 市区町村(自宅) | home_address1 | △※1 | 全角文字 | 40 | URLエンコード済み |
21 | その他住所等(自宅) | home_address2 | △※1 | 全角文字 | 60 | URLエンコード済み |
22 | 電話番号(自宅) | home_phone | △※1 | 半角英数字 | 20 | |
23 | FAX番号(自宅) | home_fax | △※1 | 半角英数字 | 20 | |
24 | 電話番号(携帯) | mobile_phone | △※1 | 半角英数字 | 20 | |
25 | メールアドレス(携帯) | mobile_email | △※1 | 半角英数字 | 64 | URLエンコード済み |
26 | 会社名 | office_name | △※1 | 全角文字 | 30 | URLエンコード済み |
27 | 会社名(カナ) | office_name_kana | △※1 | 全角文字 | 30 | URLエンコード済み |
28 | 所属部署名 | office_department | △※1 | 全角文字 | 30 | URLエンコード済み |
29 | 郵便番号(会社) | office_post | △※1 | 半角数値 | 7 | |
30 | 都道府県コード(会社) | office_prefecture_code | △※1 | 半角数値 | 2 | 都道府県リストの番号を格納 |
31 | 都道府県文字列(会社) | office_prefecture | △※1 | 全角文字 | 8 | URLエンコード済みの都道府県リストの都道府県名を格納 |
32 | 市区町村(会社) | office_address | △※1 | 全角文字 | 60 | URLエンコード済み |
33 | 電話番号(会社) | office_phone | △※1 | 半角英数字 | 20 | |
34 | 追加入力項目1 | additional_option1 | △※1 | 全半角文字 | 999 | URLエンコード済み |
35 | 追加入力項目2 | additional_option2 | △※1 | 全半角文字 | 999 | URLエンコード済み |
36 | 追加入力項目3 | additional_option3 | △※1 | 全半角文字 | 999 | URLエンコード済み |
37 | 追加入力項目4 | additional_option4 | △※1 | 全半角文字 | 999 | URLエンコード済み |
38 | 追加入力項目5 | additional_option5 | △※1 | 全半角文字 | 999 | URLエンコード済み |
39 | 追加入力項目6 | additional_option6 | △※1 | 全半角文字 | 999 | URLエンコード済み |
40 | 追加入力項目7 | additional_option7 | △※1 | 全半角文字 | 999 | URLエンコード済み |
41 | メールアドレス認証設定 | email_auth | △※1 | 半角英数字 | 1 | Y:メールアドレスでのログインが可能 N:メールアドレスでのログインは不可 |
42 | 登録日 | join_date | △※1 | 半角数値 | 8 | YYYYMMDD形式 |
43 | LINE ID | line_id | 半角英数値 | 255 | LINE ID連携が「連携する」の場合のみ出力 | |
44 | 会員情報メモ | memo | △※1 | 全角文字 | 400 | URLエンコード済みの会員情報メモ |
45 | 最終更新日時 | last_update_date | △※1 | 半角数値 | 14 | YYYYMMDDHHMMSS形式 30日以内に会員情報が更新された場合に返却する |
46 | 削除会員フラグ | delete_shop_member | 〇 | 半角数値 | 1 | 0:論理削除会員ではない 1:論理削除会員 |
47 | エラーメッセージ | error_message | △※2 | 全角文字 | 255 | URLエンコード済みのエラーメッセージを格納 |
- ○:機能を利用できる場合、必ず返却する。
- △:項目パラメータのキー値は必ず返却するが、条件により値が空になる。
- ※1 検索結果に該当する会員情報が存在する場合に返却する。
- ※2 送信パラメータの入力チェックでエラーが発生した場合、返却する。
会員情報登録API
新規に会員情報を登録する機能です。
- 会員情報登録API実行で一度に登録できる会員情報は1件です。
- 送信パラメータの値が空の状態の場合、該当する会員情報の項目にはデフォルト値が設定されます。
- 登録時にショップポイントを付与することはできません。
送信パラメータ
No | 項目名 | パラメータ名 | 必須 | 属性 | 文字数 | 送信方法 | 説明 |
---|---|---|---|---|---|---|---|
1 | レスポンス形式 | response_format | 半角数値 | 1 | POST | xml:XML形式でレスポンスを返却 json:JSON形式でレスポンスを返却 未指定時はXML形式でレスポンスを返却 |
|
2 | 会員グループID | group_id | 半角数値 | 2 | POST | 登録する会員が所属するショップ会員グループID 例)1 |
|
3 | 会員ID | member_id | △※1 | 半角英数字 | 4~12 | POST | ショップに登録する会員ID 例)usertest6012 システムで予約されているため大文字の X から始まる会員IDは利用できません利用できない例)Xuser93_2411 |
4 | パスワード | member_password | ○ | 半角英数字 | 4~32 | POST | ショップログイン時に会員が利用するパスワード 例)fc4890a7 |
5 | 会員名 | member_name | ○ | 全角文字 | 20 | POST | URLエンコードした会員名 例)%A3%CD%A3%E1%A3%EB%A3%E5%C2%C0%CF%BA |
6 | 会員名(カナ) | member_name_kana | ○ | 全角文字 | 20 | POST | URLエンコードした会員名(カナ) 例)%A5%E1%A5%A4%A5%AF%A5%BF%A5%ED%A5%A6 |
7 | メールアドレス | △※2 | 半角英数字 | 255 | POST | URLエンコードしたメールアドレス 会員のログイン許可設定でメールアドレスをIDに設定している場合は必須 例)test%40makeshop.jp |
|
8 | メールマガジン受信可否 | email_magazine_receive | △※2 | 半角英字 | 1 | POST | Y:メールマガジンの配信を希望する N:メールマガジンの配信を希望しない 例)Y |
9 | 性別 | sex | △※2 | 半角数値 | 1 | POST | 0:男性 1:女性 2:無回答 例)0 |
10 | 生年月日 | birthday | △※2 | 半角数値 | 8 | POST | YYYYMMDD形式 例)19750516 |
11 | 紹介者ID | recommand_member_id | 半角英数字 | 4~12 | POST | 紹介者の会員ID 例)rectest |
|
12 | 郵便番号(自宅) | home_post | △※2 | 半角数値 | 7 | POST | 例)1508512 |
13 | 都道府県コード(自宅) | home_prefecture_code | △※2、※3 | 半角数値 | 2 | POST | 都道府県リストの番号 例)13 |
14 | 都道府県文字列(自宅) | home_prefecture | △※2、※3 | 全角文字 | 8 | POST | URLエンコードした都道府県文字列(自宅) 例)%C5%EC%B5%FE%C5%D4 |
15 | 市区町村(自宅) | home_address1 | △※2 | 全角文字 | 40 | POST | URLエンコードした市区町村(自宅) 例)%BD%C2%C3%AB%B6%E8 |
16 | その他住所等(自宅) | home_address2 | △※2 | 全角文字 | 60 | POST | URLエンコードしたその他住所等(自宅) 例)%BA%F9%B5%D6%C4%AE%A3%B2%A3%B6%A1%DD%A3%B1%A1%A1%A5%BB%A5%EB%A5%EA%A5%A2%A5%F3%A5%BF%A5%EF%A1%BC |
17 | 電話番号(自宅) | home_phone | △※2 | 半角英数字 | 20 | POST | 例)03-5728-6224 |
18 | FAX番号(自宅) | home_fax | △※2 | 半角英数字 | 20 | POST | 例)03-5728-6225 |
19 | 電話番号(携帯) | mobile_phone | △※2 | 半角英数字 | 20 | POST | 例)090-3412-5678 |
20 | メールアドレス(携帯) | mobile_email | △※2 | 半角英数字 | 64 | POST | 例)mobile%40docomo.ne.jp |
21 | 会社名 | office_name | △※2 | 全角文字 | 30 | POST | URLエンコードした会社名 例)%A3%C7%A3%CD%A3%CF%A5%E1%A5%A4%A5%AF%A5%B7%A5%E7%A5%C3%A5%D7%B3%F4%BC%B0%B2%F1%BC%D2 |
22 | 会社名(カナ) | office_name_kana | △※2 | 全角文字 | 30 | POST | URLエンコードした会社名(カナ) 例)%A5%B8%A1%BC%A5%A8%A5%E0%A5%AA%A1%BC%A5%E1%A5%A4%A5%AF%A5%B7%A5%E7%A5%C3%A5%D7%A5%AB%A5%D6%A5%B7%A5%AD%A5%AB%A5%A4%A5%B7%A5%E3 |
23 | 所属部署名 | office_department | △※2 | 全角文字 | 30 | POST | URLエンコードした所属部署名 例)%B4%EB%B2%E8%B3%AB%C8%AF%C9%F4 |
24 | 郵便番号(会社) | office_post | △※2 | 半角数値 | 7 | POST | 例)1508512 |
25 | 都道府県コード(会社) | office_prefecture_code | △※2、※3 | 半角数値 | 2 | POST | 都道府県リストの番号 例)13 |
26 | 都道府県文字列(会社) | office_prefecture | △※2、※3 | 全角文字 | 8 | POST | URLエンコードした都道府県文字列(会社) 例)%C5%EC%B5%FE%C5%D4 |
27 | 市区町村(会社) | office_address | △※2 | 全角文字 | 60 | POST | URLエンコードした市区町村(会社) 例)%BD%C2%C3%AB%B6%E8%BA%F9%B5%D6%C4%AE%A3%B2%A3%B6%A1%DD%A3%B1%A1%A1%A5%BB%A5%EB%A5%EA%A5%A2%A5%F3%A5%BF%A5%EF%A1%BC |
28 | 電話番号(会社) | office_phone | △※2 | 半角英数字 | 20 | POST | 例)03-5728-6224 |
29 | 追加入力項目1 | additional_option1 | △※4 | 全半角文字 | 999 | POST | URLエンコードした追加入力項目1 追加入力項目の設定で設定した文字数入力が可能 |
30 | 追加入力項目2 | additional_option2 | △※4 | 全半角文字 | 999 | POST | URLエンコードした追加入力項目2 追加入力項目の設定で設定した文字数入力が可能 |
31 | 追加入力項目3 | additional_option3 | △※4 | 全半角文字 | 999 | POST | URLエンコードした追加入力項目3 追加入力項目の設定で設定した文字数入力が可能 |
32 | 追加入力項目4 | additional_option4 | △※4 | 全半角文字 | 999 | POST | URLエンコードした追加入力項目4 追加入力項目の設定で設定した文字数入力が可能 |
33 | 追加入力項目5 | additional_option5 | △※4 | 全半角文字 | 999 | POST | URLエンコードした追加入力項目5 追加入力項目の設定で設定した文字数入力が可能 |
34 | 追加入力項目6 | additional_option6 | △※4 | 全半角文字 | 999 | POST | URLエンコードした追加入力項目6 追加入力項目の設定で設定した文字数入力が可能 |
35 | 追加入力項目7 | additional_option7 | △※4 | 全半角文字 | 999 | POST | URLエンコードした追加入力項目7 追加入力項目の設定で設定した文字数入力が可能 |
36 | 登録日 | join_date | 半角数値 | 8 | POST | YYYYMMDD形式 未指定の場合は「null(//)」を設定 例)20130913 |
|
37 | 会員ID自動採番設定 | member_id_auto_create | △ | 半角英字 | 1 | POST | 会員のログイン許可設定で自動採番を許可している場合のみ有効 Y:会員IDを自動で採番する N:入力した会員IDを利用する 例)N |
38 | メールアドレス認証設定 | email_auth | △ | 半角英字 | 1 | POST | 会員のログイン許可設定でメールアドレスでのログインを許可している場合のみ有効 Y:メールアドレスでの会員ログインを許可する N:メールアドレスでの会員ログインを許可しない 例)Y |
39 | 管理者による会員認証 | admin_member_auth | 半角英字 | 1 | POST | Y:会員登録後すぐに会員のログインを許可する N:会員登録後すぐに会員のログインを許可しない 例)Y |
- ○:必須項目
- △:条件付き必須項目 リクエストで送信されていない項目値は登録しない。
- ※1 会員ID自動採番設定がNの場合必須となる。
- ※2 基本登録項目の設定で必須に設定されている場合は必須となる。
- ※3 都道府県リストに存在する都道府県を都道府県文字列に指定している場合は都道府県コードを都道府県リストから取得して自動で設定する。
- ※4 追加入力項目の設定で必須に設定されている場合は必須となる。
|
は入力できない。
戻りパラメータ
No | 項目名 | パラメータ名 | 種別 | 属性 | 文字数 | 説明 |
---|---|---|---|---|---|---|
1 | ステータスコード | status_code | ○ | 半角英数字 | 3 | 詳細についてはステータスコード一覧を参照 |
2 | 会員ID | member_id | △※1 | 半角英数字 | 4~12 | 登録した会員IDを格納 |
3 | エラーメッセージ | error_message | △※2 | 全角文字 | 255 | URLエンコード済みのエラーメッセージを格納 |
- ○:機能を利用できる場合、必ず返却する。
- △:項目パラメータのキー値は必ず返却するが、条件により値が空になる。
- ※1 会員情報の登録に成功した場合に返却する。
- ※2 送信パラメータの入力チェックでエラーが発生した場合、返却する。
会員情報更新API
登録済みの会員情報を更新する機能です。
- 会員情報更新API実行で一度に更新できる会員情報は1件です。
- 更新を行う会員情報の項目のみ、送信パラメータのキーを送信してください。
- 送信パラメータの値が空の状態の場合、該当する会員情報の項目は空白になります。
送信パラメータ
No | 項目名 | パラメータ名 | 必須 | 属性 | 文字数 | 送信方法 | 説明 |
---|---|---|---|---|---|---|---|
1 | レスポンス形式 | response_format | 半角数値 | 1 | POST | xml:XML形式でレスポンスを返却 json:JSON形式でレスポンスを返却 未指定時はXML形式でレスポンスを返却 |
|
2 | 会員グループID | group_id | 半角数値 | 2 | POST | 登録する会員が所属するショップ会員グループID 例)1 |
|
3 | 会員ID | member_id | ○ | 半角英数字 | 4~12 | POST | ショップに登録されている会員ID 例)usertest |
4 | パスワード | member_password | 半角英数字 | 4~32 | POST | ショップログイン時に会員が利用するパスワード 例)fc4890a7 |
|
5 | 会員名 | member_name | △※1 | 全角文字 | 20 | POST | URLエンコードした会員名 例)%A3%CD%A3%E1%A3%EB%A3%E5%C2%C0%CF%BA |
6 | 会員名(カナ) | member_name_kana | △※1 | 全角文字 | 20 | POST | URLエンコードした会員名(カナ) 例)%A5%E1%A5%A4%A5%AF%A5%BF%A5%ED%A5%A6 |
7 | メールアドレス | △※1、※2 | 半角英数字 | 255 | POST | URLエンコードしたメールアドレス 例)test%40makeshop.jp |
|
8 | メールマガジン受信可否 | email_magazine_receive | △※1 | 半角英字 | 1 | POST | Y:メールマガジンの配信を希望する N:メールマガジンの配信を希望しない 例)Y |
9 | 性別 | sex | △※1 | 半角数値 | 1 | POST | 0:男性 1:女性 2:無回答 例)0 |
10 | 生年月日 | birthday | △※1 | 半角数値 | 8 | POST | YYYYMMDD形式 例)19750516 |
11 | 郵便番号(自宅) | home_post | △※1 | 半角数値 | 7 | POST | 例)1508512 |
12 | 都道府県コード(自宅) | home_prefecture_code | △※1、※3 | 半角数値 | 2 | POST | 都道府県リストの番号 例)13 |
13 | 都道府県文字列(自宅) | home_prefecture | △※1、※3 | 全角文字 | 8 | POST | URLエンコードした都道府県文字列(自宅) 例)%C5%EC%B5%FE%C5%D4 |
14 | 市区町村(自宅) | home_address1 | △※1 | 全角文字 | 40 | POST | URLエンコードした市区町村(自宅) 例)%BD%C2%C3%AB%B6%E8 |
15 | その他住所等(自宅) | home_address2 | △※1 | 全角文字 | 60 | POST | URLエンコードしたその他住所等(自宅) 例)%BA%F9%B5%D6%C4%AE%A3%B2%A3%B6%A1%DD%A3%B1%A1%A1%A5%BB%A5%EB%A5%EA%A5%A2%A5%F3%A5%BF%A5%EF%A1%BC |
16 | 電話番号(自宅) | home_phone | △※1 | 半角英数字 | 20 | POST | 例)03-5728-6224 |
17 | FAX番号(自宅) | home_fax | △※1 | 半角英数字 | 20 | POST | 例)03-5728-6225 |
18 | 電話番号(携帯) | mobile_phone | △※1 | 半角英数字 | 20 | POST | |
19 | メールアドレス(携帯) | mobile_email | △※1 | 半角英数字 | 64 | POST | |
20 | 会社名 | office_name | △※1 | 全角文字 | 30 | POST | URLエンコードした会社名 例)%A3%C7%A3%CD%A3%CF%A5%E1%A5%A4%A5%AF%A5%B7%A5%E7%A5%C3%A5%D7%B3%F4%BC%B0%B2%F1%BC%D2 |
21 | 会社名(カナ) | office_name_kana | △※1 | 全角文字 | 30 | POST | URLエンコードした会社名(カナ) 例)%A5%B8%A1%BC%A5%A8%A5%E0%A5%AA%A1%BC%A5%E1%A5%A4%A5%AF%A5%B7%A5%E7%A5%C3%A5%D7%A5%AB%A5%D6%A5%B7%A5%AD%A5%AB%A5%A4%A5%B7%A5%E3 |
22 | 所属部署名 | office_department | △※1 | 全角文字 | 30 | POST | URLエンコードした所属部署名 例)%B4%EB%B2%E8%B3%AB%C8%AF%C9%F4 |
23 | 郵便番号(会社) | office_post | △※1 | 半角数値 | 7 | POST | 例)1508512 |
24 | 都道府県コード(会社) | office_prefecture_code | △※1、※3 | 半角数値 | 2 | POST | 都道府県リストの番号 例)13 |
25 | 都道府県文字列(会社) | office_prefecture | △※1、※3 | 全角文字 | 8 | POST | URLエンコードした都道府県文字列(会社) 例)%C5%EC%B5%FE%C5%D4 |
26 | 市区町村(会社) | office_address | △※1 | 全角文字 | 60 | POST | URLエンコードした市区町村(会社) 例)%BD%C2%C3%AB%B6%E8%BA%F9%B5%D6%C4%AE%A3%B2%A3%B6%A1%DD%A3%B1%A1%A1%A5%BB%A5%EB%A5%EA%A5%A2%A5%F3%A5%BF%A5%EF%A1%BC |
27 | 電話番号(会社) | office_phone | △※1 | 半角英数字 | 20 | POST 例) |
03-5728-6224 |
28 | 追加入力項目1 | additional_option1 | △※1、※4 | 全半角文字 | 999 | POST | URLエンコードした追加入力項目1 追加入力項目の設定で設定した文字数入力が可能 |
29 | 追加入力項目2 | additional_option2 | △※1、※4 | 全半角文字 | 999 | POST | URLエンコードした追加入力項目2 追加入力項目の設定で設定した文字数入力が可能 |
30 | 追加入力項目3 | additional_option3 | △※1、※4 | 全半角文字 | 999 | POST | URLエンコードした追加入力項目3 追加入力項目の設定で設定した文字数入力が可能 |
31 | 追加入力項目4 | additional_option4 | △※1、※4 | 全半角文字 | 999 | POST | URLエンコードした追加入力項目4 追加入力項目の設定で設定した文字数入力が可能 |
32 | 追加入力項目5 | additional_option5 | △※1、※4 | 全半角文字 | 999 | POST | URLエンコードした追加入力項目5 追加入力項目の設定で設定した文字数入力が可能 |
33 | 追加入力項目6 | additional_option6 | △※1、※4 | 全半角文字 | 999 | POST | URLエンコードした追加入力項目6 追加入力項目の設定で設定した文字数入力が可能 |
34 | 追加入力項目7 | additional_option7 | △※1、※4 | 全半角文字 | 999 | POST | URLエンコードした追加入力項目7 追加入力項目の設定で設定した文字数入力が可能 |
35 | メールアドレス認証設定 | email_auth | △※1、※2 | 半角英字 | 1 | POST | 会員のログイン許可設定でメールアドレスでのログインを許可している場合のみ有効 Y:メールアドレスでの会員ログインを許可する N:メールアドレスでの会員ログインを許可しない 例)Y |
36 | ショップポイント | point | △※1 | 半角数値 | 11 | POST | 指定した会員のショップポイントを変更します。 絶対値および相対値(+-)での指定が可能です。 ※ + - の記号は11桁の文字制限に含まない例)0 100 +200 -300 |
37 | ショップポイント満了日 | point_expire_date | △※1 | 半角数値 | 8 | POST | YYYYMMDD形式 例)20261231※空の値を送信した場合、入力チェックでエラーとなる。 |
38 | ショップポイント変動理由 | point_comment | △※1、※5 | 全角文字 | 50 | POST | URLエンコードしたショップポイント変動理由 ※パラメーター「point」との同時指定必須 ※パラメーター「point」入力時に「point_comment」未入力または空欄の場合は固定の文字列「管理者によるポイント更新」を入力 例)API%a4%c7%a5%dd%a5%a4%a5%f3%a5%c8%b9%b9%bf%b7 |
39 | 会員情報メモ | memo | △※1 | 全角文字 | 400 | POST | URLエンコードした会員情報メモを上書き更新 例)URL%a5%a8%a5%f3%a5%b3%a1%bc%a5%c9%a4%b7%a4%bf%b2%f1%b0%f7%be%f0%ca%f3%a5%e1%a5%e2%a4%f2%be%e5%bd%f1%a4%ad%b9%b9%bf%b7%a4%b7%a4%de%a4%b9 |
- ○:必須項目
- △:更新を行う項目のみリクエストを送信する。リクエストで送信されていない項目値は更新しない。設定済み項目値を削除したい場合は、空の値を送信する。
- ※1 基本登録項目の設定で必須に設定されている場合は必須となるため、項目値の削除はできない。
- ※2 メールアドレス認証設定にYを指定しメールアドレスの変更を行う場合は変更後のメールアドレスが他の会員によって利用されていない必要がある。
- ※3 都道府県リストに存在する都道府県を都道府県文字列に指定している場合は、都道府県コードを都道府県リストから取得して自動で設定する。
- ※4 追加入力項目の設定で必須に設定されている場合は必須となるため、項目値の削除はできない。
|
は入力できない。 - ※5 「ショップポイント変動理由」は「ショップポイント」と同時指定が必須。単独での更新は不可。「ショップポイント」更新時に「ショップポイント変動理由」の入力がない場合は固定文字列「管理者によるポイント更新」をショップポイント変動理由ログに入力する。
戻りパラメータ
No | 項目名 | パラメータ名 | 種別 | 属性 | 文字数 | 説明 |
---|---|---|---|---|---|---|
1 | ステータスコード | status_code | ○ | 半角英数字 | 3 | 詳細についてはステータスコード一覧を参照 |
2 | 会員ID | member_id | △※1 | 半角英数字 | 4~12 | 更新した会員IDを格納 |
3 | エラーメッセージ | error_message | △※2 | 全角文字 | 255 | URLエンコード済みのエラーメッセージを格納 |
- ○:機能を利用できる場合、必ず返却する。
- △:項目パラメータのキー値は必ず返却するが、条件により値が空になる。
- ※1 会員情報の更新に成功した場合に返却する。
- ※2 送信パラメータの入力チェックでエラーが発生した場合、返却する。
会員情報削除API
登録済みの会員情報を削除する機能です。
- 会員情報削除API実行で一度に削除できる会員情報は1件です。
- 予約販売の注文情報が存在する会員情報は削除できません。
- 定期購入の注文情報が存在する会員情報は削除できません。
- 多店舗連携を行っているショップの会員は削除会員となります。
- 商品購入時に決済会社に保存した会員のカード情報は削除します。
送信パラメータ
No | 項目名 | パラメータ名 | 必須 | 属性 | 文字数 | 送信方法 | 説明 |
---|---|---|---|---|---|---|---|
1 | レスポンス形式 | response_format | 半角数値 | 1 | POST | xml:XML形式でレスポンスを返却 json:JSON形式でレスポンスを返却 未指定時はXML形式でレスポンスを返却 |
|
2 | 会員ID | member_id | ○ | 半角英数字 | 4~12 | POST | ショップに登録されている会員ID 例)usertest |
- ○:必須項目
戻りパラメータ
No | 項目名 | パラメータ名 | 種別 | 属性 | 文字数 | 説明 |
---|---|---|---|---|---|---|
1 | ステータスコード | status_code | ○ | 半角英数字 | 3 | 詳細についてはステータスコード一覧を参照 |
2 | 会員ID | member_id | △※1 | 半角英数字 | 4~12 | 削除した会員IDを格納 |
3 | エラーメッセージ | error_message | △※2 | 全角文字 | 255 | URLエンコード済みのエラーメッセージを格納 |
- ○:機能を利用できる場合、必ず返却する。
- △:項目パラメータのキー値は必ず返却するが、条件により値が空になる。
- ※1 会員情報の削除に成功した場合に返却する。
- ※2 送信パラメータの入力チェックでエラーが発生した場合に返却する。
都道府県リスト
各種パラメーターで指定される都道府県リストは、以下の番号に対応しています。
番号 | 都道府県 |
---|---|
1 | 北海道 |
2 | 青森県 |
3 | 岩手県 |
4 | 宮城県 |
5 | 秋田県 |
6 | 山形県 |
7 | 福島県 |
8 | 茨城県 |
9 | 栃木県 |
10 | 群馬県 |
11 | 埼玉県 |
12 | 千葉県 |
13 | 東京(23区内) |
14 | 東京(23区外) |
15 | 神奈川県 |
16 | 新潟県 |
17 | 富山県 |
18 | 石川県 |
19 | 福井県 |
20 | 山梨県 |
21 | 長野県 |
22 | 岐阜県 |
23 | 静岡県 |
24 | 愛知県 |
25 | 三重県 |
26 | 滋賀県 |
27 | 京都府 |
28 | 大阪府 |
29 | 兵庫県 |
30 | 奈良県 |
31 | 和歌山県 |
32 | 鳥取県 |
33 | 島根県 |
34 | 岡山県 |
35 | 広島県 |
36 | 山口県 |
37 | 徳島県 |
38 | 香川県 |
39 | 愛媛県 |
40 | 高知県 |
41 | 福岡県 |
42 | 佐賀県 |
43 | 長崎県 |
44 | 熊本県 |
45 | 大分県 |
46 | 宮崎県 |
47 | 鹿児島県 |
48 | 沖縄県 |
49 | 離島部 |
50 | 海外 |
会員API企画書社外用.pptx
会員API別紙パラメータ一覧.xlsx