ショッピング

商品コード検索(商品詳細)

リクエストURL
XML
http://shopping.yahooapis.jp/ShoppingWebService/V1/itemLookup
PHPserialize
http://shopping.yahooapis.jp/ShoppingWebService/V1/php/itemLookup
JSONP
http://shopping.yahooapis.jp/ShoppingWebService/V1/json/itemLookup

各ストアの商品がもつユニークなコード(商品コード)をキーに個別の商品情報を取得するためのAPIです(商品コードは商品検索およびカテゴリランキングのレスポンスフィールドCodeに含まれます)。

リクエストパラメータ

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

パラメータ 説明
appid
(必須)
string アプリケーションID。詳細はこちらをご覧ください。
affiliate_type vc バリューコマースアフィリエイト(vc)を選択。
例:affiliate_type=vc
affiliate_id string バリューコマースアフィリエイトIDを入力。
callback string JSONPとして出力する際のコールバック関数名を入力するためのパラメータ。UTF-8でエンコードした文字列を入力する。
itemcode
(必須)
string 商品コード(商品検索APIおよびカテゴリランキングAPIの結果リストのCodeタグに含まれる、商品固有のコード。ストアID_ストア商品コードの組み合わせ)
responsegroup small/medium/large デフォルトはsmall。
取得できるデータのサイズを指定できる。smallが最小、最速です。詳細はレスポンスフィールドに記載があります。
image_size 76/106/132/146/300/600 取得したい任意の画像サイズを指定できます。
指定する値と画像サイズ
 76:76×76
 106:106×106
 132:132×132
 146:146×146
 300:300×300
 600:600×600
license diamond/platinum/gold/silver/bronze/guest(デフォルト) スタンプラリーの会員ランクを指定すると、それに応じたポイントを返します。デフォルトはguest。(responsegroupがmedium以上で有効)

サンプルリクエストURL

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


レスポンスフィールド

商品コード検索(商品詳細)APIのスキーマの記述は、以下になります。

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

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

/ResultSet/Result/ItemCode/Codes/Code(small) リクエストした商品コード
/ResultSet/Result/Hit(small) 検索された結果

  • index:検索結果の順番

/ResultSet/Result/Hit/Code(medium) 商品コード
/ResultSet/Result/Hit/Name(small) 商品名
/ResultSet/Result/Hit/Url(small) 商品URL
/ResultSet/Result/Hit/Headline(small) キャッチコピー
/ResultSet/Result/Hit/Description(medium) 商品説明
/ResultSet/Result/Hit/ProductCategory/Id(large) プロダクトカテゴリID
/ResultSet/Result/Hit/JanCode(medium) JANコード
/ResultSet/Result/Hit/Image/Id(small) 画像ID(メイン画像)
/ResultSet/Result/Hit/Image/Small(small) 76×76サイズの商品画像URL(メイン画像)
/ResultSet/Result/Hit/Image/Medium(medium) 146×146サイズの画像URL(メイン画像)
/ResultSet/Result/Hit/RelatedImages/Image/Id(large) 画像ID(詳細画像)
/ResultSet/Result/Hit/RelatedImages/Image/Small(large) 76*76サイズの画像URL(詳細画像)
/ResultSet/Result/Hit/RelatedImages/Image/Medium(large) 146*146サイズの画像URL(詳細画像)
/ResultSet/Result/Hit/ExImage/Url image_sizeで指定したサイズの画像URL
/ResultSet/Result/Hit/ExImage/Width image_sizeで指定した画像の幅
/ResultSet/Result/Hit/ExImage/Height image_sizeで指定した画像の高さ
/ResultSet/Result/Hit/Review/Rate(medium) レビュー平均評価
/ResultSet/Result/Hit/Review/Count(medium) レビュー保持数
/ResultSet/Result/Hit/Review/Url(medium) レビューページへのURL/アフィリエイトURL
/ResultSet/Result/Hit/Price(small) 価格

  • currency:通貨

/ResultSet/Result/Hit/PriceLabel(small) 価格情報です。

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

