ショッピング

SHP製品コード検索API

リクエストURL
XML
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/getShopProductCodeList


こちらはテスト用APIもご利用いただけます。URLは以下の通りです。
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/getShopProductCodeList
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。

製品名、JANコード、製品コード、Yahoo!ショッピング製品コードからYahoo!ショッピング製品コードを検索できます。

リクエストパラメータ

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

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
query
(必須)
string 検索ワードを指定します。
「製品名」に対しては部分一致、「JANコード」「製品コード」「Yahoo!ショッピング製品コード」に対しては完全一致となります。
type string
(デフォルト : all)
検索項目を指定します。指定は1つのみです。
all : すべて
name : 製品名
jan : JANコード
pid : 製品コード
ypid : Yahoo!ショッピング製品コード
sort string
(デフォルト : +name)
一覧のソート項目を指定します。
name : 製品名
update_date : 更新日
項目の前に以下の記号を付与することで、昇順降順を変更可能です。
+(昇順)/-(降順) ※UTF-8でURLエンコードされている必要があります。
start integer
(デフォルト : 1)
何件(ページ)目からデータの取得をはじめるかを指定します。
(例 : データが100件あった場合。startを「2」にしてresultsを「25」にした場合は、100件あるデータのうち26件目~50件目のデータを取得します。商品データ編集画面などを作る際の表示イメージになります。)
results integer
(デフォルト : 25)
データの取得件数を指定します。(最大値100)

※こちらのAPIはYahoo! ID連携に対応したAPIです。
Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。
Yahoo! ID連携
Yahoo! ID連携によるAPIアクセス実装方法

※こちらのAPIを利用する場合は、こちらからアプリケーションIDを取得してください。


サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/getShopProductCodeList?seller_id=teststore&query=PC&type=name&sort=%2Bname&start=1&results=25

サンプルリクエスト

GET /ShoppingWebService/V1/getShopProductCodeList?seller_id=teststore&query=PC&type=name&sort=%2Bname&start=1&results=25 HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>



レスポンスフィールド

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

  • totalResultsAvailable : 該当件数の総個数です。
  • totalResultsReturned : 返された値の個数です。
  • firstResultPosition : 最初のデータが何個目に当たるかです。

/ResultSet/Result 各製品の要素を含みます。
/ResultSet/Result/ProductCode 製品コード
/ResultSet/Result/ProductName 製品名
/ResultSet/Result/YahooProductCode Yahoo!ショッピング製品コード
/ResultSet/Result/Jan JANコード
/ResultSet/Result/Url 製品ページURL
/ResultSet/Result/ReleaseDate 発売日(YYYY-MM-DD)
/ResultSet/Result/UpdateDate 更新日(YYYY-MM-DD)



サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsAvailable="1630" totalResultsReturned="2" firstResultPosition="1">
    <Result>
        <ProductCode>3</ProductCode>
        <ProductName><![CDATA[xxx]]></ProductName>
        <YahooProductCode>013505b2faefcb561c3c4164d2cdfe16</YahooProductCode>
        <Jan></Jan>
        <Url>http://shopping.yahoo.co.jp/product/compare?pid=013505b2faefcb561c3c4164d2cdfe16</Url>
       <ReleaseDate></ReleaseDate>
        <UpdateDate></UpdateDate>
    </Result>
</ResultSet>



エラー

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


・商品系API共通エラーコード

コード HTTPステータスコード 説明
ed-00000 404 ページが見つかりません。
ed-00001 500 システムエラーが発生しました。
ed-00002 503 サーバがメンテナンス中です。
ed-00003 400 ストアアカウントが指定されていません。
ed-00004 400 ストアアカウントが存在しません。
ed-00005 400 ストアアカウントの指定が不正です。


・エラーコード

コード HTTPステータスコード 説明
pr-01001 400 検索ワードが指定されていません。
pr-01002 400 typeの値が不正です。
pr-01003  400 sortの値が不正です。 
pr-01004  400 startの値が不正です。
pr-01005  400 resultsの値が不正です。
pr-01006  400 queryの値が不正です。 




利用制限

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

利用約款

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