ログイン
IDでもっと便利に[ 新規取得 ]

ショッピング

商品検索

Version 1

リクエストURL

XML

http://shopping.yahooapis.jp/ShoppingWebService/V1/itemSearch

PHPserialize

http://shopping.yahooapis.jp/ShoppingWebService/V1/php/itemSearch

JSONP

http://shopping.yahooapis.jp/ShoppingWebService/V1/json/itemSearch

商品検索はYahoo!ショッピングの商品検索結果を取得することが可能なAPIです。デベロッパーは日本最大級の商品データベース(約1,800万(約8,500カテゴリ))からキーワードでの商品検索をはじめ、JANコード、ISBNコード、カテゴリID、製品ID、人物ID、ブランドID、ストアIDでの商品検索を行い、XMLおよびPHPserialize、JSONP形式で各種商品情報を取得できます。

リクエストパラメータ

RESTリクエストの構築(GET)」をご参照ください。

パラメータ 説明
appid
(必須)
string アプリケーションID。詳細はこちらをご覧ください。
affiliate_type yid/vc Yahoo! JAPANアフィリエイト(yid)とバリューコマースアフィリエイト(vc)の選択。
例:affiliate_type=yid
affiliate_id string Yahoo! JAPANアフィリエイトIDもしくは、バリューコマースアフィリエイトIDを入力。
callback string JSONPとして出力する際のコールバック関数名を入力する為のパラメータ。UTF-8でエンコードした文字列を入力する。
query
(※1必須)
string キーワード検索。(UTF-8エンコードされた文字列をご利用ください。)
例:query=vaio
type all(デフォルト)/any allは全クエリー文字を含む検索結果を返します。anyはクエリー文字のうちいずれかを含む検索結果を返します。
jan
(※1必須)
integer JANコードによって商品を検索。
isbn
(※1必須)
integer ISBNコード(書籍コード)によって商品を検索。
category_id
(※1必須)
integer カテゴリIDによる商品の絞り込み検索。
カテゴリIDリストは、カテゴリID取得APIによって取得していただけます。
product_id
(※1必須)
integer 製品IDによる商品検索。
※2
person_id
(※1必須)
integer 人物IDによる商品検索。
※2
brand_id
(※1必須)
integer ブランドIDによる商品検索。
※2
store_id
(※1必須)
string ストアのID指定検索。
http://store.shopping.yahoo.co.jp/○○○○/index.html の○○○○を指定して商品を検索。
price_from integer
(デフォルト:0)
価格指定(最低価格)した価格以上を検索する。
例:price_from=1000
price_to integer 価格指定(最高価格)した価格未満を検索する。
例:price_to=10000
hits integer
(デフォルト:20)
取得する検索結果数。デフォルトは20、最大値は50。
offset integer 何件目から表示させるか(1件目は0)の設定。
sort price/name/
score/sold/
affiliate/
review_count
(デフォルト:score)
price:商品価格
name:ストア名
score:おすすめ順
sold:売れ筋順
affiliate:アフィリエイト料率順
review_count:レビュー数順
これらを指定して並べ替えを行う。
デフォルトはおすすめ順(他 商品価格 ストア名 売上順 アフィリエイト料率順)−(降順)もしくは+(昇順)で並び順を指定。UTF-8にエンコードされている必要あり。
例:商品価格昇順 sort=%2Bprice
affiliate_from デフォルト:0.0 アフィリエイト料率指定(最低料率)した料率以上を検索する。
例:affiliate_from=2.5
affiliate_to デフォルト:100.0 アフィリエイト料率指定(最高料率)した料率未満を検索する。
例:affiliate_to=3.3
module priceranges/
subcategories
検索結果に含まれる、価格幅、サブカテゴリとサブカテゴリに含まれる商品数のリストを取得する。
例:module=subcategories 指定しない場合は無視。
availability 1 在庫絞り込み。
指定しない場合は在庫状況を無視。
例:在庫有 availability=1
discount 1 セール中商品絞り込み。
1以外の指定は無視。 discount=1
shipping 1 デフォルトは設定なし。 shipping=1が送料無料。