false=本体価格
true=税込み価格
/ResultSet/Result/Hit/PriceLabel/FixedPrice(small) メーカー希望小売価格
/ResultSet/Result/Hit/PriceLabel/DefaultPrice(small) 通常販売価格
/ResultSet/Result/Hit/PriceLabel/SalePrice(small) 特価(セール)
/ResultSet/Result/Hit/PriceLabel/BaseFixedPrice (small) 税抜きメーカー希望小売価格
/ResultSet/Result/Hit/PriceLabel/BaseDefaultPrice (small) 税抜き通常販売価格
/ResultSet/Result/Hit/PriceLabel/BaseSalePrice (small) 税抜き特価(セール)
/ResultSet/Result/Hit/PriceLabel/PeriodStart(small) セール期間開始日時(RFC3339)
/ResultSet/Result/Hit/PriceLabel/PeriodEnd(small) セール期間終了日時(RFC3339)
/ResultSet/Result/Hit/PriceLabel/SaleLimit(large) 販売個数制限(指定されていない場合は空)
/ResultSet/Result/Hit/PriceLabel/Inventiries/Inventory/Quantity(large) 在庫数(在庫数が無限大の場合は空)
/ResultSet/Result/Hit/PriceLabel/Inventiries/Inventory/AllowOverdraft(large) 超過購入設定
0:超過購入不可能
1:超過購入可能
/ResultSet/Result/Hit/Point/Amount(medium) ポイント数(ポイント倍率をかけた後の値)
/ResultSet/Result/Hit/Point/Times(medium) ポイント倍率
/ResultSet/Result/Hit/Point/PremiumAmount(medium) プレミアム会員時のポイント数(プレミアム会員時のポイント倍率をかけた後の値)
/ResultSet/Result/Hit/Point/PremiumTimes(medium) プレミアム会員時のポイント倍率
/ResultSet/Result/Hit/Payment/Method(large) 支払い情報です。
/ResultSet/Result/Hit/Payment/Method/Code(large) 1=クレジットカード、2=銀行振込、4=商品代引、8=郵便振替、16=Yahoo!ウォレット、32=モバイルSuica、64=コンビニ支払い、128=ペイジー(対応する決済方法をbitwise論理和で表記)
/ResultSet/Result/Hit/Payment/Method/Name(large) クレジットカード、銀行振込、商品代引、郵便振替、Yahoo!ウォレット登録のクレジットカード、モバイルSuica、コンビニ支払い、ペイジー
/ResultSet/Result/Hit/Shipping/Code(medium) 条件コード
1=設定なし
2=送料無料
3=条件付送料無料
/ResultSet/Result/Hit/Shipping/Name(medium) テキストで以下のいずれかの値
設定なし/送料無料/条件付送料無料
/ResultSet/Result/Hit/SpAdditional(large) スマホフリースペース
/ResultSet/Result/Hit/ReleaseDate(medium) 発売日
/ResultSet/Result/Hit/Store/Id(large) ストアID
/ResultSet/Result/Hit/Store/Name(large) ストア名
/ResultSet/Result/Hit/Store/SellerType 該当商品が事業者か個人のどちらで出品されたかを示します。
B=事業者ストア
C=個人ストア
/ResultSet/Result/Hit/Store/ToolType(large) ツールタイプ
1=プロフェッショナル出店の事業者ストア
2=ライト出店の事業者ストア
3=ライト出店の個人ストア
/ResultSet/Result/Hit/Store/Url(large) ストアURL
/ResultSet/Result/Hit/Store/Ratings/Rate(large) ストア評価【0.0-5.0】まで0.5刻み
ResultSet/Result/Hit/Store/Ratings/Rate(large) ストア評価【0.0-5.0】まで
/ResultSet/Result/Hit/Store/Ratings/Count(large) 評価人数
/ResultSet/Result/Hit/Store/Image/Id(large) ストア画像ID
/ResultSet/Result/Hit/Store/Image/Medium(large) 120×30サイズのストア画像URL
/ResultSet/Result/Hit/Store/SameDayDelivery(large) 当日配送(きょうつく)情報です。
/ResultSet/Result/Hit/Store/SameDayDelivery/Areas/Area(large) 当日配送(きょうつく)の配送地域
/ResultSet/Result/Hit/Store/SameDayDelivery/Areas/Area/Code(large) 当日配送(きょうつく)の配送地域コード(地方コードの説明参照※1)
/ResultSet/Result/Hit/Store/SameDayDelivery/Areas/Area/Name(large) 当日配送(きょうつく)の配送地域名(地方コードの説明参照※1)
/ResultSet/Result/Hit/Store/SameDayDelivery/Areas/Area/Prefectures(large) 当日配送(きょうつく)の都道府県情報です。
/ResultSet/Result/Hit/Store/SameDayDelivery/Areas/Area/Prefectures/Prefecture/Code(large) 当日配送(きょうつく)の都道府県コード(都道府県コードの説明参照※1)
/ResultSet/Result/Hit/Store/SameDayDelivery/Areas/Area/Prefectures/Prefecture/Name(large) 当日配送(きょうつく)の都道府県名(都道府県コードの説明参照※1)
/ResultSet/Result/Hit/Store/SameDayDelivery/Deadline(large) 当日配送(きょうつく)の対応時間です。
/ResultSet/Result/Hit/Store/SameDayDelivery/Conditions(large) 当日配送(きょうつく)の対応条件
/ResultSet/Result/Hit/Store/ExpressDelivery(large) 翌日配送(あすつく)情報です。
/ResultSet/Result/Hit/Store/ExpressDelivery/Areas/Area(large) 翌日配送(あすつく)の配送地域
/ResultSet/Result/Hit/Store/ExpressDelivery/Areas/Area/Code(large) 翌日配送(あすつく)の配送地域コード(地方コードの説明参照※1)
/ResultSet/Result/Hit/Store/ExpressDelivery/Areas/Area/Name(large) 翌日配送(あすつく)の配送地域名(地方コードの説明参照※1)
/ResultSet/Result/Hit/Store/ExpressDelivery/Areas/Area/Prefectures(large) 翌日配送(あすつく)の都道府県情報です。
/ResultSet/Result/Hit/Store/ExpressDelivery/Areas/Area/Prefectures/Prefecture/Code(large) 翌日配送(あすつく)の都道府県コード(都道府県コードの説明参照※1)
/ResultSet/Result/Hit/Store/ExpressDelivery/Areas/Area/Prefectures/Prefecture/Name(large) 翌日配送(あすつく)の都道府県名(都道府県コードの説明参照※1)
/ResultSet/Result/Hit/Store/ExpressDelivery/Deadline(large) 翌日配送(あすつく)の対応時間
/ResultSet/Result/Hit/Store/ExpressDelivery/Conditions(large) 翌日配送(あすつく)の対応条件
/ResultSet/Result/Hit/Availability(large) 在庫の有無(instock/outofstock)
/ResultSet/Result/Hit/Caption(large) 商品説明
/ResultSet/Result/Hit/Abstract(large) ひと言コメント
/ResultSet/Result/Hit/Additional1 (large) フリースペース1
/ResultSet/Result/Hit/Additional2(large) フリースペース2
/ResultSet/Result/Hit/Additional3(large) フリースペース3

