ショッピング

商品関連付け 商品情報検索API

リクエストURL
JSONP
http://shopping.yahooapis.jp/ShoppingWebService/V1/json/urlItemMatchSearch

【重要】こちらのAPIは、サービスの見直しにより、2013年6月4日（火）をもちまして終了させていただきます。
ご利用中の皆様にはお詫び申しあげますとともにこれまでのご愛顧に感謝いたします。

商品関連付け 商品情報検索APIは、URLに対して任意の商品を関連付ける為の商品検索と、商品情報登録に必要な署名(signature)を発行します。
発行した署名(signature)は、商品関連付け 商品情報登録APIにて使用します。

リクエストパラメータ

「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でエンコードした文字列を入力する。
url
（必須）		 string 商品を登録したいURL（要URLエンコード）
最大128byte。GETパラメータは含めない
query
（必須）		 string 検索キーワード（要UTF-8 エンコード）　最大64byte
category_id integer ジャンルカテゴリID　検索対象のカテゴリID絞り込み
results integer 取得件数、取得する検索結果数の指定　デフォルト値は10件、最大値は50件
start integer 取得開始位置、ヒットした商品のうち、何件目から表示させるか（１件目は1）

サンプルリクエストURL

http://shopping.yahooapis.jp/ShoppingWebService/V1/json/urlItemMatchSearch?appid=<あなたのアプリケーションID>&url=http%3A%2F%2Fshopping.yahoo.co.jp%2F&query=vaio

レスポンスフィールド

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

  • totalResultsAvailable：検索数HIT数
  • totalResultsReturned：返された値の個数
  • firstResultPosition：最初のデータが何個目にあたるか（最初＝1）
/ResultSet/Request/Query 検索したキーワード
/ResultSet/Request/Url 登録するURL
/ResultSet/Request/CrumbTerm/Start 署名有効開始時間
2004-04-01T12:00:00+09:00 RFC3339に準拠
/ResultSet/Request/CrumbTerm/End 署名有効終了時間
2004-04-01T12:00:00+09:00 RFC3339に準拠
/ResultSet/Result/ 検索結果です。

  • index：検索結果の番号
/ResultSet/Result/Signature 署名
/ResultSet/Result/Code 商品コード
/ResultSet/Result/Name 商品名
/ResultSet/Result/Url 商品URL
/ResultSet/Result/Headline 商品のキャッチコピー
/ResultSet/Result/Image/Id 画像ID
/ResultSet/Result/Image/Small/Url 76px×76px画像のURL
/ResultSet/Result/Image/Small/Width 画像の横幅　数字(px単位)
/ResultSet/Result/Image/Small/Height 画像の高さ　数字(px単位)
/ResultSet/Result/Image/Medium/Url 146px×146px画像のURL
/ResultSet/Result/Image/Medium/Width 画像の横幅　数字(px単位)
/ResultSet/Result/Image/Medium/Height 画像の高さ　数字(px単位)
ResultSet/Result/Price 現在価格
数字（現在価格を表示、セール期間中の場合はセール価格、それ以外は販売価格）

  • currency：通貨
    通貨表記(ISO 4217)
/ResultSet/Result/PriceLabe 価格詳細です。

  • taxIncluded：税込み価格かどうか
    true(税込み) false(税込みじゃない)
/ResultSet/Result/PriceLabel/FixedPrice 定価
数字（商品のオリジナル価格）
/ResultSet/Result/PriceLabel/SalePrice セール価格
数字（セール期間中の価格）
/ResultSet/Result/Store/Id ストアID
/ResultSet/Result/Store/Name ストア名
/ResultSet/Result/Store/Url ストアURL


サンプルレスポンス

以下は、url=http%3A%2F%2Fshopping.yahoo.co.jp%2F, callback=loaded, query=vaioでリクエストした場合のレスポンスです。

