商品画像削除API

商品画像を削除反映待ちの状態にします。
※未反映・反映済、共に削除反映待ちの状態にします。
※ フロント反映はしません。別途反映処理が必要です。

変更履歴

リクエストURl

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

リクエストパラメータ

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

パラメータ	値	説明
seller_id （必須）	string	ストアアカウントを指定します。
image_id （必須）	string	削除対象画像IDを指定します。 カンマ","区切りで複数画像を削除することができます。（最大100件） 画像IDの形式："ストアアカウント_画像名の拡張子除く文字列" ※商品詳細画像の場合は、画像ID_(1-20) ※2022年5月以降、画像ファイル名のルールが変更になります。 　リリース後に登録した画像については、「ストアアカウント_画像名_i_登録日時」「ストアアカウント_画像名_d_登録日時」のファイル名をご指定ください。

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/deleteItemImage

サンプルリクエスト

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

seller_id=teststore&image_id=teststore_sample1%2Cteststore_sample2%2Cteststore_sample3

レスポンスフィールド

フィールド	説明
/ResultSet	クエリーレスポンスのすべてを含み、次の属性を持ちます。 totalResultsAvailable : 該当件数の総個数です。 okResultsCount : 成功の数です。 ngResultsCount : 失敗の数です。
/ResultSet/Result	結果
/ResultSet/Result/Status	NG : 失敗　OK : 成功
/ResultSet/Result/Id	画像ID（ストアアカウント_画像名の拡張子除く文字列）
/ResultSet/Result/ErrorCode	エラーコード
/ResultSet/Result/ErrorMessage	エラーメッセージ

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsAvailable="3" okResultsCount="2" ngResultsCount="1">
    <Result>
        <Status>OK</Status>
        <Id>teststore_sample1</Id>
    </Result>
    <Result>
        <Status>OK</Status>
        <Id>teststore_sample2</Id>
    </Result>
    <Result>
        <Status>NG</Status>
        <Id>teststore_sample3</Id>
        <ErrorCode>im-00002</ErrorCode>
        <ErrorMessage>削除に失敗しました。</ErrorMessage>
    </Result>
</ResultSet>

エラー

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

• 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-04001	400	image_idは必須項目です。
im-04002	400	対象の商品画像は存在しません。＊レスポンスのエラーに移動
im-04003	400	削除処理に失敗しました。
im-04004	400	image_idの指定数が100を超えています。
im-04005	400	image_idの値が不正です。
im-04101	200	削除に失敗しました。
im-04102	200	画像IDの指定が間違っています。
im-04103	200	DB更新に失敗しました。
im-04104	200	対象の商品画像は存在しません。
im-09001	200	個別商品コード画像として使用されているため削除できません。 画像名：%s
im-09003	200	セール期間中の商品に紐づく画像は削除できません。

利用制限

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

利用約款

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