■ EC-CUBE商品検索APIモジュールのダウンロード

【EC-CUBE商品検索APIとは】

EC-CUBE商品検索APIは、EC-CUBEサイトの商品の情報やカテゴリ情報等を取得し、外部サービスやブログパーツ等へ連動表示することを可能にするAPIモジュールです。ダウンロード・設定頂ければ情報を簡単に取得することができますので、是非、新しいサイトや既存サービスのコンテンツとしてご活用下さい。

【ダウンロード】

【EC-CUBE Ver2.4系用 APIモジュール】

【EC-CUBE Ver2.11系用 APIモジュール】



[ eccube-api-2.4_01.zip ]


[ eccube_api-2.11_01.zip ]

■ EC-CUBE商品検索APIの利用方法

ダウンロードしたファイルを解凍し、中のファイルをお客様のEC-CUBEのプロジェクトにアップロードしてください。
ダウンロードしたフォルダはEC-CUBEのフォルダ構成と同じになっていますので、同じ階層に正しくアップロードしてください。

【システム要件】 PHP5.2以上にてご利用下さい。

【確認環境】
  ・ 2.11 系 ⇒ EC-CUBE 2.11.1で検証済み
  ・ 2.4 系 ⇒ EC-CUBE 2.4.4で検証済み
  ※上記環境で検証しておりますが、全てのバージョンで動作を保障するものではございません。

【ご利用に関する注意事項】

本モジュールを利用しての如何なる障害、またそれによる損失・損害に対しても当方は責任を負い兼ねます。
自己責任をご了承の上使用下さい。

■ リクエストURL

http://[EC-CUBEパス]/api/?[parameter]=[value]…
http://api.[EC-CUBEパス]/rws/3.0/json?[parameter]=[value]…

※JSONP形式は、JSON形式で入力パラメーターにcallbackを指定することで出力されます。

フィールド名keyword, sortに対応する[value]はUTF-8でURLエンコードされている必要があります。(リクエストURL全体をエンコードするのではなく、[value]部分を個別にエンコードしてください。)
たとえば、「おなべ」という商品名で検索し、結果を価格が安い順に並べたい(sort=+price)場合のリクエストURLは下記になります。(実際には改行せずに1行につなげてリクエストしてください。)

http://[ドメイン名]/api/?
action=itemsearch
&keyword=%e3%81%8a%e3%81%aa%e3%81%b9
&sort=%2price

■ リクエストパラメータ

EC-CUBE商品検索API 入力パラメータ (β版)
項目名 パラメータ名
(括弧内は
最大
バイト数)
必須 デフォルト 備考
操作 action String 使用するAPIの操作名:
itemsearch
出力形式 format String - jsonp レスポンスの出力形式:
xml
json
jsonp
php
コールバック関数名 callback String - callback JSONPとして出力する際のコールバック関数名
(UTF-8でURLエンコードした文字列)
商品名 name String - 指定なし UTF-8でURLエンコードした文字列
カテゴリID category_id int(9) - 指定なし 商品カテゴリを特定するためのID
       
商品コード product_code String - 指定なし 商品を特定するための商品コード
       
商品ID product_id String - 指定なし EC-CUBEで自動で割り当てられる商品ID
       
表示件数 page_max int(2) - 10 1ページあたりの表示件数
1から99までの整数
ページ送り番号 pageno int(9) - 1 1から999999999までの整数
ソート sort String - 指定なし +price:
+price:
価格順(昇順)
-price:
価格順(降順)
+date:
商品登録日時順(昇順)
-date:
商品登録日時順(降順)
※UTF-8でURLエンコードされている必要があります。
ステータス status int(1) - 指定なし
1:NEW
2:残りわずか
3:ポイント2倍
4:オススメ
5:限定品

■ リターンパラメータ


EC-CUBE商品検索API(itemsearch) リターンパラメータ(β版)
親要素 項目名 パラメータ名 備考
request [リクエストパラメータ名] リクエストされた各項目とその値
navi 検索数 total 検索結果の総商品数
ページ番号 current 現在のページ番号
前ページ番号 before 前ページのページ番号
次ページ番号 next 次ページのページ番号
ページ送り番号 page_number ページ送り用のページ番号の配列
最終ページ番号 last 最終ページのページ番号
items
(全体:<items> ~ </items> 、個別商品:<item> ~ </item>)
商品ID product_id  
商品コード(最小) product_code_min  
商品コード(最大) product_code_max  
商品名 name  
一覧メインコメント main_list_comment 商品一覧用のメインコメント
一覧メイン画像 main_list_image 商品一覧用の画像のURL
(画像サイズ130px*130px)
詳細メイン画像 main_list_image 商品詳細画面用の画像のURL
(画像サイズ260px*260px)
最小通常価格 price01_min 規格違いがある場合、その中での通常価格の最小
最大通常価格 price01_max 規格違いがある場合、その中での通常価格の最大
最小販売価格 price02_min 規格違いがある場合、その中での販売価格の最小
最大販売価格 price02_max 規格違いがある場合、その中での販売価格の最大
最小在庫数 stock_min 規格違いがある場合、その中での在庫の最小
最大在庫数 stock_max 規格違いがある場合、その中での在庫の最大
最小在庫無制限フラグ/font> stock_unlimited_min 規格違いがある場合、その中での最小在庫無制限フラグの最小
最大在庫無制限フラグ stock_unlimited_max 規格違いがある場合、その中での在庫無制限フラグの最大
発送目安ID deliv_date_id
発送目安を表すID:
1:即日
2:1~2日後
3:3~4日後
4:1週間以降
5:2週間以降
6:3週間以降
7:1ヶ月以降
8:2ヶ月以降
9:お取り寄せ
ステータスID status
1:NEW
2:残りわずか
3:ポイント2倍
4:オススメ
5:限定品

更新日時 update_date
詳細ページURL detail_page_url  
 【お問い合わせ】
   株式会社DreamBridge
   お問合せ窓口(システム開発部)
   TEL:06-4302-5202 FAX:06-4302-4077
   E-mail:info@dreambridge.co.jp


▲ PAGE TOP