商品画像一覧API

アップロード済みの商品画像の検索および一覧取得を行います。

変更履歴

2022年04月08日

下記レスポンスフィールドの説明を修正しました。
・/ResultSet/Result/Id
・/ResultSet/Result/Url
・/ResultSet/Result/Url/Mode[A-L]

リクエストURL

本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/itemImageList
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/itemImageList

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

リクエストパラメータ

「Web APIの使い方#GETとは」をご参照ください。

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

※1 どちらか片方のパラメータが必須です。

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/ItemImageList?&seller_id=teststore&stcat_key=a5aba5c6a53&query=item1&start=10&results=50&sort=%2Bname

サンプルリクエスト


GET /ShoppingWebService/V1/ItemImageList?seller_id=teststore&stcat_key=a5aba5c6a53&query=item1&start=10&results=50&sort=%2Bname HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

レスポンスフィールド

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

  • totalResultsAvailable : 該当件数の総個数です。
  • totalResultsReturned : 返された値の個数です。
  • firstResultPosition : 最初のデータが何個目に当たるかです。
/ResultSet/Result 結果
/ResultSet/Result/Id 画像ID（ストアアカウント_画像名の拡張子除く文字列）
※2022年5月以降、画像ファイル名ルールが変更になります。登録日時などが都度発行されます。詳しくはこちら。
/ResultSet/Result/Name 画像名
/ResultSet/Result/Url 画像URL（反映状態の画像を参照するURL）

未反映状態の画像は空になります。
※2022年5月以降、今後、本番URLとなり、ドメインが変更になります。出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/Url/Mode[A-L] 画像表示モードごとのURL
※2022年5月以降、今後、本番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>
        <Id>teststore_sample1</Id>
        <Name>sample1.gif</Name>
        <Url>
            <ModeA>http://preview.image.shopping.yahoo.co.jp/RT/i/a/teststore_sample1</ModeA>
            <ModeB>http://preview.image.shopping.yahoo.co.jp/RT/i/b/teststore_sample1</ModeB>
            <ModeC>http://preview.image.shopping.yahoo.co.jp/RT/i/c/teststore_sample1</ModeC>
            <ModeD>http://preview.image.shopping.yahoo.co.jp/RT/i/d/teststore_sample1</ModeD>
            <ModeE>http://preview.image.shopping.yahoo.co.jp/RT/i/e/teststore_sample1</ModeE>
            <ModeF>http://preview.image.shopping.yahoo.co.jp/RT/i/f/teststore_sample1</ModeF>
            <ModeG>http://preview.image.shopping.yahoo.co.jp/RT/i/g/teststore_sample1</ModeG>
            <ModeH>http://preview.image.shopping.yahoo.co.jp/RT/i/h/teststore_sample1</ModeH>
            <ModeI>http://preview.image.shopping.yahoo.co.jp/RT/i/i/teststore_sample1</ModeI>
            <ModeJ>http://preview.image.shopping.yahoo.co.jp/RT/i/j/teststore_sample1</ModeJ>
            <ModeK>http://preview.image.shopping.yahoo.co.jp/RT/i/k/teststore_sample1</ModeK>
            <ModeL>http://preview.image.shopping.yahoo.co.jp/RT/i/l/teststore_sample1</ModeL>
        </Url>
        <Size>600×450px</Size>
        <FileSize>36447</FileSize>
        <UploadDate>2013-02-06T16:58:32+09:00</UploadDate>
        <PublishDate>2013-02-06T16:58:32+09:00</PublishDate>
        <EditingFlag>0</EditingFlag>
    </Result>
    <Result>
        <Id>teststore_sample2</Id>
        <Name>sample2.gif</Name>
        <Url>
            <ModeA>http://preview.image.shopping.yahoo.co.jp/RT/i/a/teststore_sample2</ModeA>
            <ModeB>http://preview.image.shopping.yahoo.co.jp/RT/i/b/teststore_sample2</ModeB>
            <ModeC>http://preview.image.shopping.yahoo.co.jp/RT/i/c/teststore_sample2</ModeC>
            <ModeD>http://preview.image.shopping.yahoo.co.jp/RT/i/d/teststore_sample2</ModeD>
            <ModeE>http://preview.image.shopping.yahoo.co.jp/RT/i/e/teststore_sample2</ModeE>
            <ModeF>http://preview.image.shopping.yahoo.co.jp/RT/i/f/teststore_sample2</ModeF>
            <ModeG>http://preview.image.shopping.yahoo.co.jp/RT/i/g/teststore_sample2</ModeG>
            <ModeH>http://preview.image.shopping.yahoo.co.jp/RT/i/h/teststore_sample2</ModeH>
            <ModeI>http://preview.image.shopping.yahoo.co.jp/RT/i/i/teststore_sample2</ModeI>
            <ModeJ>http://preview.image.shopping.yahoo.co.jp/RT/i/j/teststore_sample2</ModeJ>
            <ModeK>http://preview.image.shopping.yahoo.co.jp/RT/i/k/teststore_sample2</ModeK>
            <ModeL>http://preview.image.shopping.yahoo.co.jp/RT/i/l/teststore_sample2</ModeL>
        </Url>
        <Size>600×450px</Size>
        <FileSize>36447</FileSize>
        <UploadDate>2013-02-06T16:58:32+09:00</UploadDate>
        <PublishDate/>
        <EditingFlag>1</EditingFlag>
    </Result>
</ResultSet>

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

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsAvailable="XX" totalResultsReturned="XX" firstResultPosition="XX">
    <Result>
        :
        
    ※追加画像が紐づいている場合は、Lサイズのみの返却となります。    
    
    <Url>
　    <ModeA></ModeA>
　    <ModeB></ModeB>
　    <ModeC></ModeC>
　    <ModeD></ModeD>
　    <ModeE></ModeE>
　    <ModeF></ModeF>
　    <ModeG></ModeG>
　    <ModeH></ModeH>
　    <ModeI></ModeI>
　    <ModeJ></ModeJ>
　    <ModeK></ModeK>
　    <ModeL>https://shopping.c.yimg.jp/lib/teststore/detail20.jpg?size=l</ModeL>
    </Url>
        :
    </Result>
</ResultSet>

エラー

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

商品画像一覧APIで固有に返すエラーコードは以下をご覧ください。

商品系API共通エラーコード
コード HTTPステータスコード 説明
ed-00000 404 ページが見つかりません。
ed-00001 500 システムエラーが発生しました。
ed-00002 503 サーバがメンテナンス中です。
ed-00003 400 ストアアカウントが指定されていません。
ed-00004 400 ストアアカウントが存在しません。
ed-00005 400 ストアアカウントの指定が不正です。
エラーコード
コード HTTPステータスコード 説明
im-01001 400 stcat_keyかqueryのどちらかは必須です。
im-01002 400 指定されたストアカテゴリページキーが見つかりません。
im-01003 400 ページキーが不正です。
im-01004 400 検索ワードが不正です。
im-01005 400 取得位置が不正です。
im-01006 400 取得件数が不正です。
im-01007 400 ソートオプションが不正です。
im-01008 400 取得件数の最大です。

利用制限

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

利用約款

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

アプリケーションの管理

目次

利用のルール

開発のヒント