ショッピング

SHPブランドコードダウンロードAPI

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


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

Yahoo!ショッピングのブランドをダウンロードします。
※日付指定しない場合は全てのデータをダウンロードします。

リクエストパラメータ

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

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
since
(指定した場合untilも必須になります。)
string 取得データの更新日の開始位置を指定します。(YYYYMMDD)この日付を含んだそれより後です。
until
(指定した場合sinceも必須になります。)
string 取得データの更新日の終了位置を指定します。(YYYYMMDD)この日付を含んだそれより前です。

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

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


サンプルリクエストURL

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

サンプルリクエスト

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



レスポンスフィールド

フィールド 説明
id ブランドID
name ブランド名
jtitle 和名
path_name ブランド階層
updated_at 更新日(YYYY-MM-DD)

※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-06001 400 sinceの値が不正です。
pr-06002 400 untilの値が不正です。
pr-06003 400 sinceよりも過去の日付がuntilで指定されています。




利用制限

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

利用約款

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