ショッピング

SHPカテゴリ/スペックダウンロードAPI

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


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

Yahoo!ショッピングのプロダクトカテゴリ/スペックをダウンロードします。
※日付指定しない場合は全てのデータをダウンロードします。

リクエストパラメータ

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

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
since
(指定した場合untilも必須になります。)
2015年10月1日以降こちらの指定は廃止となります
string 取得データの更新日の開始位置を指定します。(YYYYMMDD)この日付を含んだそれより後になります。
until
(指定した場合sinceも必須になります。)
2015年10月1日以降こちらの指定は廃止となります
string 取得データの更新日の終了位置を指定します。(YYYYMMDD)この日付を含んだそれより前になります。
spec integer
(デフォルト : 0)
スペック系の項目をファイルに含めるか指定します。
0 : スペック系の項目をファイルに含めない
1 : スペック系の項目をファイルに含める

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

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


サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/downloadShopCategories?seller_id=teststore&since=20130101&until=20130131

サンプルリクエスト

GET /ShoppingWebService/V1/downloadShopCategories?seller_id=teststore&since=20130101&until=20130131 HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

サンプルリクエストURL(2015年10月1日以降)

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/downloadShopCategories?seller_id=teststore

サンプルリクエスト

GET /ShoppingWebService/V1/downloadShopCategories?seller_id=teststore HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>



レスポンスフィールド

フィールド 説明
id プロダクトカテゴリID
name プロダクトカテゴリ名
path_name カテゴリパス
spec_id スペックID
リクエストパラメータで「spec=1」が指定されたときのみ含まれます。
spec_name スペック名
リクエストパラメータで「spec=1」が指定されたときのみ含まれます。
spec_value_id スペック値ID
リクエストパラメータで「spec=1」が指定されたときのみ含まれます。
spec_value_name スペック値名
リクエストパラメータで「spec=1」が指定されたときのみ含まれます。
updated_at/spec_updated_at カテゴリの更新日
スペック込みの場合は、スペックの更新日
(YYYY-MM-DD)

リクエストパラメータで「spec=0」が指定されたときは「updated_at」、「spec=1」が指定されたときは「spec_updated_at」が含まれます。
selection_type
この項目は2015年10月1日以降追加されます
選択型
0: 単一選択型(商品IDに対し、単一のスペックバリュー値を選択可能)
1: 複数選択型(商品IDに対し、複数のスペックバリュー値を選択可能)
リクエストパラメータで「spec=1」が指定されたときのみ含まれます。
data_type
この項目は2015年10月1日以降追加されます
データタイプ
1:整列型【例】色(ホワイト、ゴールド)など用意されたものから選択するもの
2:整数型【例】液晶テレビサイズ(10型~20型)のように整数で範囲指定するもの
4:小数点数型【例】アルコール度数(0.5~0.9%)のように小数点ありで範囲指定するもの
リクエストパラメータで「spec=1」が指定されたときのみ含まれます。

※1行目のヘッダーとなります。




サンプルレスポンス

なし



エラー

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-04001 400 sinceの値が不正です。
pr-04002 400 untilの値が不正です。
pr-04003 400 specの値が不正です。
pr-04004 400 untilの値がsinceの値より前です。




利用制限

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

利用約款

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