ダウンロード要求API
商品、在庫、ストアカテゴリのデータをファイルとして生成する要求を受け付けます。
※このAPIではダウンロード要求だけ受け付け、ダウンロードファイルの生成は非同期で行います。
※ダウンロードを開始するにはダウンロード実行APIを利用する必要があります。
変更履歴
2024年11月28日
商品のバリエーション設定に関連して以下のリクエストパラメータの説明を修正しました。
- type(ダウンロード用ファイルを生成する対象のファイルタイプ) 4 : 商品(グルーピングデータ) を追加
- page_key(ダウンロードしたい対象のストアカテゴリのページキー) 4(グルーピングデータ) の場合を追加
リクエストURL
リクエストURL(XML)
本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/downloadRequest
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/downloadRequest
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。
リクエストパラメータ
「Web APIの使い方#POSTとは」をご参照ください。
パラメータ | 値 | 説明 |
---|---|---|
seller_id (必須) |
string | ストアアカウントを指定します。 |
type (必須) |
integer | ダウンロード用ファイルを生成する対象のファイルタイプを指定します。 1 : 商品 2 : 在庫 3 : ストアカテゴリ 4 : 商品(グルーピングデータ)2024年12月中旬追加 |
page_key | string | type=1(商品データ), 4(グルーピングデータ)(2024年12月中旬追加)の場合のみ、 ストアカテゴリをダウンロード対象に絞ることができます。 ダウンロードしたい対象のストアカテゴリのページキーを指定します。 ※指定しない場合はすべての商品を対象にダウンロード要求をします。 |
※こちらのAPIはYahoo! ID連携に対応したAPIです。
Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。
※こちらのAPIを利用する場合は、こちらからClient ID(アプリケーションID)を取得してください。
サンプルリクエストURL
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/downloadRequest
サンプルリクエスト
POST /ShoppingWebService/V1/downloadRequest HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>
seller_id=teststore&type=1&page_key=c3e6b8c5a5
レスポンスフィールド
フィールド | 説明 |
---|---|
/ResultSet | レスポンスのすべてを含みます。 |
/ResultSet/Result | 各個別レスポンスを含みます。 |
/ResultSet/Result/Status | 成功時に「OK」と表示します。 失敗時は別フォーマットでエラーレスポンスを表示します。 |
サンプルレスポンス
<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
<Result>
<Status>OK</Status>
</Result>
</ResultSet>
エラー
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-06001 | 400 | ファイルタイプが指定されていません。 |
pm-06002 | 400 | ファイルタイプが不正です。 |
pm-06003 | 400 | 指定されたストアカテゴリは存在しません。 |
pm-06004 | 403 | ダウンロード準備中です。 |
利用制限
※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
利用約款
このAPIに関する利用約款はこちら。
目次
- 商品検索
- カテゴリランキング
- カテゴリID取得
- 商品コード検索(商品詳細)
- キーワードランキング
- おすすめ情報モジュール
- ポイントキャンペーン情報取得
- 販促イベント検索
- 商品レビュー検索
- 出品管理に関連するAPI
- 商品に関連するAPI
- 問い合わせ管理に関連するAPI
- 製品/SHPカテゴリ/ブランドに関連するAPI
- 在庫に関連するAPI
- ストアカテゴリに関連するAPI
- 画像に関連するAPI
- デザインに関連するAPI
- 注文に関するAPI
- ヘルプ