ダウンロード実行API

商品、在庫、ストアカテゴリのデータをCSVファイルとしてダウンロードを実行します。

リクエストURL

テスト用APIを利用したい場合は、こちらから利用申請をお願いします。

リクエストパラメータ

「Web APIの使い方#GETとは」をご参照ください。

パラメータ	値	説明
seller_id （必須）	string	ストアアカウントを指定します。
type （必須）	integer	ダウンロードするファイルタイプを指定します。 1 : 商品データ 2 : 在庫データ 3 : ストアカテゴリ

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

• Yahoo! ID連携
• Yahoo! ID連携によるAPIアクセス実装方法

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

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/downloadSubmit?seller_id=teststore&type=1

サンプルリクエスト

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

レスポンスフィールド

ファイル名

ファイル名	file_type	説明
data.csv	item	商品 ※downloadRequest　で page_keyを指定した場合は [page_key].csv　となります。
quantity.csv	quantity	在庫
category.csv	category	ストアカテゴリ

サンプルレスポンス

「type=2（在庫データ）」の場合

code,sub-code,quantity,allow-overdraft,stock-close
testitem-001,,1000,1,0
testitem-002,,1000,1,0
testitem-003,color1,9999,0,0
testitem-003,color2,9999,0,0
testitem-003,color3,9999,0,0

エラー

Yahoo!ショッピングで提供している全てのAPIには、共通で利用するエラーコードがあります。エラーの際には、まず始めに以下をご確認ください。

• Yahoo! ショッピングAPI共通エラーコード一覧

商品系API、およびダウンロード実行APIで固有に返すエラーコードは以下をご覧ください。

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

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

エラーコード

コード	HTTPステータスコード	説明
pm-08001	400	ファイルタイプが指定されていません。
pm-08002	400	ファイルタイプが不正です。
pm-08003	403	ダウンロードできるファイルがありません。

利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。（1クエリー/秒）

利用約款

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