オークション

マイオークション表示(値下げ交渉)

本APIは提供を終了いたします。
詳細につきましては、以下をご覧ください。
【再掲】【重要】オークションWeb API提供終了(2018年2月22日)のお知らせ

リクエストURL
XML
https://auctions.yahooapis.jp/AuctionWebService/V1/myOfferList

※2012/11/7以前に取得されたOAuth1.0のConsumer Keyをご利用頂く場合のリクエストURLは
http://auctions.yahooapis.jp/AuctionWebService/V1/myOfferList となります

ログインしているYahoo! JAPAN IDのマイ・オークションの「値下げ交渉」を参照します。

リクエストパラメータ

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

パラメータ 説明
output string XML、PHPserialize、JSONPでレスポンスの出し別けを行います。
  • xml :xmlレスポンス(デフォルト)
  • php :PHPserializeレスポンス
  • json :JSONPレスポンス
callback string JSONPとして出力する際のコールバック関数名を入力するためのパラメータです。UTF-8でエンコードした文字列を入力します。
start integer 参照するページ番号を指定します。
list offer(デフォルト)/dec_offer 一覧の種類を指定します。
  • offer :交渉中の一覧を返却します。
  • dec_offer :交渉未成立の一覧を返却します。
sort item/bidorbuy/
ofpr/ofut
(デフォルト:ofut)
リストの並べ替え項目を指定します。指定のない場合は交渉期限の短い順になります。
  • item :タイトル
  • bidorbuy :即決価格
  • ofpr :交渉価格
  • ofut :交渉期限
項目の前に以下の記号を付与することで、昇順降順を変更できます。+(昇順)/-(降順) ※UTF-8にエンコードされている必要あり。(※listにdec_offerを指定した場合、無効となります)
results 【NEW】 integer 結果の件数を指定するためのパラメータです。デフォルトは50、最大100まで指定可能です。

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

※アプリケーションIDを取得する際に「マイ・オークション関連の機能」スコープを選択してください。
スコープの詳細は、「スコープに関して」でご確認ください。


サンプルリクエストURL

https://auctions.yahooapis.jp/AuctionWebService/V1/myOfferList?start=<参照するページ番号>

サンプルリクエスト

GET /AuctionWebService/V1/myOfferList?start=<参照するページ番号> HTTP/1.1
Host: auctions.yahooapis.jp
Authorization: Bearer <アクセストークン> 



レスポンスフィールド

マイオークション表示(値下げ交渉)APIのスキーマの記述は、以下になります。

フィールド 説明
/ResultSet クエリーレスポンスのすべてを含み、次の属性を持ちます。
  • totalResultsAvailable:該当件数の総個数です。
  • totalResultsReturned:返された値の個数です。
  • firstResultPosition:最初のデータが何個目に当たるかです。
