ショッピング

ファイル削除API

  • 出店者様側でアップロードしたファイルを削除します。

※すでにメッセージに投稿しているファイルは削除できません。
 アップロード済みで投稿をしていないファイルのみ適用が可能です。

リクエストURL

リクエストURL(JSON)
本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkFileDelete
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkFileDelete

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



リクエストパラメータ

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

パラメータ 必須 値の例 説明
key string ファイル投稿APIからレスポンスされるファイルの"objectKey"を指定する。
sellerId string teststore ストアアカウント

サンプルリクエストURL

 https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkFileDelete?
                               key=xxxxxx&sellerId=teststore
  

サンプルリクエスト

 DELETE https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkFileDelete?
                               key=xxxxxx&sellerId=teststore HTTP/1.1
 Host: circus.shopping.yahooapis.jp
 Authorization: Bearer <アクセストークン>
 
 

レスポンスフィールド

要素 値の例 説明
status string (下記参照) ok:成功
ng:失敗



サンプルレスポンス

レスポンス(JSON)

{
  "status": "ok"
}
  



エラー

ファイル削除APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

HTTPステータスコード 説明
400 Bad request. 渡されたパラメータがWebサービスで期待されたものと一致しない場合に返されます。
401 Unauthorized. 認証に失敗した場合に返されます。
404 Not found. 存在しないリソースにアクセスされた場合に返されます。
500 Internal Server Error. サーバー側で異常が発生した場合に返されます。
503 Service unavailable. 内部的な問題によってデータを返すことができない場合に返されます。


各エラーにおいて、次の形式のJSONレスポンスを返します。

フィールド 説明
error.reason エラー事由が記載されます。

{
     error : {
        reason: "Bad Request"
     }
}
  



ご注意

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

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

利用制限

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

利用約款

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