オークション
商品リスト
- Version 1
- Version 2
リクエストURL
XML
https://auctions.yahooapis.jp/AuctionWebService/V2/categoryLeaf
PHPserialize
https://auctions.yahooapis.jp/AuctionWebService/V2/php/categoryLeaf
JSONP
https://auctions.yahooapis.jp/AuctionWebService/V2/json/categoryLeaf
※PHPserialize、JSONPのリクエストURLは非推奨です。outputパラメータを利用してください。
ヤフオク!の商品リストを提供します。
リクエストパラメータ
「RESTリクエストの構築(GET)」および、「RESTリクエストの構築(POST)」をご参照ください。
パラメータ | 値 | 説明 |
---|---|---|
appid(必須) | string | アプリケーションのIDです。詳細はこちらをご覧ください。 |
output | string |
XML、PHPserialize、JSONPでレスポンスの出し別けを行います。
|
callback | string | JSONPとして出力する際のコールバック関数名を入力するためのパラメータです。UTF-8でエンコードした文字列を入力します。 |
category(必須) | integer | カテゴリのIDです。 |
page | integer | ページ番号です。指定しない場合は1ページ目のリクエストとみなします。 |
sort | string | ソート項目です。指定の無い場合は終了時間の昇順(近い順)になります。ただし、その商品リストに「注目のオークション」ある場合は、「注目のオークション(注目のオークション利用料の金額の降順)」「すべてのオークション(終了時間の昇順)」の順となります。
|
order | string | ソートの順番です。(a :昇順 d :降順) |
store | integer | 商品の出品区分の絞り込み指定です。
|
aucminprice | integer | 商品価格の範囲指定の下限値です。指定のない場合は下限値指定なしとみなします。 |
aucmaxprice | integer | 商品価格の範囲指定の上限値です。指定のない場合は上限値指定なしとみなします。 |
aucmin_bidorbuy_price | integer | 即決価格の範囲指定の下限値です。指定のない場合は下限値指定なしとみなします。 |
aucmax_bidorbuy_price | integer | 即決価格の範囲指定の上限値です。指定のない場合は上限値指定なしとみなします。 |
easypayment | integer | Yahoo!かんたん決済の利用が可能な商品の絞り込み指定です。指定のない場合はすべての商品になります。 |
new | integer | newアイコンのついた商品の絞り込み指定です。指定のない場合はすべての商品になります。 |
freeshipping | integer | 送料無料の商品の絞り込み指定です。指定のない場合はすべての商品になります。 |
wrappingicon | integer | 贈答品向き商品の絞り込み指定です。指定のない場合はすべての商品になります。 |
buynow | integer | 即決価格が設定されている商品の絞り込み指定です。指定のない場合はすべての商品になります。 |
thumbnail | integer | 画像のある商品の絞り込み指定です。指定のない場合はすべての商品になります。 |
attn | integer | 注目のオークションの商品の絞り込み指定です。指定のない場合はすべての商品になります。 |
point | integer | Tポイントの設定された商品の絞り込み指定です。指定のない場合はすべての商品になります。 |
gift_icon | integer | 目立ちアイコンのついた商品の絞り込み指定です。
|
item_status | integer | 商品状態での絞り込み指定です。
|
offer | integer | 値下げ交渉が設定された商品の絞り込み指定です。指定のない場合はすべての商品になります。 |
min_charity | integer | みんなのチャリティの寄付率の絞り込みの範囲指定の下限値です。(1~100) |
max_charity | integer | みんなのチャリティの寄付率の絞り込みの範囲指定の上限値です。(1~100) |
min_affiliate | integer | アフィリエイト料率の絞り込みの範囲指定の下限値です。(1~100) |
max_affiliate | integer | アフィリエイト料率の絞り込みの範囲指定の上限値です。(1~100) |
timebuf | integer | 指定された残り時間(s)を除外して絞り込む。 |
ranking 【NEW】 | stirng | 「sort=score」リクエスト指定時に有効になる表示順序です。
|
seller 【NEW】 | stirng | 出品者のYahoo! JAPAN IDで絞り込みを行います。コンマ(,)区切りで複数指定可能です。 |
サンプルリクエストURL
https://auctions.yahooapis.jp/AuctionWebService/V2/categoryLeaf?レスポンスフィールド
商品リストAPIのスキーマの記述は、以下になります。
フィールド | 説明 |
---|---|
/ResultSet | クエリーレスポンスのすべてを含み、次の属性を持ちます。
|
/ResultSet/Result | 各個別レスポンスを含みます。 |
/ResultSet/Result/CategoryPath | カテゴリパスです。 |
/ResultSet/Result/CategoryIdPath | カテゴリIDのパスです。 |
/ResultSet/Result/Item | 商品(オークション)の情報を含みます。 |
/ResultSet/Result/Item/AuctionID | 商品(オークション)のIDです。 |
/ResultSet/Result/Item/Title | 商品(オークション)のタイトルです。 |
/ResultSet/Result/Item/Seller | 出品者に関する情報です。 |
/ResultSet/Result/Item/Seller/Id | 出品者のYahoo! JAPAN IDです。 |
/ResultSet/Result/Item/Seller/ItemListUrl | この出品者の出品リストを取得するリクエストURLです。 (appidは含まれていませんのでご注意ください) |
/ResultSet/Result/Item/Seller/RatingUrl | この出品者の評価リストを取得するリクエストURLです。 (appidは含まれていませんのでご注意ください) |
/ResultSet/Result/Item/ItemUrl | 商品詳細APIのURLです。 (appidは含まれていませんのでご注意ください) |
/ResultSet/Result/Item/AuctionItemUrl | 商品(オークション)のURLです。 |
/ResultSet/Result/Item/Image | 画像(サムネイル)のURLです。以下の属性を持ちます。
|
/ResultSet/Result/Item/CurrentPrice | 現在価格です。\記号やカンマは含みません。小数点第二位までの精度です。 |
/ResultSet/Result/Item/Bids | 現在の入札数です。 |
/ResultSet/Result/Item/EndTime | 終了予定日時です。RFC3339に準拠した表現を用います。 (例:2004-04-01T12:00:00+09:00) |
/ResultSet/Result/Item/BidOrBuy | 即決価格です。(設定されていない場合は要素なし) |
/ResultSet/Result/Item/IsReserved | 最低落札価格の有無です。 (あり:true なし:false) |
/ResultSet/Result/Item/CharityOption | チャリティオプション情報です。 |
/ResultSet/Result/Item/CharityOption/Proportion | チャリティオプション寄付率、未設定の場合は0 |
/ResultSet/Result/Item/Affiliate | アフィリエイトが設定されている場合のみ表示 |
/ResultSet/Result/Item/Affiliate/Rate | アフィリエイト料率 |
/ResultSet/Result/Item/Option | 商品(オークション)に設定されているオプション情報です。 |
/ResultSet/Result/Item/Option/NewIcon | 「new」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Item/Option/StoreIcon | 「ストア」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Item/Option/CheckIcon | 「鑑定済み」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Item/Option/PublicIcon | 「官公庁オークション」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Item/Option/FeaturedIcon | 「注目のオークション」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Item/Option/FreeshippingIcon | 「送料無料」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Item/Option/NewItemIcon | 「新品」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Item/Option/WrappingIcon | 「贈答品」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Item/Option/BuynowIcon | 「即決価格」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Item/Option/EasyPaymentIcon | 「Yahoo!かんたん決済」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Item/Option/GiftIcon | 「目立ち」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Item/Option/PointIcon | 「Tポイント」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Item/Option/CharityOptionIcon | 「チャリティオプション」アイコンのURLです。(10%用と100%用あり)(設定されていない場合は要素なし) |
/ResultSet/Result/Item/Option/IsBold | 太字設定の有無です。 (あり:true なし:false) |
/ResultSet/Result/Item/Option/IsBackGroundColor | 背景色設定の有無です。 (あり:true なし:false) |
/ResultSet/Result/Item/Option/IsOffer | 値下げ交渉設定の有無です。 (あり:true なし:false) |
/ResultSet/Result/Item/Option/IsCharity | チャリティオプション設定の有無です。 (あり:true なし:false) |
/ResultSet/Result/Item/IsAdult | アダルトカテゴリの出品物かどうか。 (あり:true なし:false) |
サンプルレスポンス
<ResultSet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:yahoo:jp:auc:categoryLeaf" xsi:schemaLocation="urn:yahoo:jp:auc:categoryLeaf http://auctions.yahooapis.jp/AuctionWebService/V2/categoryLeaf.xsd" totalResultsAvailable="2" totalResultsReturned="2" firstResultPosition="1"> <Result> <CategoryPath>オークション >食品、飲料 >飲料 >アルコール >日本酒 >東北</CategoryPath> <Item> <AuctionID>a123456789</AuctionID> <Title>十四代★純米吟醸 角新★本丸 秘伝玉返し★一升(1.8L)*2本セット</Title> <Seller> <Id>******</Id> <ItemListUrl>http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?sellerID=****** </ItemListUrl> <RatingUrl>http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=****** </RatingUrl> </Seller> <ItemUrl>http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?auctionID=a123456789 </ItemUrl> <AuctionItemUrl>http://page5.auctions.yahoo.co.jp/jp/auction/a123456789 </AuctionItemUrl> <Image width="78" height="100">http://auctions.c.yimg.jp/img365.auctions.yahoo.co.jp/users/8/2/8/5/******-thumb-1361915172957117.jpg </Image> <CurrentPrice>1.00</CurrentPrice> <Bids>0</Bids> <EndTime>2013-03-03T21:36:38+09:00</EndTime> <BidOrBuy>25980.00</BidOrBuy> <IsReserved>false</IsReserved> <CharityOption> <Proportion>0</Proportion> </CharityOption> <Option> <NewIcon>http://image.auctions.yahoo.co.jp/i/auctions/new3.gif </NewIcon> <NewItemIcon>http://image.auctions.yahoo.co.jp/images/gift/c_attention_01.gif </NewItemIcon> <BuynowIcon>http://image.auctions.yahoo.co.jp/images/buynow.gif </BuynowIcon> <EasyPaymentIcon>http://i.yimg.jp/images/pay/icon_s16.gif</EasyPaymentIcon> <IsBold>true</IsBold> <IsBackGroundColor>true</IsBackGroundColor> <IsOffer>false</IsOffer> <IsCharity>false</IsCharity> </Option> <IsAdult>false</IsAdult> </Item> <Item> <AuctionID>b123456789</AuctionID> <Title>◆ 人気急上昇 ☆ 寫楽 純愛仕込 純米酒 1.8㍑ ☆ 入手困難 ◆</Title> <Seller> <Id>******</Id> <ItemListUrl>http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?sellerID=****** </ItemListUrl> <RatingUrl>http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=****** </RatingUrl> </Seller> <ItemUrl>http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?auctionID=b123456789 </ItemUrl> <AuctionItemUrl>http://page8.auctions.yahoo.co.jp/jp/auction/b123456789 </AuctionItemUrl> <Image width="134" height="100">http://auctions.c.yimg.jp/img243.auctions.yahoo.co.jp/users/3/7/7/3/******-thumb-1359264075479685.jpg </Image> <CurrentPrice>1.00</CurrentPrice> <Bids>0</Bids> <EndTime>2013-03-04T20:53:52+09:00</EndTime> <IsReserved>false</IsReserved> <CharityOption> <Proportion>0</Proportion> </CharityOption> <Option> <NewItemIcon>http://image.auctions.yahoo.co.jp/images/gift/c_attention_01.gif </NewItemIcon> <EasyPaymentIcon>http://i.yimg.jp/images/pay/icon_s16.gif</EasyPaymentIcon> <StarClubIcon>http://i.yimg.jp/images/auct/template/ui/auc_mod/ic_8001.gif </StarClubIcon> <IsBold>false</IsBold> <IsBackGroundColor>false</IsBackGroundColor> <IsOffer>false</IsOffer> <IsCharity>false</IsCharity> </Option> <IsAdult>false</IsAdult> </Item> </Result> </ResultSet>
サンプルレスポンス(PHPserialize)
a: 1: { s: 9: "ResultSet"; a: 4: { s: 21: "totalResultsAvailable"; s: 1: "2"; s: 20: "totalResultsReturned"; s: 1: "2"; s: 19: "firstResultPosition"; s: 1: "1"; s: 6: "Result"; a: 2: { s: 12: "CategoryPath"; s: 84: "オークション > 食品、飲料 > 飲料 > アルコール > 日本酒 > 東北"; s: 4: "Item"; a: 2: { i: 0; a: 16: { s: 9: "AuctionID"; s: 10: "e123456789"; s: 5: "Title"; s: 85: "十四代★純米吟醸 角新★本丸 秘伝玉返し★一升(1.8L)*2本セット"; s: 6: "Seller"; a: 3: { s: 2: "Id"; s: 12: "*****"; s: 11: "ItemListUrl"; s: 83: "http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?sellerID=*****"; s: 9: "RatingUrl"; s: 76: "http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=*****"; } s: 7: "ItemUrl"; s: 82: "http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?auctionID=a123456789"; s: 14: "AuctionItemUrl"; s: 55: "http://page5.auctions.yahoo.co.jp/jp/auction/a123456789"; s: 5: "Image"; s: 107: "http://auctions.c.yimg.jp/img365.auctions.yahoo.co.jp/users/8/2/8/5/*****-thumb-1361915172957117.jpg"; s: 10: "ImageWidth"; s: 2: "78"; s: 11: "ImageHeight"; s: 3: "100"; s: 12: "CurrentPrice"; s: 4: "1.00"; s: 4: "Bids"; s: 1: "0"; s: 7: "EndTime"; s: 25: "2013-03-03T21:36:38+09:00"; s: 8: "BidOrBuy"; s: 8: "25980.00"; s: 10: "IsReserved"; b: 0; s: 13: "CharityOption"; a: 1: { s: 10: "Proportion"; s: 1: "0"; } s: 6: "Option"; a: 8: { s: 7: "NewIcon"; s: 53: "http://image.auctions.yahoo.co.jp/i/auctions/new3.gif"; s: 11: "NewItemIcon"; s: 64: "http://image.auctions.yahoo.co.jp/images/gift/c_attention_01.gif"; s: 10: "BuynowIcon"; s: 51: "http://image.auctions.yahoo.co.jp/images/buynow.gif"; s: 15: "EasyPaymentIcon"; s: 40: "http://i.yimg.jp/images/pay/icon_s16.gif"; s: 6: "IsBold"; b: 1; s: 17: "IsBackGroundColor"; b: 1; s: 7: "IsOffer"; b: 0; s: 9: "IsCharity"; b: 0; } s: 7: "IsAdult"; b: 0; } i: 1; a: 15: { s: 9: "AuctionID"; s: 10: "b123456789"; s: 5: "Title"; s: 85: "◆ 人気急上昇 ☆ 寫楽 純愛仕込 純米酒 1.8㍑ ☆ 入手困難 ◆"; s: 6: "Seller"; a: 3: { s: 2: "Id"; s: 9: "b123456789"; s: 11: "ItemListUrl"; s: 80: "http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?sellerID=b123456789"; s: 9: "RatingUrl"; s: 73: "http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=b123456789"; } s: 7: "ItemUrl"; s: 82: "http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?auctionID=b123456789"; s: 14: "AuctionItemUrl"; s: 55: "http://page8.auctions.yahoo.co.jp/jp/auction/b123456789"; s: 5: "Image"; s: 104: "http://auctions.c.yimg.jp/img243.auctions.yahoo.co.jp/users/3/7/7/3/b123456789-thumb-1359264075479685.jpg"; s: 10: "ImageWidth"; s: 3: "134"; s: 11: "ImageHeight"; s: 3: "100"; s: 12: "CurrentPrice"; s: 4: "1.00"; s: 4: "Bids"; s: 1: "0"; s: 7: "EndTime"; s: 25: "2013-03-04T20:53:52+09:00"; s: 10: "IsReserved"; b: 0; s: 13: "CharityOption"; a: 1: { s: 10: "Proportion"; s: 1: "0"; } s: 6: "Option"; a: 7: { s: 11: "NewItemIcon"; s: 64: "http://image.auctions.yahoo.co.jp/images/gift/c_attention_01.gif"; s: 15: "EasyPaymentIcon"; s: 40: "http://i.yimg.jp/images/pay/icon_s16.gif"; s: 12: "StarClubIcon"; s: 60: "http://i.yimg.jp/images/auct/template/ui/auc_mod/ic_8001.gif"; s: 6: "IsBold"; b: 0; s: 17: "IsBackGroundColor"; b: 0; s: 7: "IsOffer"; b: 0; s: 9: "IsCharity"; b: 0; } s: 7: "IsAdult"; b: 0; } } } } }
サンプルレスポンス(JSONP)
loaded({ ResultSet: {@attributes: { totalResultsAvailable: "2", totalResultsReturned: "2", firstResultPosition: "1" }, Result: { CategoryPath: "オークション > 食品、飲料 > 飲料 > アルコール > 日本酒 > 東北", Item: [{ AuctionID: "a123456789", Title: "十四代★純米吟醸 角新★本丸 秘伝玉返し★一升(1.8L)*2本セット", Seller: { Id: "******", ItemListUrl: "http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?sellerID=******", RatingUrl: "http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=******" }, ItemUrl: "http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?auctionID=a123456789", AuctionItemUrl: "http://page5.auctions.yahoo.co.jp/jp/auction/a123456789", Image: "http://auctions.c.yimg.jp/img365.auctions.yahoo.co.jp/users/8/2/8/5/******-thumb-1361915172957117.jpg", CurrentPrice: "1.00", Bids: "0", EndTime: "2013-03-03T21:36:38+09:00", BidOrBuy: "25980.00", IsReserved: "false", CharityOption: { Proportion: "0" }, Option: { NewIcon: "http://image.auctions.yahoo.co.jp/i/auctions/new3.gif", NewItemIcon: "http://image.auctions.yahoo.co.jp/images/gift/c_attention_01.gif", BuynowIcon: "http://image.auctions.yahoo.co.jp/images/buynow.gif", EasyPaymentIcon: "http://i.yimg.jp/images/pay/icon_s16.gif", IsBold: "true", IsBackGroundColor: "true", IsOffer: "false", IsCharity: "false" }, IsAdult: "false" }, { AuctionID: "b123456789", Title: "◆ 人気急上昇 ☆ 寫楽 純愛仕込 純米酒 1.8㍑ ☆ 入手困難 ◆", Seller: { Id: "******", ItemListUrl: "http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?sellerID=******", RatingUrl: "http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=******" }, ItemUrl: "http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?auctionID=b123456789", AuctionItemUrl: "http://page8.auctions.yahoo.co.jp/jp/auction/b123456789", Image: "http://auctions.c.yimg.jp/img243.auctions.yahoo.co.jp/users/3/7/7/3/******-thumb-1359264075479685.jpg", CurrentPrice: "1.00", Bids: "0", EndTime: "2013-03-04T20:53:52+09:00", IsReserved: "false", CharityOption: { Proportion: "0" }, Option: { NewItemIcon: "http://image.auctions.yahoo.co.jp/images/gift/c_attention_01.gif", EasyPaymentIcon: "http://i.yimg.jp/images/pay/icon_s16.gif", StarClubIcon: "http://i.yimg.jp/images/auct/template/ui/auc_mod/ic_8001.gif", IsBold: "false", IsBackGroundColor: "false", IsOffer: "false", IsCharity: "false" }, IsAdult: "false" }] } } })
エラー
商品リストはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。