商品検索API
商品検索APIとは、coneco.netでの商品の情報を取得するAPIです。
coneco.netでの/SpecList/カテゴリID/のページに相当し、 カテゴリIDごとの商品の一覧や、商品名での商品の検索を行うことが出来ます。
リクエストURL
- XML形式
- http://api.coneco.net/cws/v1/SearchProducts?apikey=***&categoryId=1011010
- JSON or JSONP形式
- http://api.coneco.net/cws/v1/SearchProducts_json?apikey=***&categoryId=1011010&callback=method
入力パラメータ
商品検索APIでの指定可能なパラメータの一覧です。
| 項目名 | フィールド名 | 型 | 必須 | デフォルト | 備考 |
|---|---|---|---|---|---|
| APIキー | apikey | String | ○ | - | 各ユーザごとのAPIキー |
| 商品ID | comId | integer | ※1 | - | coneco.net固有の商品のIDを表します。（「,」区切りで20個まで指定可能） |
| カテゴリID | categoryId | integer | ※1 | - | カテゴリ検索APIで取得したカテゴリを指定します。（categoryId=0で、全カテゴリを取得します。） |
| 商品名検索キーワード | keyword | String | ※1 | - | 商品名を指定して検索を行います。 複数キーワードのAND検索を行うには入力するには各キーワードごとに半角スペースを入れてください。 尚、商品名はUTF-8でURLエンコードされている必要があります。 |
フリーワード検索キーワード | freeword | String | ※1 | - | 商品名、型番、メーカー名等様々なキーワードから検索を行います。 conecoトップの検索窓から検索する感覚で使用することができます。 複数キーワードのAND検索を行うには入力するには各キーワードごとに半角スペースを入れてください。 尚、商品名はUTF-8でURLエンコードされている必要があります。 |
| or検索フラグ | orFlag | String | 0 | 半角スペースで区切られた各キーワードをorで検索します。（何も入れないとAND検索になります。） ※検索条件にkeywordを指定したときのみ有効。
|
|
| メーカー名 | maker | String | ※2 | - | メーカー名を指定して検索を行います。 尚、メーカー名はUTF-8でURLエンコードされている必要があります。 |
| ブランド名 | brand | String | ※2 | - | ブランド名を指定して検索を行います。 尚、ブランド名はUTF-8でURLエンコードされている必要があります。 |
| 取扱ショップの有無 | available | integer | 0 | 取り扱いショップが存在する商品のみを取得したい場合に使用します。
|
|
| 商品画像有無フラグ | imageFlag | integer | 0 | 商品画像が有る商品のみ取得したい場合に使用します。
|
|
| こねクリボーナス 対象フラグ | coneClick | integer | 0 | こねクリボーナス対象商品のみを抽出したい場合に使用します。
|
|
| 最大価格 | highestPrice | integer | - | 最安値の最大価格を指定します。 | |
| 最小価格 | lowestPrice | integer | - | 最安値の最小価格を指定します。 ※最大価格と最少価格を同時に指定する場合は「最大価格>=最小価格」で指定してください。 |
スペック検索ID | specId | integer | - | スペック検索情報取得APIにて得られたスペックIDを元に検索条件を指定する場合に使用します。 ・「,」区切りで複数のスペックを指定可能 ・検索条件に一致しないスペックにて検索を行いたい場合は、スペックIDの前に「-」をつけて検索ができます。 尚、スペック検索を行う際にはLevel3のカテゴリIDを指定する必要があります。 |
| ページ番号 | page | integer | ページ送りを行いたい場合に指定します。 | ||
| 表示件数 | count | integer | 20 | 1リクエストでの表示件数を指定します。（最大20件） | |
| ソート順 | sort | String | comId | 並び順を指定します。
|
|
| コールバック関数 | callback | String | JSONP形式の場合のみ使用する、コールバック関数を指定します。 |
※1.商品ID、カテゴリID、検索キーワードのうち、ひとつは必ず指定する必要があります。
※2.メーカー名、又は、ブランド名を指定する際はカテゴリIDが指定されている必要があります。メーカー名、ブランド名単独での検索できません。
出力パラメータ
商品検索API使用時の結果一覧です。
| 項目名 | フィールド名 | 型 | 備考 |
|---|---|---|---|
| 共通ヘッダ | |||
| APIバージョン | APIVersion | String | APIのバージョンを表します |
| ページ情報 | Page | 検索結果のページの情報を表します。 | |
| 該当件数 | Count | integer | 検索結果の該当件数を表します |
| 表示件数 | Size | integer | 1リクエスト当たりの表示件数を表します。（最大２０件） |
| 現在のページ数 | Current | integer | 検索結果の何ページ目かを表します。 |
| 総ページ数 | PageCount | integer | 検索結果の総ページ数を表します。 |
| 入力条件 | Condition | 入力条件より得られる情報を表します。 | |
| 入力カテゴリ | Category | 検索条件にカテゴリIDを指定した場合、そのカテゴリ自体の情報を表します。 | |
| カテゴリID | Id | integer | カテゴリIDを表します。 |
| カテゴリ名 | Name | String | カテゴリ名称を表します。 |
| 入力パラメータ | comId等 | String | 商品検索API呼び出し時の入力パラメータを表示します。 |
| 状態 | Status | String | APIの問合せ結果をメッセージで返します。 |
| サービス固有パラメータ | |||
| 商品ID | ComId | integer | coneco.net固有の商品のIDを表します。 |
| 商品名 | Name | String | coneco.netでの商品名を表します。 |
| 大カテゴリ | TopCategory | Level=1のカテゴリを表します。 | |
| カテゴリID | Id | integer | カテゴリIDを表します。 |
| カテゴリ名 | Name | String | カテゴリ名称を表します。 |
| カテゴリURL | Url | String | カテゴリごとのURLを表します。 |
| 中カテゴリ | MiddleCategory | Level=2のカテゴリを表します。 | |
| カテゴリID | Id | integer | カテゴリIDを表します。 |
| カテゴリ名 | Name | String | カテゴリ名称を表します。 |
| カテゴリURL | Url | String | カテゴリごとのURLを表します。 |
| カテゴリ | Category | Level=3のカテゴリを表します。 | |
| カテゴリID | Id | integer | カテゴリIDを表します。 |
| カテゴリ名 | Name | String | カテゴリ名称を表します。 |
| カテゴリURL | Url | String | カテゴリごとのURLを表します。 |
| 商品URL | Url | String | 商品ごとのURL |
| 商品画像URL | ImageUrl | String | 商品画像を表すURL |
| 商品画像URL（小） | SmallImageUrl | String | 商品画像を表すURL |
| 最安値 | LowestPrice | integer | 最安値を表します。 |
| 最高値 | HighestPrice | integer | 最高値を表します。 （※商品単体の最高値とは異なる場合が有ります。ex.セット販売等） |
| 平均価格 | AveragePrice | integer | 平均価格を表します。 |
| 取り扱いショップ数 | SellerCount | integer | 商品を取り扱っているショップ数を表します。 |
| ランキング順位 | Ranking | integer | coneco.netで取り扱っている全ての商品の中での、人気ランキングの順位を表します。 |
| メーカー名 | Manufacturer | String | 製造メーカーを表します。 |
| ブランド名 | Brand | String | ブランドを表します。 |
| 発売日 | ReleaseDate | String | |
| スペック一覧 | Specifications | ||
| スペック | Spec | String | title(属性)：商品のスペック名称を表します。 |
| String | 値：商品のスペック情報を表します。 | ||
| 商品説明 | Description | String | 製品の詳細な説明を表します。 |
| こねクリボーナス情報 ※1 | ConeClick | ||
| クリックボーナス | ClickBonus | integer | こねクリでのクリックボーナスを表します。 |
| ショップボーナス | ShopBonus | integer | こねくりでのショップクリックボーナスを表します。 |
| ボーナス付与期限 | BonusPeriod | String | こねクリでのボーナス付与期限を表します。 |
| レビューサマリ情報 | Review | ||
| レビュー数 | ReviewCount | integer | conecoクラブでのレビュー数を表します。 |
| レビュー一覧URL | ReviewListUrl | String | 該当商品のレビュー一覧ページのURLを表します。 |
| ブックマーク数 | BookmarkCount | integer | 該当商品がブックマークされている件数を表します。 |
| ブックマークユーザ一覧 | BookmarkUserListUrl | String | 該当商品をブックマークしているユーザ一覧ページのURLを表す。 |
| みんなの評価 | OverallRating | integer | レビュー評価の平均値を表します。 |
| 商品レビュー情報 | UserReview | 商品個別の商品レビュー（最新3件）を表示します。 | |
| レビューID | Id | integer | レビュー固有のIDを表します。 |
| ユーザID | UserId | integer | レビューを投稿したユーザのIDを表します。 |
| レビュータイトル | Summary | String | レビューのタイトルを表します。 |
| レビューURL | Url | String | レビューのURLを表します。 |
| ユーザページ | AuthorUrl | String | レビューを書いた人のconecoクラブでのマイページのURLを表します。 |
| 良い点 | Pros | String | 商品の良い点を表します。 |
| 悪い点 | Cons | String | 商品の悪い点を表します。 |
| 満足度 | OverallRating | integer | レビューごとの総合評価を表します。 |
| レビュー内容 | Description | String | レビュー本文を表します。（最大全角150文字） |
| 購入情報 | Purchase | ||
| 購入金額 | Price | int | ユーザがレビュー対象の商品を購入した金額を表します。 |
| 購入日時 | Date | String | ユーザがレビュー対象の商品を購入した日時を表します。 |
| 作成日 | Created | String | レビュー作成日時 |
| レビュー評価 | Ratings | ||
| 項目ごとの評価 | Rating | String | title(項目)：レビューごとの商品の評価項目を表します。 |
| String | 値：レビューごとの評価項目ごとの評価を5段階で表します。 | ||
※1. こねクリボーナスの詳細はこねクリ利用ガイド - ポイントについて＃クリックボーナスを参照してください。
サンプル出力
検索条件：カテゴリID「1011010」（デスクトップパソコン（Windows））に属する、商品の一覧を取得する。
http://api.coneco.net/cws/v1/SearchProducts?apikey=******&comId=1040908007
<?xml version="1.0" encoding="UTF-8"?>
<Items xmlns="http://api.coneco.net/cws/v1/">
<Header>
<APIVersion>1.6.0</APIVersion>
<Page>
<Count>1</Count>
<Size>1</Size>
<Current>1</Current>
<PageCount>1</PageCount>
</Page>
<Condition>
<comId>1040908007</comId>
<categoryId></categoryId>
</Condition>
<Status>Success</Status>
</Header>
<Item>
<ComId>1040908007</ComId>
<Name>Realforce101(PS/2) ML0100</Name>
<TopCategory>
<Id>1</Id>
<Name>パソコン・周辺機器</Name>
<Url>http://www.coneco.net/top_pchard.html</Url>
</TopCategory>
<MiddleCategory>
<Id>11060</Id>
<Name>入力機器</Name>
<Url>http://www.coneco.net/mid/11060.html</Url>
</MiddleCategory>
<Category>
<Id>1106010</Id>
<Name>キーボード</Name>
<Url>http://www.coneco.net/idx/01106010.html</Url>
</Category>
<Url>http://www.coneco.net/PriceList.asp?COM_ID=1040908007</Url>
<ImageUrl>http://img.coneco.net/co/1040908007.gif</ImageUrl>
<SmallImageUrl>http://img.coneco.net/co/s/1040908007s.gif</SmallImageUrl>
<LowestPrice>17204</LowestPrice>
<HighestPrice>21841</HighestPrice>
<AveragePrice>18294</AveragePrice>
<SellerCount>28</SellerCount>
<Ranking>11521</Ranking>
<Manufacturer>東プレ/Topre</Manufacturer>
<Brand>Realforce</Brand>
<ReleaseDate></ReleaseDate>
<Specifications>
<Spec title="インターフェイス">PS/2</Spec>
<Spec title="ワイヤレス">非対応</Spec>
<Spec title="マウス">なし</Spec>
</Specifications>
<Description></Description>
<ConeClick>
<ClickBonus></ClickBonus>
<ShopBonus></ShopBonus>
<BonusPeriod></BonusPeriod>
</ConeClick>
<Review>
<ReviewCount>1</ReviewCount>
<ReviewListUrl>http://www.coneco.net/ReviewList/1040908007/</ReviewListUrl>
<BookmarkCount>1</BookmarkCount>
<BookmarkUserListUrl>http://club.coneco.net/item/1040908007/bookmark_user/index.htm</BookmarkUserListUrl>
<OverallRating>5</OverallRating>
</Review>
<UserReviews>
<UserReview>
<Id>3</Id>
<UserId>19</UserId>
<Summary>最高のキーボード</Summary>
<Url>http://club.coneco.net/user/19/review/3/</Url>
<AuthorUrl>http://club.coneco.net/user/19/</AuthorUrl>
<Pros>打鍵感覚が非常に軽快</Pros>
<Cons>持ち運びには不向き(1.4Kg)</Cons>
<OverallRating>5</OverallRating>
<Description>最高級品質を誇るRealforceの英語キーボード版。正直、英語キーボードのテンキーレス版を
いつでるのか首を長くして2,3年待っていたのだが、転職をきっかけに購入。今までは、会社で初代HHKを使用していたが、
Realforceを購入後自宅でしばらく使おうかと思っていたが、ちょっと文章をRealfo</Description>
<Purchase>
<Price>18600</Price>
<Date>2006/11/10</Date>
</Purchase>
<Created>2006-12-14 18:32</Created>
<Ratings>
<Rating title="機能性">5</Rating>
<Rating title="耐久性">5</Rating>
<Rating title="使いやすさ">5</Rating>
<Rating title="デザイン">4</Rating>
<Rating title="価格">4</Rating>
</Ratings>
</UserReview>
</UserReviews>
</Item>
</Items>
