ダウンロード実行API
商品、在庫、ストアカテゴリのデータをCSVファイルとしてダウンロードを実行します。
変更履歴
2024年11月28日
商品のバリエーション設定に関連して以下の項目を修正しました。
リクエストパラメータ
- type(取得したいダウンロード用ファイルのファイルタイプ) 説明に「4 : 商品(グルーピングデータ)」を追加
レスポンスフィールド
- all_grouping.csv(商品データ(グルーピングデータ)) 項目を追加
リクエストURL
リクエストURL(XML)
本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/downloadSubmit
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/downloadSubmit
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。
リクエストパラメータ
「Web APIの使い方#GETとは」をご参照ください。
パラメータ | 値 | 説明 |
---|---|---|
seller_id (必須) |
string | ストアアカウントを指定します。 |
type (必須) |
integer | ダウンロードするファイルタイプを指定します。 1 : 商品データ 2 : 在庫データ 3 : ストアカテゴリ 4 : 商品(グルーピングデータ)2024年12月中旬追加 |
※こちらのAPIはYahoo! ID連携に対応したAPIです。
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 | ストアカテゴリ |
all_grouping.csv | item | 商品データ(グルーピングデータ) ※downloadRequest で page_keyを指定した場合は [page_key].csv となります。 2024年12月中旬追加 |
サンプルレスポンス
「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には、共通で利用するエラーコードがあります。エラーの際には、まず始めに以下をご確認ください。
商品系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に関する利用約款はこちら。
目次
- 商品検索
- カテゴリランキング
- カテゴリID取得
- 商品コード検索(商品詳細)
- キーワードランキング
- おすすめ情報モジュール
- ポイントキャンペーン情報取得
- 販促イベント検索
- 商品レビュー検索
- 出品管理に関連するAPI
- 商品に関連するAPI
- 問い合わせ管理に関連するAPI
- 製品/SHPカテゴリ/ブランドに関連するAPI
- 在庫に関連するAPI
- ストアカテゴリに関連するAPI
- 画像に関連するAPI
- デザインに関連するAPI
- 注文に関するAPI
- ヘルプ