ショッピング

追加画像一覧API

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


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

追加画像ディレクトリに含まれる追加画像一覧を取得します。

リクエストパラメータ

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

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
directory string 追加画像ディレクトリ名を指定します。
指定しない場合、全追加画像が対象となります。
query string ファイル名に対して文字検索を行う際に検索ワードを指定します。(部分一致)
スペース区切りで複数ワード指定することはできません。
start integer
(デフォルト : 1)
何件目からデータの取得をはじめるかを指定します。
results integer
(デフォルト : 25)
データの取得件数を指定します。(最大値100)
sort string
(デフォルト : +name)
一覧のソート項目を指定します。
name : ファイル名
file_size : ファイルサイズ
upload_date : 更新日時
項目の前に以下の記号を付与することで、昇順降順を変更可能です。
+(昇順)/-(降順)※UTF-8でURLエンコードされている必要があります。

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

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


サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/libImageList?seller_id=teststore&directory=%E6%9C%AC&query=sample1&start=10&results=50&sort=%2Bname

サンプルリクエスト

GET /ShoppingWebService/V1/libImageList?seller_id=teststore&directory=%E6%9C%AC&query=sample1&start=10&results=50&sort=%2Bname HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>



レスポンスフィールド

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

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

/ResultSet/Result 結果
/ResultSet/Result/Name ファイル名
/ResultSet/Result/Url 画像URL(反映状態の画像を参照するURL)

未反映状態の画像は空になります。
/ResultSet/Result/Size 横×縦サイズ
/ResultSet/Result/FileSize ファイルサイズ(バイト数)
/ResultSet/Result/UploadDate 更新日(RFC3339)
/ResultSet/Result/PublishDate 反映日(RFC3339)
/ResultSet/Result/EditingFlag 編集フラグ
0 : 反映済み
1 : 編集されてからフロント反映されていない状態



サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsAvailable="59" totalResultsReturned="2" firstResultPosition="1">
    <Result>
        <Name>sample1.jpg</Name>
        <Url>http://preview.lib.shopping.yahoo.co.jp/RT/lib/teststore/sample1.gif</Url>
        <Size>98×80px</Size>
        <FileSize>1630</FileSize>
        <UploadDate>2013-02-06T16:58:32+09:00</UploadDate>
        <PublishDate>2013-02-06T16:58:32+09:00</PublishDate>
        <EditingFlag>0</EditingFlag>
    </Result>
    <Result>
        <Name>sample2.jpg</Name>
        <Url>http://preview.lib.shopping.yahoo.co.jp/RT/lib/teststore/sample2.gif</Url>
        <Size>98×80px</Size>
        <FileSize>1630</FileSize>
        <UploadDate>2013-02-06T16:58:32+09:00</UploadDate>
        <PublishDate>2013-02-06T16:58:32+09:00</PublishDate>
        <EditingFlag>0</EditingFlag>
    </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ステータスコード 説明
im-05001 400 指定された追加画像ディレクトリ名は存在しません。(欠番)
im-05002 400 startの値が不正です。
im-05003 400 resultsの値が不正です。
im-05004 400 sortの値が不正です。
im-05005 400 検索ワードが不正です。




利用制限

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

利用約款

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