※1.都道府県コードについて

地方コード:地方名 都道府県コード:都道府県名
1:北海道・東北 01:北海道 02:青森 03:岩手 04:宮城 05:秋田 06:山形 07:福島
2:関東 13:東京 14:神奈川 11:埼玉 12:千葉 08:茨城 09:栃木 10:群馬 19:山梨
3:信越・北陸 15:新潟 20:長野 16:富山 17:石川 18:福井
4:東海 23:愛知 21:岐阜 22:静岡 24:三重
5:近畿 27:大阪 28:兵庫 26:京都 25:滋賀 29:奈良 30:和歌山
6:中国 31:鳥取 32:島根 33:岡山 34:広島 35:山口
7:四国 36:徳島 37:香川 38:愛媛 39:高知
8:九州・沖縄 40:福岡 41:佐賀 42:長崎 43:熊本 44:大分 45:宮崎 46:鹿児島 47:沖縄




サンプルレスポンス

以下は、商品コード(hmv_2737935)のリクエストに対するレスポンスです。

<?xml version="1.0" encoding="UTF-8"?>
<ResultSet xsi:schemaLocation="urn:yahoo:jp:itemLookup http://shopping.yahooapis.jp/ShoppingWebService/V1/itemLookup.xsd" xmlns="urn:yahoo:jp:itemLookup" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" totalResultsReturned="1" firstResultPosition="1">
  <Result>
    <ItemCode>
      <Codes>
        <Code>hmv_2737935</Code>
      </Codes>
    </ItemCode>
    <Hit index="1">
      <Name>EXILE エグザイル / Exile Entertainment Best エンターテイメント・ベスト 〔CD〕</Name>
      <Url>http://store.shopping.yahoo.co.jp/hmv/2737935.html</Url>
      <Headline/>
      <Image>
        <Id>hmv_2737935</Id>
        <Small>http://item.shopping.c.yimg.jp/i/c/hmv_2737935</Small>
      </Image>
      <Price currency="JPY">4536</Price>
      <PriceLabel taxIncluded="true">
        <FixedPrice>5040</FixedPrice>
        <DefaultPrice>4536</DefaultPrice>
        <SalePrice/>
        <PeriodStart/>
        <PeriodEnd/>
      </PriceLabel>
    </Hit>
  </Result>
</ResultSet>



エラー

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




利用制限

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