商品検索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エンコードされている必要があります。 |
| 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 | 商品画像が有る商品のみ取得したい場合に使用します。
|
|
| 最大価格 | highestPrice | integer | - | 最安値の最大価格を指定します。 | |
| 最小価格 | lowestPrice | integer | - | 最安値の最小価格を指定します。 ※最大価格と最少価格を同時に指定する場合は「最大価格>=最小価格」で指定してください。 |
|
| ページ番号 | 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リクエスト当たりの表示件数を表します。(最大20件) |
| 現在のページ数 | 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 | 最高値を表します。 |
| 平均価格 | AveragePrice | integer | 平均価格を表します。 |
| 取り扱いショップ数 | SellerCount | integer | 商品を取り扱っているショップ数を表します。 |
| ランキング順位 | Ranking | integer | coneco.netで取り扱っている全ての商品の中での、人気ランキングの順位を表します。 |
| メーカー名 | Manufacturer | String | 製造メーカーを表します。 |
| ブランド名 | Brand | String | ブランドを表します。 |
| 発売日 | ReleaseDate | String | |
| スペック一覧 | Specifications | ||
| スペック | Spec | String | title(属性):商品のスペック名称を表します。 |
| String | 値:商品のスペック情報を表します。 | ||
| 商品説明 | Description | String | 製品の詳細な説明を表します。 |
| レビュー数 | ReviewCount | integer | conecoクラブでのレビュー数を表します。 |
| レビュー一覧URL | ReviewListUrl | String | 該当商品のレビュー一覧ページのURLを表します。 |
| ブックマーク数 | BookmarkCount | integer | 該当商品がブックマークされている件数を表します。 |
| ブックマークユーザ一覧 | BookmarkUserListUrl | String | 該当商品をブックマークしているユーザ一覧ページのURLを表す。 |
| みんなの評価 | OverallRating | integer | レビュー評価の平均値を表します。 |
サンプル出力
検索条件:カテゴリID「1011010」(デスクトップパソコン(Windows))に属する、商品の一覧を取得する。
http://api.coneco.net/cws/v1/SearchProducts?apikey=******&categoryId=1011010&page=3&count=2
<?xml version="1.0" encoding="UTF-8"?>
<Items xmlns="http://api.coneco.net/cws/v1/">
<Header>
<APIVersion>1.4.7</APIVersion>
<Page>
<Count>4593</Count>
<Size>2</Size>
<Current>3</Current>
<PageCount>2297</PageCount>
</Page>
<Condition>
<Category>
<Level>3</Level>
<Id>1011010</Id>
<Name>デスクトップパソコン(Windows)</Name>
<Url>http://www.coneco.net/idx/01011010.html</Url>
</Category>
<page>3</page>
<count>2</count>
</Condition>
<Status>Success</Status>
</Header>
<Item>
<ComId>1080425149</ComId>
<Name>PC STATION BJ9716PB/20WA</Name>
<TopCategory>
<Id>1</Id>
<Name>パソコン・周辺機器</Name>
<Url>http://www.coneco.net/top_pchard.html</Url>
</TopCategory>
<MiddleCategory>
<Id>10110</Id>
<Name>デスクトップパソコン</Name>
<Url>http://www.coneco.net/mid/10110.html</Url>
</MiddleCategory>
<Category>
<Id>1011010</Id>
<Name>デスクトップパソコン(Windows)</Name>
<Url>http://www.coneco.net/idx/01011010.html</Url>
</Category>
<Url>http://www.coneco.net/PriceList.asp?COM_ID=1080425149</Url>
<ImageUrl>http://www.coneco.net/images/noimg.gif</ImageUrl>
<SmallImageUrl>http://www.coneco.net/images/noimg_s.gif</SmallImageUrl>
<LowestPrice></LowestPrice>
<HighestPrice></HighestPrice>
<AveragePrice></AveragePrice>
<SellerCount>0</SellerCount>
<Ranking>173471</Ranking>
<Manufacturer>ソーテック/SOTEC</Manufacturer>
<Brand>PC STATION</Brand>
<ReleaseDate>2008/05/02</ReleaseDate>
<Specifications>
<Spec title="CPUタイプ">Core 2 Duo</Spec>
<Spec title="ドライブ">DVDスーパーマルチ (DVD±R DL)</Spec>
<Spec title="CPUクロック">2.4GHz</Spec>
<Spec title="メモリ">2GB</Spec>
<Spec title="モニタ">20.1インチ</Spec>
</Specifications>
<Description></Description>
<Review>
<ReviewCount>0</ReviewCount>
<ReviewListUrl>http://www.coneco.net/ReviewList/1080425149/</ReviewListUrl>
<BookmarkCount>0</BookmarkCount>
<BookmarkUserListUrl></BookmarkUserListUrl>
<OverallRating></OverallRating>
</Review>
</Item>
<Item>
<ComId>1080425148</ComId>
<Name>PC STATION BJ9716P/20WA</Name>
<TopCategory>
<Id>1</Id>
<Name>パソコン・周辺機器</Name>
<Url>http://www.coneco.net/top_pchard.html</Url>
</TopCategory>
<MiddleCategory>
<Id>10110</Id>
<Name>デスクトップパソコン</Name>
<Url>http://www.coneco.net/mid/10110.html</Url>
</MiddleCategory>
<Category>
<Id>1011010</Id>
<Name>デスクトップパソコン(Windows)</Name>
<Url>http://www.coneco.net/idx/01011010.html</Url>
</Category>
<Url>http://www.coneco.net/PriceList.asp?COM_ID=1080425148</Url>
<ImageUrl>http://www.coneco.net/images/noimg.gif</ImageUrl>
<SmallImageUrl>http://www.coneco.net/images/noimg_s.gif</SmallImageUrl>
<LowestPrice></LowestPrice>
<HighestPrice></HighestPrice>
<AveragePrice></AveragePrice>
<SellerCount>0</SellerCount>
<Ranking>173471</Ranking>
<Manufacturer>ソーテック/SOTEC</Manufacturer>
<Brand>PC STATION</Brand>
<ReleaseDate>2008/05/02</ReleaseDate>
<Specifications>
<Spec title="CPUタイプ">Core 2 Duo</Spec>
<Spec title="ドライブ">DVDスーパーマルチ (DVD±R DL)</Spec>
<Spec title="CPUクロック">2.4GHz</Spec>
<Spec title="メモリ">2GB</Spec>
<Spec title="モニタ">20.1インチ</Spec>
</Specifications>
<Description></Description>
<Review>
<ReviewCount>0</ReviewCount>
<ReviewListUrl>http://www.coneco.net/ReviewList/1080425148/</ReviewListUrl>
<BookmarkCount>0</BookmarkCount>
<BookmarkUserListUrl></BookmarkUserListUrl>
<OverallRating></OverallRating>
</Review>
</Item>
</Items>