/ResultSet/Result 各個別レスポンスを含みます。
/ResultSet/Result/AuctionId 商品(オークション)のIDです。
/ResultSet/Result/Title 商品(オークション)のタイトルです。
/ResultSet/Result/BidorbuyPrice 即決価格です。¥記号やカンマは含みません。小数点第二位までの精度です。
/ResultSet/Result/OfferPrice 交渉価格です。¥記号やカンマは含みません。小数点第二位までの精度です。 複数回交渉を行った場合、最新の交渉価格が表示されます。 パラメータlistの値がdec_offerの場合も、最後に交渉した価格が表示されます。
/ResultSet/Result/OfferLeftTime 交渉期限日時です。RFC3339に準拠した表現を用います。
(例:2004-04-01T12:00:00+09:00)
パラメータlistの値がdec_offerの場合は空データが返却されます。
/ResultSet/Result/OfferEnabled 【NEW】 交渉が可能かどうかを返します。(交渉可能:true 交渉不可:false
パラメータlistの値がofferの場合は交渉中のため常にfalseを返します。
/ResultSet/Result/AuctionItemUrl 商品(オークション)のURLです。
/ResultSet/Result/Image 画像(サムネイル)の設定です。
/ResultSet/Result/Image/Url 画像(サムネイル)のURLです。
/ResultSet/Result/Image/Width サムネイルの横幅です。
/ResultSet/Result/Image/Height サムネイルの縦幅です。
/ResultSet/Result/CharityOption 【NEW】 チャリティオプションの情報です。
/ResultSet/Result/CharityOption/Proportion 【NEW】 チャリティオプション寄付率、未設定の場合は0
/ResultSet/Result/Option 各オプションの設定状況です。
/ResultSet/Result/Option/StoreIconUrl ストア商品の場合ストアアイコンのURLが設定されます。設定されていない場合空データが返却されます。
/ResultSet/Result/Option/CheckIconUrl 「鑑定済み」アイコンのURLです。設定されていない場合空データが返却されます。
/ResultSet/Result/Option/FeaturedIconUrl 注目のオークション設定アイコンのURLです。設定されていない場合空データが返却されます。
/ResultSet/Result/Option/FreeshippingIconUrl 「送料無料」のアイコンのURLです。設定されていない場合空データが返却されます。
/ResultSet/Result/Option/NewItemIconUrl 「新品」アイコンのURLです。設定されていない場合空データが返却されます。
/ResultSet/Result/Option/GiftIconUrl 「目立ち」アイコンのURLです。設定されていない場合空データが返却されます。
/ResultSet/Result/Option/WrappingIconUrl 「贈答品」アイコンのURLです。設定されていない場合空データが返却されます。
/ResultSet/Result/Option/BuynowIconUrl 「即買」アイコンのURLです。設定されていない場合空データが返却されます。
/ResultSet/Result/Option/EasyPaymentIconUrl 「Yahoo!かんたん決済」アイコンのURLです。設定されていない場合空データが返却されます。
/ResultSet/Result/Option/PointIconUrl 「Tポイント」アイコンのURLです。設定されていない場合空データが返却されます。
/ResultSet/Result/Option/CharityOptionIconUrl 「チャリティオプション」アイコンのURLです。(10%用と100%用あり)
/ResultSet/Result/Option/IsBold 太字設定の有無です。(あり:true なし:false
/ResultSet/Result/Option/IsBackGroundColor 背景色設定の有無です。(あり:true なし:false
/ResultSet/Result/Option/IsCharity 「チャリティオプション」設定あり(true)、なし(false)



サンプルレスポンス

<?xml version="1.0" encoding="utf-8" ?>
<ResultSet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:yahoo:jp:auc:myOfferList" xsi:schemaLocation="urn:yahoo:jp:auc:myOfferList http://auctions.yahooapis.jp/AuctionWebService/V1/myOfferList.xsd" totalResultsAvailable="1" totalResultsReturned="1" firstResultPosition="1">
  <Result>
    <AuctionId>x125787</AuctionId>
    <Title>テスト商品です。入札はお控えください5</Title>
    <BidorbuyPrice>200.00</BidorbuyPrice>
    <OfferPrice>100.00</OfferPrice>
    <OfferLeftTime>2013-02-20T18:02:12+09:00</OfferLeftTime>
    <OfferEnabled>false</OfferEnabled>
    <AuctionItemUrl>http://pageX.auctions.yahoo.co.jp/jp/auction/x125787</AuctionItemUrl>
    <Image>
      <Url>http://image.auctions.yahoo.co.jp/images/na_75x75.gif</Url>
      <Width>75</Width>
      <Height>75</Height>
    </Image>
    <CharityOption>
      <Proportion>0</Proportion>
    </CharityOption>
    <Option>
      <StoreIconUrl/>
      <CheckIconUrl/>
      <FeaturedIconUrl/>
      <FreeShippingIconUrl/>
      <EscrowIconUrl/>
      <NewItemIconUrl/>
      <GiftIconUrl/>
      <WrappingIconUrl/>
      <BuynowIconUrl>http://image.auctions.yahoo.co.jp/images/buynow.gif</BuynowIconUrl>
      <YBankIconUrl/>
      <EasyPaymentIconUrl/>
      <PointIconUrl/>
      <EnglishIconUrl/>
      <CharityOptionIconUrl></CharityOptionIconUrl>
      <IsBold>false</IsBold>
      <IsBackGroundColor>false</IsBackGroundColor>
      <IsCharity>false</IsCharity>
    </Option>
  </Result>
</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: 6: "Result";
    a: 10: {
      s: 9: "AuctionId";
      s: 7: "x125787";
      s: 5: "Title";
      s: 55: "テスト商品です。入札はお控えください5";
      s: 13: "BidorbuyPrice";
      s: 6: "200.00";
      s: 10: "OfferPrice";
      s: 6: "100.00";
      s: 13: "OfferLeftTime";
      s: 25: "2013-02-20T18:02:12+09:00";
      s: 12: "OfferEnabled";
      b: 0;
      s: 14: "AuctionItemUrl";
      s: 53: "http://pageX.auctions.yahoo.co.jp/jp/auction/x125787";
      s: 5: "Image";
      a: 3: {
        s: 3: "Url";
        s: 53: "http://image.auctions.yahoo.co.jp/images/na_75x75.gif";
        s: 5: "Width";
        s: 2: "75";
        s: 6: "Height";
        s: 2: "75";
      }
      s: 13: "CharityOption";
      a: 1: {
        s: 10: "Proportion";
        s: 1: "0";
      }
      s: 6: "Option";
      a: 17: {
        s: 12: "StoreIconUrl";
        s: 0: "";
        s: 12: "CheckIconUrl";
        s: 0: "";
        s: 15: "FeaturedIconUrl";
        s: 0: "";
        s: 19: "FreeShippingIconUrl";
        s: 0: "";
        s: 13: "EscrowIconUrl";
        s: 0: "";
        s: 14: "NewItemIconUrl";
        s: 0: "";
        s: 11: "GiftIconUrl";
        s: 0: "";
        s: 15: "WrappingIconUrl";
        s: 0: "";
        s: 13: "BuynowIconUrl";
        s: 51: "http://image.auctions.yahoo.co.jp/images/buynow.gif";
        s: 12: "YBankIconUrl";
        s: 0: "";
        s: 18: "EasyPaymentIconUrl";
        s: 0: "";
        s: 12: "PointIconUrl";
        s: 0: "";
        s: 14: "EnglishIconUrl";
        s: 0: "";
        s: 20: "CharityOptionIconUrl";
        s: 0: "";
        s: 6: "IsBold";
        b: 0;
        s: 17: "IsBackGroundColor";
        b: 0;
        s: 9: "IsCharity";
        b: 0;
      }
    }
  }
}

サンプルレスポンス(JSONP)

loaded({
  "ResultSet": {
    "@attributes": {
      "totalResultsAvailable": "1",
      "totalResultsReturned": "1",
      "firstResultPosition": "1"
    },
    "Result": {
      "AuctionId": "x125787",
      "Title": "\u30c6\u30b9\u30c8\u5546\u54c1\u3067\u3059\u3002\u5165\u672d\u306f\u304a\u63a7\u3048\u304f\u3060\u3055\u30445",
      "BidorbuyPrice": "200.00",
      "OfferPrice": "100.00",
      "OfferLeftTime": "2013-02-20T18:02:12+09:00",
      "OfferEnabled": "false",
      "AuctionItemUrl": "http:\/\/pageX.auctions.yahoo.co.jp\/jp\/auction\/x125787",
      "Image": {
        "Url": "http:\/\/image.auctions.yahoo.co.jp\/images\/na_75x75.gif",
        "Width": "75",
        "Height": "75"
      },
      "CharityOption": {
        "Proportion": "0"
      },
      "Option": {
        "StoreIconUrl": {},
        "CheckIconUrl": {},
        "FeaturedIconUrl": {},
        "FreeShippingIconUrl": {},
        "EscrowIconUrl": {},
        "NewItemIconUrl": {},
        "GiftIconUrl": {},
        "WrappingIconUrl": {},
        "BuynowIconUrl": "http:\/\/image.auctions.yahoo.co.jp\/images\/buynow.gif",
        "YBankIconUrl": {},
        "EasyPaymentIconUrl": {},
        "PointIconUrl": {},
        "EnglishIconUrl": {},
        "CharityOptionIconUrl": {},
        "IsBold": "false",
        "IsBackGroundColor": "false",
        "IsCharity": "false"
      }
    }
  }
})



エラー

マイオークション表示(値下げ交渉)はYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。




利用制限

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