商品画像アップロードAPI

商品画像を未反映状態でアップロードします。
※ フロント反映はしません。別途反映処理が必要です。

サンプルコード（PHP版）をご用意しています。こちらをご確認ください。

変更履歴

リクエストURL

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

リクエストパラメータ

「RESTリクエストの構築（POST）」をご参照ください。

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/uploadItemImage?seller_id=teststore

サンプルリクエスト

POST /ShoppingWebService/V1/uploadItemImage?seller_id=teststore HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

file=(sample1.jpg)

レスポンスフィールド

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
    <Status>OK</Status>
    <Result>
        <Id>teststore_sample1</Id>
        <Name>sample1.jpg</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>
    </Result>
</ResultSet>

2021年8月以降のレスポンス（サンプル）

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
    <Status>OK</Status>
    <Result>
    :

　　※リリース前にアップロードされた画像については、今までの画像URLパスで返却されます。
 
        <Url>
            <ModeA>https://item-shopping.c.yimg.jp/i/a/teststore_sample1_i_20210705100000</ModeA>
            <ModeB>https://item-shopping.c.yimg.jp/i/b/teststore_sample1_i_20210705100000</ModeB>
            <ModeC>https://item-shopping.c.yimg.jp/i/c/teststore_sample1_i_20210705100000</ModeC>
            <ModeD>https://item-shopping.c.yimg.jp/i/d/teststore_sample1_i_20210705100000</ModeD>
            <ModeE>https://item-shopping.c.yimg.jp/i/e/teststore_sample1_i_20210705100000</ModeE>
            <ModeF>https://item-shopping.c.yimg.jp/i/f/teststore_sample1_i_20210705100000</ModeF>
            <ModeG>https://item-shopping.c.yimg.jp/i/g/teststore_sample1_i_20210705100000</ModeG>
            <ModeH>https://item-shopping.c.yimg.jp/i/h/teststore_sample1_i_20210705100000</ModeH>
            <ModeI>https://item-shopping.c.yimg.jp/i/i/teststore_sample1_i_20210705100000</ModeI>
            <ModeJ>https://item-shopping.c.yimg.jp/i/j/teststore_sample1_i_20210705100000</ModeJ>
            <ModeK>https://item-shopping.c.yimg.jp/i/k/teststore_sample1_i_20210705100000</ModeK>
            <ModeL>https://item-shopping.c.yimg.jp/i/l/teststore_sample1_i_20210705100000</ModeL>
        </Url>
     
 
　　// 商品詳細画像の場合

        <Url>
            <ModeA>https://item-shopping.c.yimg.jp/i/a/teststore_sample1_1_d_20210705100000</ModeA>
            <ModeB>https://item-shopping.c.yimg.jp/i/b/teststore_sample1_1_d_20210705100000</ModeB>
            <ModeC>https://item-shopping.c.yimg.jp/i/c/teststore_sample1_1_d_20210705100000</ModeC>
            <ModeD>https://item-shopping.c.yimg.jp/i/d/teststore_sample1_1_d_20210705100000</ModeD>
            <ModeE>https://item-shopping.c.yimg.jp/i/e/teststore_sample1_1_d_20210705100000</ModeE>
            <ModeF>https://item-shopping.c.yimg.jp/i/f/teststore_sample1_1_d_20210705100000</ModeF>
            <ModeG>https://item-shopping.c.yimg.jp/i/g/teststore_sample1_1_d_20210705100000</ModeG>
            <ModeH>https://item-shopping.c.yimg.jp/i/h/teststore_sample1_1_d_20210705100000</ModeH>
            <ModeI>https://item-shopping.c.yimg.jp/i/i/teststore_sample1_1_d_20210705100000</ModeI>
            <ModeJ>https://item-shopping.c.yimg.jp/i/j/teststore_sample1_1_d_20210705100000</ModeJ>
            <ModeK>https://item-shopping.c.yimg.jp/i/k/teststore_sample1_1_d_20210705100000</ModeK>
            <ModeL>https://item-shopping.c.yimg.jp/i/l/teststore_sample1_1_d_20210705100000</ModeL>
        </Url>
    :
    </Url>
    </Result>
</ResultSet>

エラー

商品画像アップロードAPIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

商品系API共通エラーコード

エラーコード

サンプルコード（PHP）

<?php

  $header = [
      'Content-Type: multipart/form-data',
      'POST /ShoppingWebService/V1/uploadItemImage?seller_id=＜ストアアカウント＞ HTTP/1.1',
      'Host: circus.shopping.yahooapis.jp',
      'Authorization: Bearer ' . ＜アクセストークン＞,
  ];

  $url   = 'https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/uploadItemImage?seller_id=＜ストアアカウント＞';
  $param = array('file' => new CURLFile('＜ファイルのパス＞', '＜ファイルのMIMEタイプ＞', '＜ファイルの名前＞'));

  // 必要に応じてオプションを追加してください。
  $ch = curl_init();
  curl_setopt($ch, CURLOPT_CUSTOMREQUEST,  'POST');
  curl_setopt($ch, CURLOPT_HTTPHEADER,     $header);
  curl_setopt($ch, CURLOPT_URL,            $url);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_POST,           true);
  curl_setopt($ch, CURLOPT_POSTFIELDS,     $param);

  $response = curl_exec($ch);
  curl_close($ch);

?>

利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。（1クエリー/秒）
1日50,000リクエストを超える場合は、アプリケーションIDを追加してご対応ください。

利用約款

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