追加画像アップロードAPI
追加画像を未反映状態でアップロードします。
※ フロント反映はしません。別途反映処理が必要です。
※2022年5月以降、登録と同時に本番環境へ反映処理が流れます。
別途反映処理する必要はございません。
出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
※画像アップロード上限数は「10,000枚/1時間」までです。
上限を超えた場合、エラー(429)が返却される場合があります。
(参考)【Yahoo!ショッピング】【重要】商品データアップロードガイドラインのご案内
変更履歴
2024年11月12日
機能説明に画像のアップロード時の件数に制限が設定されたことを記載しました。
2022年06月13日
エラーコード「im-06001」の内容を修正しました。前)画像サイズを3メガバイト以下に変更して下さい。
後)画像サイズを2メガバイト以下に変更して下さい。
2022年04月08日
リクエストパラメータ「file」の説明を修正しました。
リクエストURL
本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/uploadLibImage
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/uploadLibImage
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。
リクエストパラメータ
「Web APIの使い方#POSTとは」をご参照ください。
パラメータ | 値 | 説明 |
---|---|---|
seller_id (必須) |
string | ストアアカウントを指定します。 GETパラメータで渡してください。 |
file (必須) |
multipart/form-data | 画像ファイルを指定します。 GIF/PNG/JPEG形式のみです。 画像一枚のサイズは、500キロバイト以下です。 ※2022年5月以降、画像サイズは2メガバイト以下となります。 出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。 |
directory | string (デフォルト : パーツ) |
アップロードする画像を格納する追加画像ディレクトリ名を指定します。 指定しない場合、「パーツ」ディレクトリに格納されます。 |
サンプルリクエストURL
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/uploadLibImage?seller_id=teststore
サンプルリクエスト
POST /ShoppingWebService/V1/uploadLibImage?seller_id=teststore HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>
file=(sample1.jpg)&directory=%E6%9C%AC
レスポンスフィールド
フィールド | 説明 |
---|---|
/ResultSet | クエリーレスポンスのすべてを含みます。 |
/ResultSet/Status | OK : 成功 |
サンプルレスポンス
<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
<Status>OK</Status>
</ResultSet>
エラー
Yahoo!ショッピングで提供している全てのAPIには、共通で利用するエラーコードがあります。エラーの際には、まず始めに以下をご確認ください。
追加画像アップロードAPIで固有に返すエラーコードは以下をご覧ください。
商品系API共通エラーコード
エラーコード | HTTPステータスコード | 説明 |
---|---|---|
ed-00000 | 404 | ページが見つかりません。 |
ed-00001 | 500 | システムエラーが発生しました。 |
ed-00002 | 503 | サーバがメンテナンス中です。 |
ed-00003 | 400 | ストアアカウントが指定されていません。 |
ed-00004 | 400 | ストアアカウントが存在しません。 |
ed-00005 | 400 | ストアアカウントの指定が不正です。 |
ed-00006 | 400 | 反映またはアップロード中のため更新ができません。 |
エラーコード
エラーコード | HTTPステータスコード | 説明 |
---|---|---|
im-06001 | 400 | 画像サイズを2メガバイト以下に変更して下さい。 |
im-06002 | 400 | ファイル名は255バイト以内です。 |
im-06003 | 400 | ファイル形式はGIF/PNG/JPEGのみです。 |
im-06004 | 400 | 半角英数字、ハイフン( - )、アンダーバー( _ )、ピリオド( . )のみ 使用できます。 |
im-06005 | 400 | アップロード容量制限オーバーです。 |
im-06006 | 400 | 画像処理中のためアップロードができません。 |
im-06007 | 400 | fileは必須項目です。 |
im-06008 | 400 | directoryは40バイト以内で入力してください。 |
利用約款
このAPIに関する利用約款はこちら。
目次
- 商品検索
- カテゴリランキング
- カテゴリID取得
- 商品コード検索(商品詳細)
- キーワードランキング
- おすすめ情報モジュール
- ポイントキャンペーン情報取得
- 販促イベント検索
- 商品レビュー検索
- 出品管理に関連するAPI
- 商品に関連するAPI
- 問い合わせ管理に関連するAPI
- 製品/SHPカテゴリ/ブランドに関連するAPI
- 在庫に関連するAPI
- ストアカテゴリに関連するAPI
- 画像に関連するAPI
- デザインに関連するAPI
- 注文に関するAPI
- ヘルプ