lms-他システム連携/API

13-03-17.商品情報取得API

更新日:

API名 商品情報取得API
ID el_productInfo_get_api

2.詳細解説

商品情報を取得するAPIです。商品に紐づく講座等(講座グループ、カリキュラム含む)のリストも取得可能です。申込決済画面などを作成する場合、料金や適用クーポン、キャンペーンなどの情報を取得する必要があるため、一番最初に呼び出されるAPIです。

$cstream->call_el_productInfo_get_api($input_array);

3.I/O情報

INPUT

No 項目名 項目ID 項目説明 必須
1   会社ID kaisha_id 会社を表すID
2   アクセスキー access_key APIを認証するためのアクセスキー
3   商品ID product_id 商品ID

OUTPUT

No 項目名 項目ID 項目説明
1   実行フラグ exec_flg 1:正常 9:エラー
2   エラータイプ error_type 実行フラグ=エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。
3   エラーメッセージ error_msg エラーごとに発生するメッセージ
4   エラー情報 error_info エラーメッセージを表示(登録に失敗したケース)
5   商品ID product_id  
6   商品名 product_name  
7   販売種別 sales_type  
8   有効期間from valid_date_from  
9   有効期間to valid_date_to  
10   支払方法フラグ_銀行 payment_flg_furikomi  
11   支払方法フラグ_クレジット payment_flg_credit  
12   支払方法フラグ_コンビニ payment_flg_conveni  
13   税込料金 price_intax  
14   商品画像URL product_pic_url  
15   備考 bikou  
16   無料新規申込時メッセージID free_ap_new_message_id  
17   銀行振込新規申込時メッセージID bank_ap_new_message_id  
18   クレジット新規申込時メッセージID credit_ap_new_message_id  
19   コンビニ決済新規申込時メッセージID conveni_ap_new_message_id  
20   無料既存申込時メッセージID free_ap_kizon_message_id  
21   銀行振込既存申込時メッセージID bank_ap_kizon_message_id  
22   クレジット既存申込時メッセージID credit_ap_kizon_message_id  
23   コンビニ決済既存申込時メッセージID conveni_ap_kizon_message_id  
24   一括申込時受講者通知メッセージID lotsell_ap_user_tuuchi_message_id  
25   商品ステータス product_status  
26   連携項目1 api_val_product1  
27   連携項目2 api_val_product2  
28   連携項目3 api_val_product3  
29   連携項目4 api_val_product4  
30   連携項目5 api_val_product5  
連携項目6 api_val_product6
連携項目7 api_val_product7
連携項目8 api_val_product8
連携項目9 api_val_product9
連携項目10 api_val_product10
31   商品明細リスト productMeisai_list  
  31-1 購入商品区分 purchase_type_kbn 0:講座 1:講座グループ 2:カリキュラム
  31-2 購入商品ID purchase_id 講座、講座グループ、カリキュラムを一意に判別するID
  31-3 購入商品名 purchase_name          
  31-4 受講期限From attend_enddate_from 当該商品を購入した際の受講期限日From(YYYYMMDD)
  31-5 受講期限To attend_enddate_to 当該商品を購入した際の受講期限日To(YYYYMMDD)
32   適用クーポン情報リスト product_coupon_list  
  32-1 クーポンNo coupon_no  
  32-2 クーポン名 coupon_name  
  32-3 割引種類 discount_type 1:金額 2:比率
  32-4 割引金額 discount_price  
  32-5 割引率 discount_rate  
  32-6 有効期限From expired_date_from  
  32-7 有効期限To expired_date_to  
  32-8 クーポンコード再利用許可フラグ coupon_code_reuse_kyoka_flg 1つのクーポンコードを複数人で利用していい場合は1 それ以外は0
  32-9 クーポン解説 coupon_comment  
33   適用キャンペーン情報リスト product_campaign_list  
  33-1 キャンペーンNo campaign_no  
  33-2 キャンペーン名 campaign_name  
  33-3 割引種類 discount_type 1:金額 2:比率
  33-4 割引金額 discount_price  
  33-5 割引率 discount_rate  
  33-6 有効期限From expired_date_from  
  33-7 有効期限To expired_date_to  
  33-8 キャンペーン解説 campaign_comment  
  33-9 キャンペーン対象者制限フラグ campaign_target_limit_flg 0:制限しない 1:制限する
  33-10 対象者制限_新規/既存区分 target_limit_new_or_not_kbn 0:制限しない 1:新規申込 2:既存受講者の申込
  33-11 対象者制限_購入回数区分 target_limit_purchase_cnt_kbn 0:制限しない 1:初回購入のみ 2:2回目以降の購入のみ
  33-12 対象者制限_商品ID target_limit_product_id すでに当該商品IDを購入したことのある受講者のみをキャンペーン対象とする場合、当該商品IDを挿入
  33-13 対象者制限_総額制限区分 target_limit_sum_kbn 0:制限しない 1:制限する
  33-14 対象者制限_適用金額 target_limit_sum 総額制限を設けている場合、いくら以上の金額の場合にキャンペーンを適用するのか、その金額
  33-15 対象者制限_総数制限区分 target_limit_amount_kbn 0:制限しない 1:制限する
  33-16 対象者制限_適用数量 target_limit_amount 数量制限を設けている場合、何個以上の購入の場合にキャンペーンを適用するのか、その数量
  33-17 キャンペーンステータス campaign_status 0:設定未了 1:有効 9:停止

処理概要

【共通処理】
INPUTの引数が不足していないかチェック⇒不足していたらエラー
取得したINPUTからAPI情報Tを取得→取得できなかったらエラー
呼出元ホストがAPI情報Tに指定されたものか?⇒違う場合エラー

エラー

エラータイプ エラー概要 発生させるメッセージ 発生させる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.