サンプルリクエストURL

http://shopping.yahooapis.jp/ShoppingWebService/V1/itemSearch?appid=<あなたのアプリケーションID>&query=vaio

レスポンスフィールド

商品検索Web APIのスキーマの記述は、以下のURLをご覧ください。
http://shopping.yahooapis.jp/ShoppingWebService/V1/itemSearch.xsd

フィールド 説明
ResultSet クエリーレスポンスのすべてを含み、次の属性を持ちます。

  • totalResultsAvailable:検索数HIT数
  • totalResultsReturned:返された値の個数
  • firstResultPosition:最初のデータが何個目にあたるか(最初=1)

Query 検索ワード
Hit 検索された結果

  • index:検索結果の順番

Url 商品URL
Name 商品名
Description 商品説明
Headline キャッチコピー
Availability 購入できるか
(instock/outofstock)
Code 商品コード
PersonId 人物ID
ProductId 製品ID
JanCode JANコード
IsbnCode ISBN(書籍コード)
Model 型番
Id ストアID
Url ストアURL
Name ストア名
IsBestStore ベストストアかどうか
(true/false)
Rate ストア評価【0.0-5.0】まで0.5刻み
Count 評価人数
Id 画像ID
Small 76×76サイズの画像URL
Medium 146×146サイズの画像URL
Id 画像ID
Medium 120×30サイズの画像URL
Rate アフィリエイト料率 0.1刻み
Count レビュー保持数
Rate レビュー平均評価
Url レビューページへのURL/アフィリエイトURL
Price 価格

  • currency:通貨

PriceLabel 表示価格

  • taxIncluded:税込み価格かどうか

FixedPrice 定価
SalePrice セール価格
Id 現在カテゴリIDまでのルートからのパス構造
Name ブランド名
Id 現在ブランドIDまでのルートからのパス構造
Amount ポイント数
Times ポイント倍率
Method 支払い情報
Code 1=クレジットカード、2=銀行振込、4=商品代引、8=郵便振替、16=Yahoo!ウォレット、 32=モバイルSuica、64=コンビニ支払い、128=ペイジー対応のbitwise論理和
例:クレジットカード支払い、銀行振込、商品代引のみ可能なストアの場合、1+2+4=7でエレメントには7がレスポンスされます。
Name クレジットカード、銀行振込、商品代引、郵便振替、Yahoo!ウォレット登録済クレジットカード、モバイルSuica、コンビニ支払い、ペイジー
Code 条件コード
1=設定なし
2=送料無料
3=条件付送料無料
Name テキストで以下のいずれかの値
設定なし/送料無料/条件付送料無料
From 最低価格
(module=pricerangesを指定したときのみ)
To 最高価格
(module=pricerangesを指定したときのみ)
Hits 検索結果に含まれるアイテム数
(module=pricerangesを指定したときのみ)
Id 親カテゴリID
(module=subcategoriesを指定したときのみ)
Name 親カテゴリ名
(module=subcategoriesを指定したときのみ)
Id 子カテゴリID
(module=subcategoriesを指定したときのみ)
Name 子カテゴリ名
(module=subcategoriesを指定したときのみ)
Hits カテゴリ以下アイテム数
(module=subcategoriesを指定したときのみ)

※1.リクエストの際にいずれかを指定する必要があります。
※2.製品ID、人物ID、ブランドIDは、商品検索APIの検索結果リストに含まれます。

サンプルレスポンス

以下は、vaioという語を含む商品情報のリクエストに対するレスポンスです。

エラー

商品検索Web APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を解除させていただきます。(無料)
まずはヘルプページのお問い合わせフォームからご相談ください。


開発者ブログ

Yahoo! JAPANのスタッフや著名なデベロッパーのブログを紹介しています。新しいサービスのアイデアにお役立てください。

開発者コミュニティ

Yahoo!グループに開発者のためのグループを用意しています。ほかのデベロッパーと交流し、質問やアイデアの共有にお役立てください。

法人デベロッパー専用お問い合わせ