| API名 | 販売情報個別取得API |
| ID | el_orderInfo_get_api |
2.詳細解説
販売情報を取得するAPIです。銀行振込での課金決済や、GMO以外の決済システムを使った課金の仕組みを構築する際などで利用されることがあります。
販売情報の詳細はこちらをご覧ください。
$cstream->call_el_orderInfo_get_api($input_array);
3.I/O情報
INPUT
| No | 項目名 | 項目ID | 項目説明 | 必須 | |||||
| 1 | 会社ID | kaisha_id | 会社を表すID | 〇 | |||||
| 2 | アクセスキー | access_key | APIを認証するためのアクセスキー | 〇 | |||||
| 3 | オーダーNo | order_no | 27文字の注文No ※すべてのトランザクションで必ずユニークになる必要がある | 〇 | |||||
OUTPUT
| No | 項目名 | 項目ID | 項目説明 | |||||
| 1 | 実行フラグ | exec_flg | 1:正常 9:エラー | |||||
| 2 | エラータイプ | error_type | 実行フラグ＝エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。 | |||||
| 3 | エラーメッセージ | error_msg | エラーごとに発生するメッセージ | |||||
| 4 | エラー情報 | error_info | 各項目ごとのエラーメッセージを表示（登録に失敗したケース） | |||||
| 5 | オーダーNo | order_no | ||||||
| 6 | 新規既存フラグ | regist_flg | ||||||
| 7 | 商品ID | product_id | ||||||
| 8 | 数量 | product_cnt | ||||||
| 9 | 割引金額 | discount_price | ||||||
| 10 | 合計金額 | total_price | ||||||
| 11 | 受講者ID | userid | ||||||
| 12 | 受講者ﾊﾟｽﾜｰﾄﾞ | userpassword | ||||||
| 13 | 受講者氏名 | username | ||||||
| 14 | 受講者氏名（カナ） | usernamekana | ||||||
| 14 | ニックネーム | nickname | ||||||
| 15 | 性別区分 | sex_kbn | ||||||
| 16 | 年齢 | age | ||||||
| 17 | 生年月日 | birth | ||||||
| 18 | 既婚/未婚区分 | marry_kbn | ||||||
| 19 | 郵便番号 | yubin | ||||||
| 20 | 住所 | address | ||||||
| 21 | 電話番号 | tdisp | ||||||
| 22 | ﾒｰﾙｱﾄﾞﾚｽ | |||||||
| 23 | 携帯ﾒｰﾙｱﾄﾞﾚｽ | mobileMail | ||||||
| 24 | 職業区分 | job_kbn | ||||||
| 25 | 法人名 | incName | ||||||
| 26 | 業種区分 | bizType_kbn | ||||||
| 27 | 従業員数区分 | enpNumber | ||||||
| 28 | 部署名 | departName | ||||||
| 29 | 役職 | position | ||||||
| 30 | 独自のログインID | original_login_id | ||||||
| 31 | 任意項目 | other | ||||||
| 31 | 手動メール配信対象フラグ | manual_mail_target_flg | 0:配信対象外 1:配信対象 | |||||
| 31 | 講師権限付与フラグ | lecturer_auth_add_flg | 0:付与しない 1:付与する | |||||
| 31 | 講師回答承認フラグ | lecturer_answer_approval_flg | 0:承認不要 1:承認する | |||||
| 32 | 受講者ステータス | user_status | ||||||
| 33 | キャンペーンNo | campaign_no | ||||||
| 34 | クーポンNo | coupon_no | ||||||
| 35 | クーポンコード | coupon_code | ||||||
| 36 | 登録日時 | touroku_date | ||||||
| 37 | 商品明細リスト | purchase_list | ||||||
| 37-1 | 商品明細ID | purchase_id | ||||||
| 37-2 | 購入商品名 | purchase_name | ||||||
| 37-3 | 購入商品区分 | purchase_type_kbn | 0:講座 1:講座グループ 2:カリキュラム | |||||
| 37-4 | 購入数量 | purchase_cnt | ||||||
| 37-5 | 購入商品金額 | purchase_price | ||||||
| 38 | 受講者明細リスト | userInfo_list | ||||||
| 38-1 | 受講者ID | userid | ||||||
| 38-2 | 受講者名 | username | ||||||
| 38-3 | メールアドレス | |||||||
| 38-4 | 代表者フラグ | rep_flg | 代表者の場合１ | |||||
エラー
| エラータイプ | エラー概要 | 発生させるメッセージ | 発生させるException | ||||||
| 0 | アクセスキー不適合エラー | アクセスキーが適合しません。 | AccessKeyException | ||||||
| 1 | ホスト許可エラー | 対象のホストからのAPI実行を許可していません。 | HostRestrictException | ||||||
| 2 | 引数エラー | 呼出パラメータが不足しているため実行できません。 | CallParameterException | ||||||
| 9 | システムメンテナンスエラー | 現在システムのメンテナンス中です。YYYY/MM/DD HH - HH の間システムをご利用できません。ご不便おかけし申し訳ございません。 | SystemMaintenanceException | ||||||
4.実装例
|
1 |