ショッピング

商品検索(v3)

商品検索はYahoo!ショッピングの商品検索結果を取得することが可能なAPIです。
デベロッパーは日本最大級の商品データベースからキーワードでの商品検索をはじめ、JANコード、ISBNコード、ジャンルカテゴリID、ブランドID、ストアIDでの商品検索を行い、JSON形式で各種商品情報を取得できます。


リクエストURL

リクエストURL
JSON
https://shopping.yahooapis.jp/ShoppingWebService/V3/itemSearch
※JSONのみ

リクエストパラメータ

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

パラメータ 必須 デフォルト値 説明
appid string アプリケーションID
affiliate_type string vc バリューコマースアフィリエイト(vc)を選択
affiliate_id string バリューコマースアフィリエイトID
query string UTF-8エンコードされた検索キーワード
jan_code integer 4905524535815 JANコード
isbn integer ISBNコード
image_size intger 76 取得したい任意の画像サイズを指定できます。
指定する値と画像サイズ
76:76×76
106:106×106
132:132×132
146:146×146
300:300×300
600:600×600
genre_category_id integer 2495 ジャンルカテゴリID
カンマ区切りで複数指定できる
複数指定した場合はOR絞り込みになる
brand_id integer 149 ブランドID
カンマ区切りで複数指定できる
複数指定した場合はOR絞り込みになる
seller_id string ストアID
price_from integer 1000 商品価格 (下限) (下限は含む)
price_to integer 10000 商品価格 (上限) (上限は含む)
affiliate_rate_from float 10.0 アフィリエイト料率(下限)(下限は含む)
affiliate_rate_to float 20.0 アフィリエイト料率(上限)(上限は含む)
preorder boolean true 予約商品の指定
true:予約商品のみ
results integer 20 50 検索結果の返却数
start integer 1 31 返却結果の先頭位置
例)31件目から欲しい場合は「31 」
※start + resultsの合計は1,000が上限
in_stock boolean true 在庫有無
true:在庫ありのみ
false:在庫なしも含む
is_discounted boolean true セール対象商品に絞り込み
shipping string free 送料区分の指定
free:送料無料
conditional_free:条件付き送料無料
※複数指定によるOR検索可
payment string 支払い方法
ウォレット対応カード:yahoowallet
クレジットカード:creditcard
商品代引:cod
銀行振込:banktransfer
郵便振替:pmo
モバイルSuica:mobilesuica
ペイジー:payeasy
コンビニ:convenience
user_rank string guest diamond 指定すると会員属性に応じたポイント額を返します。
値:diamond/platinum/gold/silver/bronze/guest(デフォルト)
sale_end_from integer now 販売終了UNIX時間の下限
sale_end_to integer 販売終了UNIX時間の上限
sale_start_from integer 0 販売開始UNIX時間の下限
sale_start_to integer now + 7d 販売開始UNIX時間の上限
delivery_area string string 08 きょうつく、あすつく、翌々日配送の都道府県の指定
都道府県コードはこちらを参照
JIS都道府県コードに準拠するため、1桁の場合も頭に0を付けて2桁のstringで指定すること

※delivery_area, delivery_deadline, delivery_dayの3パラメータ全てが指定された場合にのみ絞り込みになる。
delivery_areaのみ指定した場合は、絞り込みはしないが、レスポンスのDelivery配下が指定した都道府県の情報になる。
delivery_day integer 0 あすつく、きょうつく、翌々日配送の指定
0:きょうつく
1:あすつく
2:翌々日配送
delivery_deadline integer 13 発送日の締め時間を指定
・24時間表記 (1〜24)で指定
 integerで指定(01のようなstringはNG)
 締め時間全てを指定する場合は1を指定 (1〜24)で全時間指定となる
・境界は含まれる
 例)15 → 15時〜24時が締め時間の当日配送可能商品で絞り込まれる
・99を指定した場合のみ現在時+1時間が入って絞りこまれる
 例)14時20分 → 15時, 15時00分 → 16時
sort string -score +price 並び順を指定
-score:おすすめ順
+price:価格の安い順
-price:価格の高い順
-review_count:商品レビュー数の多い順
※UTF-8にエンコードされている必要あり。
condition string new 商品状態の指定
used: 中古
new: 新品

サンプルリクエストURL

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



レスポンスフィールド

