ショッピング

ダウンロード準備完了通知API

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


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

商品、在庫、ストアカテゴリのダウンロード用ファイルの生成が終わり、ダウンロードできる状態になったファイル一覧を取得します。

リクエストパラメータ

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

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
type integer
(デフォルト : 0)
取得したいダウンロード用ファイルのファイルタイプを指定します。
0 : すべて
1 : 商品データ
2 : 在庫データ
3 : ストアカテゴリ

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

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


サンプルリクエストURL

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

サンプルリクエスト

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



レスポンスフィールド

フィールド 説明
/ResultSet レスポンスのすべてを含み、次の属性を持ちます。

  • totalResultsAvailable : 該当件数の総個数です。
  • totalResultsReturned : 返された値の個数です。
  • firstResultPosition : 最初のデータが何個目に当たるかです。(1固定)

/ResultSet/Result 各個別レスポンスを含みます。
/ResultSet/Result/Type ダウンロードファイルの種別
1 : 商品データ
2 : 在庫データ
3 : ストアカテゴリ
/ResultSet/Result/FileName ファイル名
/ResultSet/Result/CreateTime ファイルが生成された時間(RFC3339)



サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsAvailable="2" totalResultsReturned="2" firstResultPosition="1">
    <Result>
        <Type>1</Type>
        <FileName>data.csv</FileName>
        <CreateTime>2013-02-07T18:00:00+09:00</CreateTime>
   </Result>
   <Result>
        <Type>2</Type>
        <FileName>quantity.csv</FileName>
        <CreateTime>2013-02-07T18:00:00+09:00</CreateTime>
   </Result>
</ResultSet>



エラー

ダウンロード準備完了通知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ステータスコード 説明
pm-07001 400 ファイルタイプが不正です。




利用制限

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

利用約款

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