商品検索(v3)
商品検索はYahoo!ショッピングの商品検索結果を取得することが可能なAPIです。
デベロッパーは日本最大級の商品データベースからキーワードでの商品検索をはじめ、JANコード、ISBNコード、ジャンルカテゴリID、ブランドID、ストアIDでの商品検索を行い、JSON形式で各種商品情報を取得できます。
キャンペーン等の変更に伴い下記の項目を修正しました。
<現在>
hits/point/amount・・・ポイント数
hits/point/times・・・ポイント倍率
hits/point/premiumAmount・・・プレミアム会員向けのポイント数
hits/point/premiumTimes・・・プレミアム会員向けのポイント倍率
<修正後>
hits/point/amount・・・基本ポイント数 (Tポイント)
hits/point/times・・・基本ポイント倍率 (Tポイント)
hits/point/bonusAmount・・・ストアボーナス数 (PayPayボーナスライト)
hits/point/bonusTimes・・・ストアボーナス倍率 (PayPayボーナスライト)
hits/point/premiumAmount・・・プレミアム会員向けの基本ポイント数 (Tポイント)
hits/point/premiumTimes・・・プレミアム会員向けの基本ポイント倍率 (Tポイント)
hits/point/premiumBonusAmount・・・プレミアム会員向けのストアボーナス数 (PayPayボーナスライト)
hits/point/premiumBonusTimes・・・プレミアム会員向けのストアボーナス倍率 (PayPayボーナスライト)
リクエストURL
リクエストパラメータ
「RESTリクエストの構築(GET)」をご参照ください。
パラメータ | 必須 | 型 | デフォルト値 | 例 | 説明 |
---|---|---|---|---|---|
appid | 〇 | string | アプリケーションID | ||
affiliate_type | string | vc | バリューコマースアフィリエイト(vc)を選択 | ||
affiliate_id | string | バリューコマースアフィリエイトID | |||
query | string | UTF-8エンコードされた検索キーワード | |||
jan_code | string | 4905524535815 | JANコード | ||
isbn | string | 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 | 支払い方法 1:クレジットカード 2:銀行振込 4:商品代引 8:郵便振替 16:Yahoo!ウォレット登録済みクレジットカード 32:モバイルSuica 64:コンビニ 128:ペイジー 256:ドコモケータイ払い 512:auかんたん決済 1024:ソフトバンク・ワイモバイルまとめて支払い 4096:PayPay |
|||
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: 新品 |
都道府県コード
01:北海道
02:青森県、03:岩手県、04:宮城県、05:秋田県、06:山形県、07:福島県
08:茨城県、09:栃木県、10:群馬県、11:埼玉県、12:千葉県、13:東京都、14:神奈川県
15:新潟県、16:富山県、17:石川県、18:福井県、19:山梨県、20:長野県、21:岐阜県、22:静岡県、23:愛知県
24:三重県、25:滋賀県、26:京都府、27:大阪府、28:兵庫県、29:奈良県、30:和歌山県
31:鳥取県、32:島根県、33:岡山県、34:広島県、35:山口県
36:徳島県、37:香川県、38:愛媛県、39:高知県
40:福岡県、41:佐賀県、42:長崎県、43:熊本県、44:大分県、45:宮崎県、46:鹿児島県、47:沖縄県
サンプルリクエスト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/inStock | boolean | true:在庫ありのみ false:在庫なしのみ |
hits/url | string | 商品URL |
hits/code | string | 商品コード (seller_managed_item_id) |
hits/condition | string | new:新品 used:中古 |
hits/premiumPrice | integer | レミアム会員価格 |
hits/premiumDiscountType | string | プレミアム割引種別 normal:プレミアム会員価格と通常販売価格から算出 original:プレミアム会員価格とメーカー希望小売価格から算出 sale:セール価格と通常価格から算出 |
hits/premiumDiscountRate | integer | プレミアム割引率 |
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/priceLabel/taxable | boolean | 税込み価格かどうか |
hits/priceLabel/premiumPrice | 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 | 基本ポイント数 (Tポイント) |
hits/point/times | integer | 基本ポイント倍率 (Tポイント) |
hits/point/bonusAmount | integer | ストアボーナス数 (PayPayボーナスライト) |
hits/point/bonusTimes | integer | ストアボーナス倍率 (PayPayボーナスライト) |
hits/point/premiumAmount | integer | プレミアム会員向けの基本ポイント数 (Tポイント) |
hits/point/premiumTimes | integer | プレミアム会員向けの基本ポイント倍率 (Tポイント) |
hits/point/premiumBonusAmount | integer | プレミアム会員向けのストアボーナス数 (PayPayボーナスライト) |
hits/point/premiumBonusTimes | integer | プレミアム会員向けのストアボーナス倍率 (PayPayボーナスライト) |
hits/shipping | ||
hits/shipping/name | string | 名前(コードに紐づく名前) |
hits/shipping/code | integer | 送料条件コード 1:設定無し 2:送料無料 3:条件付き送料無料 |
hits/genreCategory | ||
hits/genreCategory/id | integer | ジャンルカテゴリID |
hits/genreCategory/name | string | ジャンルカテゴリ名 |
hits/genreCategory/depth | integer | ジャンルカテゴリの階層 |
hits/parentGenreCategories[](親ジャンルカテゴリ) | list | 親ジャンルカテゴリ |
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 | string | JANコード |
hits/isbn | string | ISBNコード |
hits/releaseDate | string | 発売日 |
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で既にAPIコール数制限緩和申請を頂いているアプリケーションIDについては、
新しい商品検索APIについても、利用対象となっており、追加のご申請は不要です。
詳細は、下記のお知らせをご覧ください。
旧商品検索APIをご利用中の皆様へ
利用約款
このAPIに関する利用約款はこちら。