バージョン:1.0
1.商品検索APIa.リクエストURL
http://api.kakaku.com/Ver1/ItemSearch.asp?パラメータ名=パラメータ値・・・
b.リクエストパラメータ
*Keywordの指定が必須となります。
| パラメータ名 | 説明 | ||||||||||||||||||
| Keyword | 検索したいキーワード | ||||||||||||||||||
| ResultSet | ヒットしたアイテムの取得したい属性をminiもしくはmediumで指定します。 mini/mediumに含まれる情報に関しては、リターンパラメータの項を参照ください。*指定のない場合はmediumとして検索されます | ||||||||||||||||||
| CategoryGroup | 検索対象のカテゴリを指定します。*指定の無い場合は全てのカテゴリから検索されます
|
||||||||||||||||||
| SortOrder | ソート並び順 pricerank :安い→高い -pricerank :高い→安い daterank :発売日順 (新しい→古い) popularityrank : 人気順 *指定し無い場合は、キーワードスコア順となります。 並び順の複数指定は、できません。 |
||||||||||||||||||
| PageNum | ページ番号
ItemSearchは、一度に5セットずつの検索結果を返すので、何ページ目の結果リストが欲しいのかを指定します。*指定の無い場合は1ページ目が検索されます 1200件を超えるページ指定はできません。1200件を超える場合は指定可能な最終ページが検索されます。 |
※リクエストは、SJISでURLエンコードしてください。
c.リターンパラメータ
ヒットした商品の情報をXML形式で返します。
| パラメータ名 | 説明 | データ型 | 対応ResultSet |
| NumOfResult | ヒットしたアイテムの数 0件の場合はエラーコード”ItemNotFound”を返します。 |
Integer | miniとmedium |
| ProductID | プロダクトID | String | miniとmedium |
| ProductName | 製品名 | String | miniとmedium |
| MakerName | メーカー名 | String | miniとmedium |
| CategoryName | カテゴリ名 (トップカテゴリ>サブカテゴリ) | String | mediumのみ |
| PvRanking | カテゴリ内での人気ランキング。 ランク外の場合は””(空文字)を返します。 |
Integer | mediumのみ |
| ImageUrl | イメージのURL | String | mediumのみ |
| ItemPageUrl | アイテムビューへのURL | String | miniとmedium |
| BbsPageUrl | クチコミ掲示板へのURL | String | miniとmedium |
| ReviewPageUrl | レビューページへのURL | String | miniとmedium |
| LowestPrice | 最安価格(税込み)。 価格登録の無い場合は””(空文字)を返します。 |
Integer | miniとmedium |
| NumOfBbs | クチコミ掲示板書込み数 | Integer | miniとmedium |
d.サンプル
リクエスト
http://api.kakaku.com/Ver1/ItemSearch.asp?Keyword=%83o%83C%83I& CategoryGroup=pc&ResultSet=medium&SortOrder=pricerank&PageNum=1
の場合。(KeyWordは、'バイオ'がSJISでエンコードされています)
http://api.kakaku.com/Ver1/ItemSearch.asp?Keyword=%83o%83C%83I& CategoryGroup=pc&ResultSet=medium&SortOrder=pricerank&PageNum=1
の場合。(KeyWordは、'バイオ'がSJISでエンコードされています)
結果
リクエスト
http://api.kakaku.com/Ver1/ItemSearch.asp?Keyword=%83o%83C%83I& CategoryGroup=pc&ResultSet=mini&SortOrder=-pricerank&PageNum=1
の場合。(KeyWordは、'バイオ'がSJISでエンコードされています)
http://api.kakaku.com/Ver1/ItemSearch.asp?Keyword=%83o%83C%83I& CategoryGroup=pc&ResultSet=mini&SortOrder=-pricerank&PageNum=1
の場合。(KeyWordは、'バイオ'がSJISでエンコードされています)
結果
e.エラー
| エラーコード | 内容 |
| ItemNotFound | 該当する商品がひとつもありませんでした。 |
| TooManyItemsRequested | 制限値を超えたアイテム数のリクエストがありました。 |
| InvalidParameterValue | パラメータの値が入っていないか、不正です。 |
| InternalServerError | サーバは、処理を完了できませんでした。 |
ItemNotFoundの場合
<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message>ItemNotFound</Message>
</Error>
TooManyItemsRequestedの場合
<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message>TooManyItemsRequested</Message>
</Error>
InvalidParameterValueの場合
<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message>InvalidParameterValue</Message>
</Error>
InternalServerErrorの場合
<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message>InternalServerError</Message>
</Error>