loaded(
{
  "ResultSet" : {
    "totalResultsAvailable" : 3688,
    "totalResultsReturned" : 10,
    "firstResultPosition" : 1,
    "Request" : {
      "Query" : "vaio",
      "Url" : "http://shopping.yahoo.co.jp/",
      "CrumbTerm" : {
        "Start" : "2009-12-14T17:22:42+09:00",
        "End" : "2009-12-14T18:22:42+09:00"
      }
    },
    "Result" : [
      {
        "_attributes" : {
          "index" : 1
        },
        "Signature" : "8fa64550e10fe3dc0729000b1908b601",
        "Code" : "allone_VPCW119XJ-P",
        "Name" : "SONY（ソニー） VAIO W VPCW119XJ/P（ピンク）",
        "Url" : "http://store.shopping.yahoo.co.jp/allone/vpcw119xj-p.html",
        "Headline" : "安心の5年延長保証加入受付中！〔別途料金〕",
        "Image" : {
          "Id" : "allone_vpcw119xj-p",
          "Small" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/c/allone_vpcw119xj-p",
            "Width" : 76,
            "Height" : 76
          },
          "Medium" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/g/allone_vpcw119xj-p",
            "Width" : 146,
            "Height" : 146
          }
        },
        "Price" : {
          "_attributes" : {
            "currency" : "JPY"
          },
          "_value" : 46000
        },
        "PriceLabel" : {
          "_attributes" : {
            "taxIncluded" : "true"
          },
          "FixedPrice" : "",
          "SalePrice" : ""
        },
        "Store" : {
          "Id" : "allone",
          "Name" : "ALLONE電気 ヤフー店",
          "Url" : "http://store.shopping.yahoo.co.jp/allone/index.html"
        }
      },
      {
        "_attributes" : {
          "index" : 2
        },
        "Signature" : "ebe44c63bcb31df4adeaf51294e66775",
        "Code" : "allone_VPCX118KJ-B",
        "Name" : "SONY（ソニー） ノートパソコン VAIO Xシリーズ VPCX118KJ/B",
        "Url" : "http://store.shopping.yahoo.co.jp/allone/vpcx118kj-b.html",
        "Headline" : "安心の5年延長保証加入受付中！〔別途料金〕",
        "Image" : {
          "Id" : "allone_vpcx118kj-b",
          "Small" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/c/allone_vpcx118kj-b",
            "Width" : 76,
            "Height" : 76
          },
          "Medium" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/g/allone_vpcx118kj-b",
            "Width" : 146,
            "Height" : 146
          }
        },
        "Price" : {
          "_attributes" : {
            "currency" : "JPY"
          },
          "_value" : 89800
        },
        "PriceLabel" : {
          "_attributes" : {
            "taxIncluded" : "true"
          },
          "FixedPrice" : "",
          "SalePrice" : ""
        },
        "Store" : {
          "Id" : "allone",
          "Name" : "ALLONE電気 ヤフー店",
          "Url" : "http://store.shopping.yahoo.co.jp/allone/index.html"
        }
      },
      {
        "_attributes" : {
          "index" : 3
        },
        "Signature" : "2a924ad557f8b22a5ba222dcf6c16c38",
        "Code" : "allone_VGN-CS62JB-P",
        "Name" : "ソニー ノートパソコン　VAIO type C VGN-CS62JB/P",
        "Url" : "http://store.shopping.yahoo.co.jp/allone/vgn-cs62jb-p.html",
        "Headline" : "安心の5年延長保証加入受付中",
        "Image" : {
          "Id" : "allone_vgn-cs62jb-p",
          "Small" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/c/allone_vgn-cs62jb-p",
            "Width" : 76,
            "Height" : 76
          },
          "Medium" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/g/allone_vgn-cs62jb-p",
            "Width" : 146,
            "Height" : 146
          }
        },
        "Price" : {
          "_attributes" : {
            "currency" : "JPY"
          },
          "_value" : 79800
        },
        "PriceLabel" : {
          "_attributes" : {
            "taxIncluded" : "true"
          },
          "FixedPrice" : "",
          "SalePrice" : ""
        },
        "Store" : {
          "Id" : "allone",
          "Name" : "ALLONE電気 ヤフー店",
          "Url" : "http://store.shopping.yahoo.co.jp/allone/index.html"
        }
      },
      {
        "_attributes" : {
          "index" : 4
        },
        "Signature" : "ffaeb37fee94177e132560f6a60da998",
        "Code" : "try3_4905524602944",
        "Name" : "SONY VAIO type N VGN-NW50JB　ノートパソコン　A4 VAIO type N VGNNW50JB",
        "Url" : "http://store.shopping.yahoo.co.jp/try3/4905524602944.html",
        "Headline" : "延長保証受付中！送料無料！",
        "Image" : {
          "Id" : "try3_4905524602944",
          "Small" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/c/try3_4905524602944",
            "Width" : 76,
            "Height" : 76
          },
          "Medium" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/g/try3_4905524602944",
            "Width" : 146,
            "Height" : 146
          }
        },
        "Price" : {
          "_attributes" : {
            "currency" : "JPY"
          },
          "_value" : 85000
        },
        "PriceLabel" : {
          "_attributes" : {
            "taxIncluded" : "true"
          },
          "FixedPrice" : "",
          "SalePrice" : ""
        },
        "Store" : {
          "Id" : "try3",
          "Name" : "TRY×3　トライスリー",
          "Url" : "http://store.shopping.yahoo.co.jp/try3/index.html"
        }
      },
      {
        "_attributes" : {
          "index" : 5
        },
        "Signature" : "a138217b3b70c7c94d310e817bfdd4ab",
        "Code" : "20xxsozo_kadenvgn-P50g",
        "Name" : "▲SONY VAIO type P VGN-P50/G ノートパソコン",
        "Url" : "http://store.shopping.yahoo.co.jp/20xxsozo/kadenvgn-p50g.html",
        "Headline" : "個数限定＆期間限定　特別割引対象商品",
        "Image" : {
          "Id" : "20xxsozo_kadenvgn-p50g",
          "Small" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/c/20xxsozo_kadenvgn-p50g",
            "Width" : 76,
            "Height" : 76
          },
          "Medium" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/g/20xxsozo_kadenvgn-p50g",
            "Width" : 146,
            "Height" : 146
          }
        },
        "Price" : {
          "_attributes" : {
            "currency" : "JPY"
          },
          "_value" : 61624
        },
        "PriceLabel" : {
          "_attributes" : {
            "taxIncluded" : "true"
          },
          "FixedPrice" : "",
          "SalePrice" : 61624
        },
        "Store" : {
          "Id" : "20xxsozo",
          "Name" : "未来創造研究所",
          "Url" : "http://store.shopping.yahoo.co.jp/20xxsozo/index.html"
        }
      },
      {
        "_attributes" : {
          "index" : 6
        },
        "Signature" : "8cba5a7ae04dc628787d83dba40001a7",
        "Code" : "telj_VPCX119KJ-B",
        "Name" : "VAIO Xシリーズ：『SONY(ソニー)ノートパソコン　バイオX』『VPCX119KJ/B』",
        "Url" : "http://store.shopping.yahoo.co.jp/telj/vpcx119kj-b.html",
        "Headline" : "♪09年10月22日発売予定♪　2009年冬モデル",
        "Image" : {
          "Id" : "telj_vpcx119kj-b",
          "Small" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/c/telj_vpcx119kj-b",
            "Width" : 76,
            "Height" : 76
          },
          "Medium" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/g/telj_vpcx119kj-b",
            "Width" : 146,
            "Height" : 146
          }
        },
        "Price" : {
          "_attributes" : {
            "currency" : "JPY"
          },
          "_value" : 129800
        },
        "PriceLabel" : {
          "_attributes" : {
            "taxIncluded" : "true"
          },
          "FixedPrice" : "",
          "SalePrice" : ""
        },
        "Store" : {
          "Id" : "telj",
          "Name" : "テルショップ・ジャパン Yahoo!店",
          "Url" : "http://store.shopping.yahoo.co.jp/telj/index.html"
        }
      },
      {
        "_attributes" : {
          "index" : 7
        },
        "Signature" : "eef29bda11a94fad3544aacb9779b32d",
        "Code" : "20xxsozo_kadenvaiotypenvgn-nw70jb-0906",
        "Name" : "▲ノートパソコン SONY VAIO type N VGN-NW70JB",
        "Url" : "http://store.shopping.yahoo.co.jp/20xxsozo/kadenvaiotypenvgn-nw70jb-0906.html",
        "Headline" : "個数限定＆期間限定　特別割引対象商品",
        "Image" : {
          "Id" : "20xxsozo_kadenvaiotypenvgn-nw70jb-0906",
          "Small" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/c/20xxsozo_kadenvaiotypenvgn-nw70jb-0906",
            "Width" : 76,
            "Height" : 76
          },
          "Medium" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/g/20xxsozo_kadenvaiotypenvgn-nw70jb-0906",
            "Width" : 146,
            "Height" : 146
          }
        },
        "Price" : {
          "_attributes" : {
            "currency" : "JPY"
          },
          "_value" : 102893
        },
        "PriceLabel" : {
          "_attributes" : {
            "taxIncluded" : "true"
          },
          "FixedPrice" : "",
          "SalePrice" : 102893
        },
        "Store" : {
          "Id" : "20xxsozo",
          "Name" : "未来創造研究所",
          "Url" : "http://store.shopping.yahoo.co.jp/20xxsozo/index.html"
        }
      },
      {
        "_attributes" : {
          "index" : 8
        },
        "Signature" : "ccd1fbe055d23c3fd1ae55c9e5120e5d",
        "Code" : "eccurrent_4905524626339",
        "Name" : "SONY VGN-NW51FB/N / VAIO N ゴールド",
        "Url" : "http://store.shopping.yahoo.co.jp/eccurrent/4905524626339.html",
        "Headline" : "",
        "Image" : {
          "Id" : "eccurrent_4905524626339",
          "Small" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/c/eccurrent_4905524626339",
            "Width" : 76,
            "Height" : 76
          },
          "Medium" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/g/eccurrent_4905524626339",
            "Width" : 146,
            "Height" : 146
          }
        },
        "Price" : {
          "_attributes" : {
            "currency" : "JPY"
          },
          "_value" : 98000
        },
        "PriceLabel" : {
          "_attributes" : {
            "taxIncluded" : "true"
          },
          "FixedPrice" : "",
          "SalePrice" : ""
        },
        "Store" : {
          "Id" : "eccurrent",
          "Name" : "ECカレント",
          "Url" : "http://store.shopping.yahoo.co.jp/eccurrent/index.html"
        }
      },
      {
        "_attributes" : {
          "index" : 9
        },
        "Signature" : "444970d5185ba318c09d6102e654d20f",
        "Code" : "memorydeal_PCVA-MM512F",
        "Name" : "512MB Sony VAIO PCV Desktop PC3200 DDR DIMM (p/n PCVA-MM512F) OEMメーカー",
        "Url" : "http://store.shopping.yahoo.co.jp/memorydeal/pcva-mm512f.html",
        "Headline" : "Sony VAIO互換メモリ",
        "Image" : {
          "Id" : "",
          "Small" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/c/",
            "Width" : 76,
            "Height" : 76
          },
          "Medium" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/g/",
            "Width" : 146,
            "Height" : 146
          }
        },
        "Price" : {
          "_attributes" : {
            "currency" : "JPY"
          },
          "_value" : 6000
        },
        "PriceLabel" : {
          "_attributes" : {
            "taxIncluded" : "true"
          },
          "FixedPrice" : "",
          "SalePrice" : ""
        },
        "Store" : {
          "Id" : "memorydeal",
          "Name" : "Memory Deal",
          "Url" : "http://store.shopping.yahoo.co.jp/memorydeal/index.html"
        }
      },
      {
        "_attributes" : {
          "index" : 10
        },
        "Signature" : "cd3f853c8358be0a4ddc80245e2fc847",
        "Code" : "20xxsozo_kadenvgn-aw52jgb-0906",
        "Name" : "▲ノートパソコン SONY VAIO type A VGN-AW52JGB",
        "Url" : "http://store.shopping.yahoo.co.jp/20xxsozo/kadenvgn-aw52jgb-0906.html",
        "Headline" : "個数限定＆期間限定　特別割引対象商品",
        "Image" : {
          "Id" : "20xxsozo_kadenvgn-aw52jgb-0906",
          "Small" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/c/20xxsozo_kadenvgn-aw52jgb-0906",
            "Width" : 76,
            "Height" : 76
          },
          "Medium" : {
            "Url" : "http://a248.e.akamai.net/f/248/37952/1d/image.shopping.yahoo.co.jp/i/g/20xxsozo_kadenvgn-aw52jgb-0906",
            "Width" : 146,
            "Height" : 146
          }
        },
        "Price" : {
          "_attributes" : {
            "currency" : "JPY"
          },
          "_value" : 184425
        },
        "PriceLabel" : {
          "_attributes" : {
            "taxIncluded" : "true"
          },
          "FixedPrice" : "",
          "SalePrice" : 184425
        },
        "Store" : {
          "Id" : "20xxsozo",
          "Name" : "未来創造研究所",
          "Url" : "http://store.shopping.yahoo.co.jp/20xxsozo/index.html"
        }
      }
    ]
  }
}
);


エラー

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



利用制限

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