lms-他システム連携/API

13-03-22.販売履歴個別取得API

更新日:

API名 販売履歴個別取得API
ID el_orderRireki_get_api

2.詳細解説

販売履歴情報を取得するAPIです。領収書URLの取得なども可能です。利用者の購入履歴の一覧を画面上に表示する際などに利用します。

$cstream->call_el_orderRireki_get_api($input_array);

3.I/O情報

INPUT

No 項目名 項目ID 項目説明 必須
1     会社ID kaisha_id 会社を表すID
2     アクセスキー access_key APIを認証するためのアクセスキー
3     受講者ID userid 受講者を表すID
4     購入日From purchase_date_from 商品を購入した日From(YYYYMMDD)  
5     購入日To purchase_date_to 商品を購入した日To(YYYYMMDD)  
6     オーダーNo order_no 27文字の注文No ※すべてのトランザクションで必ずユニークになる必要がある  
7 自由記入欄1 free_field1 履歴登録の際に自由に設定できる記入欄(完全一致)
8 自由記入欄2 free_field2 履歴登録の際に自由に設定できる記入欄(完全一致)
9 自由記入欄3 free_field3 履歴登録の際に自由に設定できる記入欄(完全一致)
10 自由記入欄4 free_field4 履歴登録の際に自由に設定できる記入欄(完全一致)
11 自由記入欄5 free_field5 履歴登録の際に自由に設定できる記入欄(完全一致)

OUTPUT

No 項目名 項目ID 項目説明
1     実行フラグ exec_flg 1:正常 9:エラー
2     エラータイプ error_type 実行フラグ=エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。
3     エラーメッセージ error_msg エラーごとに発生するメッセージ
4     エラー情報 error_info 各項目ごとのエラーメッセージを表示(登録に失敗したケース)
5     販売履歴リスト order_rireki_list 購入した商品のリスト
  5-1   オーダーNo order_no 27文字の注文No ※すべてのトランザクションで必ずユニークになる必要がある
  5-2   購入日時 purchase_date 購入日時(YYYYMMDDHHMMSS)
  5-3   支払方法区分 payment_kbn 0:銀行振込 1:クレジット 2:コンビニ決済 3:バーチャル口座
  5-4   商品ID product_id 商品を一意で表すID
  5-5   商品名 product_name 商品名
  5-6   割引金額 discount_price キャンペーンやクーポンで割引された金額
  5-7   合計金額 total_price 割引適用後の最終合計金額
  5-8   入金金額 payment_amount 入金金額
  5-9   入金確認日時 payment_date 最後の入金が確認された日時(YYYYMMDDHHMMSS)
  5-10   キャンペーンNo campaign_no  
  5-11   キャンペーン名称 campaign_name  
  5-12   クーポンNo coupon_no  
  5-13   クーポン名 coupon_name  
  5-14   クーポンコード coupon_code クーポンNoが挿入されている場合必須
  5-15   自由記入欄1 free_field1 自由に備忘として使える項目(200文字)
  5-16   自由記入欄2 free_field2 自由に備忘として使える項目(200文字)
  5-17   自由記入欄3 free_field3 自由に備忘として使える項目(200文字)
  5-18   自由記入欄4 free_field4 自由に備忘として使える項目(200文字)
  5-19   自由記入欄5 free_field5 自由に備忘として使える項目(200文字)
  5-20   ステータス order_status 1:未入金 2:入金不足 3:入金超過 4:入金完了 9:キャンセル
  5-21   商品明細リスト purchase_list 必ず1行は必須
    5-21-1 商品明細ID purchase_id  
    5-21-2 商品明細名 purchase_name  
    5-21-3 購入商品区分 purchase_type_kbn  
    5-21-4 購入数量 purchase_cnt  
    5-21-5 購入商品金額 purchase_price  
    5-21-6 明細金額 detail_price  
  5-22   受講者明細リスト userInfo_list 必ず1行は必須
    5-22-1 受講者ID userid 購入者の受講者ID
    5-22-2 受講者名 username 購入者の受講者名
    5-22-3 代表者フラグ rep_flg 単品販売または、一括販売で代表者の場合は1 他は0
5-23 領収書URL receipt_url 領収書を出力するためのURL

エラー

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

4.実装例

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

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