追加画像一覧API

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

変更履歴

リクエストURL

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

リクエストパラメータ

「Web APIの使い方#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エンコードされている必要があります。

サンプルリクエスト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 ※2022年5月以降、本番URLとなり、ドメインが変更になります。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/Size	横×縦サイズ
/ResultSet/Result/FileSize	ファイルサイズ（バイト数）
/ResultSet/Result/UploadDate	更新日（RFC3339）
/ResultSet/Result/PublishDate	反映日（RFC3339）
/ResultSet/Result/EditingFlag	編集フラグ 0 : 反映済み 1 : 編集されてからフロント反映されていない状態
/ResultSet/Result/LinkedItems
/ResultSet/Result/LinkedItems/ItemCode	追加画像を利用している商品コード

サンプルレスポンス

<?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>

2021年8月以降のレスポンス（サンプル）※画像関連部分のみ抜粋

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsAvailable="XX" totalResultsReturned="XX" firstResultPosition="XX">
    <Result>
        :
        <Url>https://shopping.c.yimg.jp/lib/teststore/sample1.gif</Url>
        :
　　　　<LinkedItems>
　　　　　　<ItemCode>639124-001</ItemCode>
　　　　　　<ItemCode>639124-002</ItemCode>
　　　　</LinkedItems>
    </Result>
</ResultSet>

エラー

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

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

利用制限

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

利用約款

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