マイ・オークション削除(落札分)
※2012/11/7以前に取得されたOAuth1.0のConsumer Keyをご利用頂く場合のリクエストURLは
http://auctions.yahooapis.jp/AuctionWebService/V1/deleteMyWonList となります
ログインしているYahoo! JAPAN IDのマイ・オークションの「落札分」から商品を削除します。
リクエストパラメータ
「RESTリクエストの構築(GET)」をご参照ください。
パラメータ | 値 | 説明 |
---|---|---|
output | string |
XML、PHPserialize、JSONPでレスポンスの出し別けを行います。
|
callback | string | JSONPとして出力する際のコールバック関数名を入力するためのパラメータです。UTF-8でエンコードした文字列を入力します。 |
auctionID(必須) | string | 削除するオークションのオークションIDを指定します。 指定するオークションIDはカンマ区切りで最大20まで指定可能です。 |
※こちらのAPIはYahoo! ID連携に対応したAPIです。
Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。
・Yahoo! ID連携
・Yahoo! ID連携によるAPIアクセス実装方法
※アプリケーションIDを取得する際に「マイ・オークション関連の機能」スコープを選択してください。
スコープの詳細は、「スコープに関して」でご確認ください。
サンプルリクエストURL
https://auctions.yahooapis.jp/AuctionWebService/V1/deleteMyWonList?サンプルリクエスト
GET /AuctionWebService/V1/deleteMyWonList?Host: auctions.yahooapis.jp
Authorization: Bearer <アクセストークン>
レスポンスフィールド
マイ・オークション削除(落札分)APIのスキーマの記述は、以下になります。
フィールド | 説明 |
---|---|
/ResultSet | クエリーレスポンスのすべてを含みます。
|
/ResultSet/DeleteResultSet | 削除要求の結果セットです。 |
/ResultSet/DeleteResultSet/Result | 各個別レスポンスを含みます。 |
/ResultSet/DeleteResultSet/Result/auctionID | オークションIDです。 |
/ResultSet/DeleteResultSet/Result/result | 結果です。(成功:true 失敗:false) |
/ResultSet/DeleteResultSet/MyWonListURL | マイ・オークション(落札分)のリクエストURLです。(パラメータは設定されません) |
サンプルレスポンス
<?xml version="1.0" encoding="UTF-8" ?> <ResultSet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:yahoo:jp:auc:DeleteMyWonList" xsi:schemaLocation="urn:yahoo:jp:auc:DeleteMyWonList http://auctions.yahooapis.jp/AuctionWebService/V1/DeleteMyWonList.xsd" totalResultsAvailable="1" totalResultsReturned="1" firstResultPosition="1"> <DeleteResultSet> <Result> <auctionID>x125511</auctionID> <result>true</result> </Result> <MyWonListUrl>http://auctions.yahooapis.jp/AuctionWebService/V1/myWonList</MyWonListUrl> </DeleteResultSet> </ResultSet>
サンプルレスポンス(PHPserialize)
a: 1: { s: 9: "ResultSet"; a: 4: { s: 21: "totalResultsAvailable"; s: 1: "1"; s: 20: "totalResultsReturned"; s: 1: "1"; s: 19: "firstResultPosition"; s: 1: "1"; s: 15: "DeleteResultSet"; a: 2: { s: 6: "Result"; a: 2: { s: 9: "auctionID"; s: 7: "x125511"; s: 6: "result"; b: 1; } s: 12: "MyWonListUrl"; s: 59: "http://auctions.yahooapis.jp/AuctionWebService/V1/myWonList"; } } }
サンプルレスポンス(JSONP)
loaded({ "ResultSet": { "@attributes": { "totalResultsAvailable": "1", "totalResultsReturned": "1", "firstResultPosition": "1" }, "DeleteResultSet": { "Result": { "auctionID": "x125511", "result": "true" }, "MyWonListUrl": "http:\/\/auctions.yahooapis.jp\/AuctionWebService\/V1\/myWonList" } } })
エラー
マイ・オークション削除(落札分)はYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。
このWeb APIはOAuth対応のWeb APIに共通の エラーメッセージおよびコード を返します。
利用制限
※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を解除させていただきます。(無料)
まずはヘルプページのお問い合わせフォームからご相談ください。