lms-他システム連携/API

13-03-21.販売履歴登録API

更新日:

API名 販売履歴登録API
ID el_orderRireki_upd_api

2.詳細解説

販売履歴を登録する際に利用するAPIです。販売情報登録APIを使わずに決済処理を独自にコーディングする際に利用します。(銀行振込の場合も含む)

$cstream->call_el_orderRireki_upd_api($input_array);

3.I/O情報

INPUT

No 項目名 項目ID 項目説明 必須
1   会社ID kaisha_id 会社を表すID
2   アクセスキー access_key APIを認証するためのアクセスキー
3   オーダーNo order_no すでに存在する場合更新、新規の場合INSERT
4   購入日時 purchase_date 購入日時(YYYYMMDDHHMMSS)
5   支払方法区分 payment_kbn 0:銀行振込 1:クレジット 2:コンビニ決済 3:バーチャル口座
6   商品ID product_id 商品を一意で表すID
7   割引金額 discount_price キャンペーンやクーポンで割引された金額
8   合計金額 total_price 割引適用後の最終合計金額
9   入金金額 payment_amount 入金金額
10   入金確認日時 payment_date 最後の入金が確認された日時(YYYYMMDDHHMMSS)  
11   キャンペーンNo campaign_no    
12   クーポンNo coupon_no    
13   クーポンコード coupon_code クーポンNoが挿入されている場合必須
14   自由記入欄1 free_field1 自由に備忘として使える項目(200文字)  
15   自由記入欄2 free_field2 自由に備忘として使える項目(200文字)  
16   自由記入欄3 free_field3 自由に備忘として使える項目(200文字)  
17   自由記入欄4 free_field4 自由に備忘として使える項目(200文字)  
18   自由記入欄5 free_field5 自由に備忘として使える項目(200文字)  
19   ステータス order_status 1:未入金 2:入金不足 3:入金超過 4:入金完了 9:キャンセル
20   商品明細リスト purchase_list 必ず1行は必須
  20-1 商品明細ID purchase_id 購入した商品の明細ID。実際には、商品に紐づく「講座」「講座グループ」「カリキュラム」のどれかの値になる
  20-2 購入商品区分 purchase_type_kbn 0:講座 1:講座グループ 2:カリキュラム
21   受講者明細リスト userInfo_list 必ず1行は必須
  21-1 受講者ID userid 購入者の受講者ID
  21-2 代表者フラグ rep_flg 単品販売または、一括販売で代表者の場合は1 他は0

OUTPUT

No 項目名 項目ID 項目説明
1   実行フラグ exec_flg 1:正常 9:エラー
2   エラータイプ error_type 実行フラグ=エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。
3   エラーメッセージ error_msg エラーごとに発生するメッセージ
4   エラー情報 error_info 各項目ごとのエラーメッセージを表示(登録に失敗したケース)

エラー

エラータイプ エラー概要 発生させるメッセージ 発生させるException
0 アクセスキー不適合エラー アクセスキーが適合しません。 AccessKeyException
1 ホスト許可エラー 対象のホストからのAPI実行を許可していません。 HostRestrictException
2 引数エラー 呼出パラメータが不足しているため実行できません。 CallParameterException
3 登録エラー 登録が失敗しました AddDataException
9 システムメンテナンスエラー 現在システムのメンテナンス中です。YYYY/MM/DD HH - HH の間システムをご利用できません。ご不便おかけし申し訳ございません。 SystemMaintenanceException

4.実装例

-lms-他システム連携/API

Copyright© E-learning ASP V6 利用マニュアル , 2021 All Rights Reserved Powered by STINGER.