ショッピング
商品画像削除API
商品画像を削除反映待ちの状態にします。
※未反映・反映済、共に削除反映待ちの状態にします。
※ フロント反映はしません。別途反映処理が必要です。
変更履歴(2018年10月15日)
バリエーション画像機能リリースに伴い、エラーコード「im-09001」を追加しました。
リクエストURl
リクエストURL
本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/deleteItemImage
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/deleteItemImage
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。
リクエストパラメータ
「RESTリクエストの構築(POST)」をご参照ください。
パラメータ | 値 | 説明 |
---|---|---|
seller_id (必須) |
string | ストアアカウントを指定します。 |
image_id (必須) |
string | 削除対象画像IDを指定します。 カンマ","区切りで複数画像を削除することができます。(最大100件) 画像IDの形式:"ストアアカウント_画像名の拡張子除く文字列" ※商品詳細画像の場合は、画像ID_(1-20) |
サンプルリクエストURL
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/deleteItemImageサンプルリクエスト
POST /ShoppingWebService/V1/deleteItemImage HTTP/1.1Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>
seller_id=teststore
レスポンスフィールド
フィールド | 説明 |
---|---|
/ResultSet | クエリーレスポンスのすべてを含み、次の属性を持ちます。
|
/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 | 対象の商品画像は存在しません。 |
im-09001 | 200 | 個別商品コード画像として使用されているため削除できません。 画像名:%s |
利用制限
※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を緩和させていただきます。(無料)
申請受付は停止中です。
1日50,000リクエストを超える場合は、アプリケーションIDを追加してご対応ください。
利用約款
このAPIに関する利用約款はこちら。