追加画像削除API

追加画像を削除反映待ちの状態にします。
※未反映・反映済、共に削除反映待ちの状態にします。
※2022年5月以降、登録と同時に本番環境へ反映処理が流れます。
別途反映処理する必要はございません。
出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。

変更履歴

リクエストURL

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

リクエストパラメータ

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

パラメータ	値	説明
seller_id （必須）	string	ストアアカウントを指定します。
file_name （必須）	string	削除対象の追加画像ファイル名を指定します。 カンマ","区切りで複数ファイルを削除することができます。（最大100件）

サンプルリクエストURL

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

サンプルリクエスト

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

seller_id=teststore&file_name=sample1.jpg%2Csample2.jpg%2Csample3.jpg

レスポンスフィールド

フィールド	説明
/ResultSet	クエリーレスポンスのすべてを含み、次の属性を持ちます。 totalResultsAvailable : 該当件数の総個数です。 okResultsCount : 成功の数です。 ngResultsCount : 失敗の数です。
/ResultSet/Result	結果
/ResultSet/Result/Status	NG : 失敗　OK : 成功
/ResultSet/Result/Name	ファイル名
/ResultSet/Result/ErrorCode	エラーコード
/ResultSet/Result/ErrorMessage	エラーメッセージ

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsAvailable="3" okResultsCount=2 ngResultsCount=1>
    <Result>
        <Status>OK</Status>
        <Name>sample1.jpg</Name>
    </Result>
    <Result>
        <Status>OK</Status>
        <Name>sample2.jpg</Name>
    </Result>
    <Result>
        <Status>NG</Status>
        <Name>sample3.jpg</Name>
        <ErrorCode>im-00000</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-08001	400	file_nameは必須項目です。
im-08002	400	file_nameが不正な値です。
im-08003	400	削除処理に失敗しました。
im-08004	400	file_nameの指定数が100を超えています。
im-08101	200	削除に失敗しました。
im-09001	200	個別商品コード画像として使用されているため削除できません。 画像名：%s
im-09003	200	セール期間中の商品に紐づく画像は削除できません。

利用制限

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

利用約款

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