要素 説明
totalResultsAvailable integer 総検索ヒット件数
totalResultsReturned integer 返却された商品件数
firstResultsPosition integer 最初のデータが何件目にあたるか(最初=1)
request
request/query string 検索クエリ
hits
hits/index integer 検索結果の順番
hits/name string 商品名
hits/description string 商品説明
hits/headLine string キャッチコピー
hits/url string 商品URL
hits/code string 商品コード (seller_managed_item_id)
hits/imageId string 画像ID
hits/image
hits/image/small string 76×76サイズの画像URL
hits/image/medium string 146×146サイズの画像URL
hits/exImage
hits/exImage/url image_sizeで指定した画像サイズの画像URL
hits/exImage/width image_sizeで指定した画像の幅
hits/exImage/height image_sizeで指定した画像の高さ
hits/review
hits/review/rate float レビュー平均
hits/review/count integer レビュー件数
hits/review/url string レビューページURL
hits/affiliateRate float アフィリエイト料率(0.1刻み)
hits/price integer 価格
hits/priceLabel
hits/priceLabe/taxable boolean 税込み価格かどうか
hits/priceLabel/defaultPrice integer 通常価格
hits/priceLabel/discountedPrice integer セール価格
hits/priceLabel/fixedPrice integer 定価(メーカー小売希望価格)
hits/priceLabel/periodStart integer セール期間開始日時(タイムスタンプ)
hits/priceLabel/periodEnd integer セール期間終了日時(タイムスタンプ)
hits/point
hits/point/amount integer ポイント数
hits/point/times integer ポイント倍率
hits/shipping
hits/shipping/code integer 送料条件コード
1:設定無し
2:送料無料
3:条件付き送料無料
hits/genreCategory
hits/genreCategory/id integer ジャンルカテゴリID
hits/genreCategory/name string ジャンルカテゴリ名
hits/genreCategory/depth integer ジャンルカテゴリの階層
hits/parentGenreCategories(親ジャンルカテゴリ)
hits/parentGenreCategories/depth integer ジャンルカテゴリの階層
hits/parentGenreCategories/id integer 上位ジャンルカテゴリID
hits/parentGenreCategories/name string 上位ジャンルカテゴリ名
hits/brand(ブランド)
hits/brand/id integer ブランドID
hits/brand/name string ブランド名
hits/parentBrands[] list 親ブランド
hits/parentBrands/id integer ブランドID
hits/parentBrands/name string ブランド名
hits/janCode integer JANコード
hits/isbn integer ISBNコード
hits/releaseDate 発売日
hits/seller
hits/seller/sellerId string ストアID
hits/seller/name string ストア名
hits/seller/url string ストアURL
hits/seller/isBestSeller boolean ベストストアかどうか
true:ベストストアである
false:ベストストアではない
hits/seller/isPMallSeller boolean PayPayモール 出店ストアかどうか
true:出店している
false:出店していない
hits/seller/payment string 支払いコード
hits/seller/review
hits/seller/review/rate float ストアレビュー平均
hits/seller/review/count integer ストアレビュー件数
hits/seller/imageId string ストア画像ID
hits/delivery
hits/delivery/area string 都道府県コード 01 ~ 47
hits/delivery/deadLine integer 注文締め時間 1 ~ 24
hits/delivery/day integer 配送にかかる日数
0:きょうつく
1:あすつく



サンプルレスポンス

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

{"totalResultsAvailable":513766,"totalResultsReturned":1,"firstResultPosition":1,"request":{"query":"nike"},"hits":[{"index":1,"name":"<NIKE(ナイキ)>WOMENS AIR RIFT エアリフト","description":"ZOZO問い合わせ番号:53582864<br>ショップ:BEAUTY&YOUTH UNITED ARROWS,ビューティ&ユース ユナイテッドアローズ<br>ブランド:NIKE,ナイキ,BEAUTY&YOUTH UNITED ARROWS,ビューティアンドユースユナイテッドアローズ<br>商品名:<NIKE(ナイキ)>WOMENS AIR RIFT エアリフト<br>カテゴリ:シューズ>スニーカー<br>ブランド品番:18314996331<br>素材:-<br>カラー:ホワイト,ブラック<br>サイズ:23cm,24cm,25cm,26cm","headLine":"","url":"https:\/\/store.shopping.yahoo.co.jp\/zozo\/52582864.html","inStock":true,"code":"zozo_52582864","condition":"new","imageId":"zozo_52582864","image":{"small":"https:\/\/item-shopping.c.yimg.jp\/i\/c\/zozo_52582864","medium":"https:\/\/item-shopping.c.yimg.jp\/i\/g\/zozo_52582864"},"review":{"rate":0,"count":0,"url":"https:\/\/shopping.yahoo.co.jp\/review\/item\/list?store_id=zozo&page_key=52582864"},"affiliateRate":1,"price":10450,"premiumPrice":10450,"premiumPriceStatus":false,"premiumDiscountType":null,"premiumDiscountRate":null,"priceLabel":{"taxable":null,"defaultPrice":10450,"discountedPrice":null,"fixedPrice":null,"premiumPrice":null,"periodStart":null,"periodEnd":null},"point":{"amount":104,"times":1,"premiumAmount":104,"premiumTimes":1},"shipping":{"code":1,"name":"設定なし"},"genreCategory":{"id":23699,"name":"レディーススニーカー","depth":4},"parentGenreCategories":[{"depth":1,"id":13457,"name":"ファッション"},{"depth":2,"id":2494,"name":"レディースファッション"},{"depth":3,"id":1729,"name":"レディースシューズ"}],"brand":{"id":1319,"name":"NIKE"},"parentBrands":[{"id":1,"name":"ブランド"}],"janCode":"","isbn":"","releaseDate":null,"seller":{"sellerId":"zozo","name":"ZOZOTOWN","url":"https:\/\/paypaymall.yahoo.co.jp\/store\/zozo\/top\/","isBestSeller":false,"isPMallSeller":true,"payment":"1 4 16 4096","review":{"rate":4.41,"count":5855},"imageId":"zozo_1"},"delivery":{"area":"","deadLine":null,"day":null}}]}



エラー

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




利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を緩和させていただきます。(無料)
申請受付は停止中です。
1日50,000リクエストを超える場合は、アプリケーションIDを追加してご対応ください。

利用約款

このAPIに関する利用約款はこちら