ショッピング

商品画像削除API

リクエストURL
XML
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/deleteItemImage


こちらはテスト用APIもご利用いただけます。URLは以下の通りです。
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/deleteItemImage
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。

商品画像を削除反映待ちの状態にします。(フロント反映はしません)
※未反映・反映済、共に削除反映待ちの状態にします。

リクエストパラメータ

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

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
image_id
(必須)
string 削除対象画像IDを指定します。
カンマ","区切りで複数画像を削除することができます。(最大100件)

画像IDの形式:"ストアアカウント_画像名の拡張子除く文字列"
※商品詳細画像の場合は、画像ID_(1-5)

※こちらのAPIはYahoo! ID連携に対応したAPIです。
Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。
Yahoo! ID連携
Yahoo! ID連携によるAPIアクセス実装方法

※こちらのAPIを利用する場合は、こちらからアプリケーションIDを取得してください。


サンプルリクエスト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>



エラー

商品画像削除APIはYahoo! JAPAN Web 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 対象の商品画像は存在しません。




利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を解除させていただきます。(無料)
まずはヘルプページのお問い合わせフォームからご相談ください。

利用約款

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