ログイン
IDでもっと便利に[ 新規取得 ]

オークション

商品詳細

Version 1Version 2

リクエストURL

XML

http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem

PHPserialize

http://auctions.yahooapis.jp/AuctionWebService/V2/php/auctionItem

JSONP

http://auctions.yahooapis.jp/AuctionWebService/V2/json/auctionItem

Yahoo!オークションの商品詳細データを提供します。

リクエストパラメータ

RESTリクエストの構築(GET)」および、「RESTリクエストの構築(POST)」をご参照ください。

パラメータ 説明
appid(必須) string アプリケーションのIDです。詳細はこちらをご覧ください。
callback string JSONPとして出力する際のコールバック関数名を入力するためのパラメータです。UTF-8でエンコードした文字列を入力します。
auctionID(必須) string 商品(オークション)のIDです。

サンプルリクエストURL

http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?appid=<あなたのアプリケーションID>&auctionID=<商品(オークション)のID>

レスポンスフィールド

商品詳細Web APIのスキーマの記述は、以下のURLをご覧ください。
http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem.xsd

フィールド説明
ResultSet クエリーレスポンスのすべてを含み、以下の属性を持ちます。

  • totalResultsAvailable:該当件数の総個数です。(1固定)
  • totalResultsReturned:返された値の個数です。(1固定)
  • firstResultPosition:最初のデータが何個目に当たるかです。(1固定)

Result 各個別レスポンスを含みます。
AuctionID 商品(オークション)のIDです。
CategoryID このカテゴリのIDです。
CategoryPath このカテゴリの最上位カテゴリからのパスです。
Title 商品(オークション)のタイトルです。
Seller 出品者に関する情報です。
Id 出品者のYahoo! JAPAN IDです。
Rating 評価を表現するフィールドです。
Point 評価ポイントです。新規の際には0を設定します。
IsSuspended 停止中の際、trueとなります。
IsDeleted 登録削除済みの際、trueとなります。
ItemListURL この出品者の出品リストを取得するリクエストURLです。
RatingURL この出品者の評価リストを取得するリクエストURLです。
Img 画像(サムネイル)のURLです。
Image1 画像1のURLです。次の属性を持ちます。

  • width:この画像の横幅です。
  • height:この画像の縦幅です。

Image2 画像2のURLです。次の属性を持ちます。

  • width:この画像の横幅です。
  • height:この画像の縦幅です。

Image3 画像3のURLです。次の属性を持ちます。

  • width:この画像の横幅です。
  • height:この画像の縦幅です。

Initprice 開始価格です。¥記号やカンマは含みません。小数点第二位までの精度です。
Price 現在価格です。¥記号やカンマは含みません。小数点第二位までの精度です。
Quantity 商品の数量です。
Bids 現在の入札数です。
HighestBidders 現在の最高額入札者(複数含め)の情報です。以下の属性を持ちます。

  • totalHighestBidders:BidderField件数の総個数です。

Bidder 1人の最高額入札者に関する情報です。
Id 最高額入札者のYahoo! JAPAN IDです。
Rating 評価を表現するフィールドです。
Point 評価ポイントです。新規の際には0を設定します。
IsSuspended 停止中の際、trueとなります。
IsDeleted 登録削除済みの際、trueとなります。
ItemListURL この最高額入札者の出品リストを取得するリクエストURLです。
RatingURL この最高額入札者の評価リストを取得するリクエストURLです。
IsMore 最高額入札者の情報は 3 件までresponseに含まれます。最高額入札者情報の総数が4件以上ある際には、本値がtrueとなります。すべての最高額入札者の情報を取得するには、入札履歴のAPIを参照してください。
YPoint Yahoo!ポイントの獲得率です。小数点第一位までの精度です。
ItemStatus 商品の状態に関する情報です。
Condition 商品の状態です。

  • new:新品
  • used:中古
  • other:その他

Comment 状態に関するコメントです。(設定されていない場合は要素なし)
ItemReturnable 商品の返品可否に関する情報です。
Allowed 返品可能の設定です。 (あり:true なし:false)
Comment 返品に関するコメントです。(設定されていない場合は要素なし)
StartTime 開始日時です。RFC3339に準拠した表現を用います。(例:2004-04-01T12:00:00+09:00)
EndTime 終了予定日時です。RFC3339に準拠した表現を用います。(例:2004-04-01T12:00:00+09:00)
Bidorbuy 希望落札価格です。(設定されていない場合は要素なし)
Reserved 最低落札価格の有無です。(設定されていない場合は要素なし)
IsBidderRestrictions 入札者評価制限についてです。 (あり:true なし:false
IsEarlyClosing 早期終了についてです。 (あり:true なし:false
IsAutomaticExtension 自動延長についてです。 (あり:true なし:false
IsOffer 値下げ交渉についてです。 (あり:true なし:false
Option 商品(オークション)にオプションが設定されている場合、そのオプションのアイコン(GIFファイル)のURLを示します。
StoreIcon 「ストア」アイコンのURLです。
CheckIcon 「鑑定済み」アイコンのURLです。
FeaturedIcon 注目のオークション設定アイコンのURLです。
FreeshippingIcon 「送料無料」のアイコンのURLです。
NewItemIcon 「新品」アイコンのURLです。
GiftIcon 「目立ち」アイコンのURLです。
WrappingIcon 「贈答品」アイコンのURLです。
BuynowIcon 「即買」アイコンのURLです。
YBankIcon Yahoo!ネットバンキング対応の場合に「Yahoo!ネットバンキング」アイコンのURLが設定されます。
EasyPaymentIcon 「Yahoo!かんたん決済」アイコンのURLです。
EnglishIcon 「Yahoo!オークション英語版」アイコンのURLです。
Description 商品説明です。データ形式はCDATAとなり、出品者が商品説明として記述した内容がそのまま提供されます。商品説明がHTMLで記述されている場合はHTMLのタグも含まれます。
Payment 決済方法に関する情報です。
YBank Yahoo!ネットバンキングを利用できます。(設定されていない場合は要素なし)
SafeKeepingPayment この価格以上で落札された場合に代金支払い管理サービスが適用されます。¥記号やカンマは含みません。小数点第二位までの精度です。(適用されない場合は要素なし)
EasyPayment Yahoo!かんたん決済を利用できます。(設定されていない場合は要素なし)
SafeKeepingPayment この価格以上で落札された場合に代金支払い管理サービスが適用されます。¥記号やカンマは含みません。小数点第二位までの精度です。(適用されない場合は要素なし)
IsCreditCard クレジットカード決済に対応しています。
IsNetBank 銀行ネット決済に対応しています。
Bank 銀行振込を利用できます。(設定されていない場合は要素なし)
以下の属性を持ちます。

  • totalBankMethodAvailable:MethodFeald件数の総個数です。出品者が具体的に受け取り先の銀行名を指定していない場合、0 となります。

Method 受け取り先の銀行名です。 (設定されていない場合は要素なし)
CashRegistration 現金書留を利用できます。(設定されていない場合は要素なし)
PostalTransfer ゆうちょ銀行(振替サービス)を利用できます。(設定されていない場合は要素なし)
PostalOrder ゆうちょ銀行(為替サービス)を利用できます。(設定されていない場合は要素なし)
CashOnDelivery 商品代引を利用できます。(設定されていない場合は要素なし)
CreditCard クレジットカードを利用できます。(設定されていない場合は要素なし)
Loan ローン(分割払い)を利用できます。(設定されていない場合は要素なし)
Other その他の決済方法を利用できます。(設定されていない場合は要素なし)
以下の属性を持ちます。

  • totalOtherMethodAvailable:MethodFeald件数の総個数です。

Method 対応決済名です。
BlindBusiness 受け取り後決済サービスによる匿名取引についてです。

  • must:必須
  • possible:可
  • impossible:不可

SevenElevenReceive 受け取り後決済サービスによるセブン-イレブン受け取りについてです。

  • possible:可
  • impossible:不可

ChargeForShipping 商品の送料負担についてです。

  • seller:出品者が負担
  • winner:落札者が負担

Location 商品の発送元地域です。(設定されていない場合は要素なし)
IsWorldwide 海外発送についてです。 (あり:true なし:false
ShipTime 代金の先払い・後払いについてです。

  • after:出品者は代金の支払いを確認した後、商品を発送します。(先払い)
  • before:出品者は落札後、支払いの確認を待たずに商品を発送します。(後払い)

Shipping 配送方法に関する情報です。(設定されていない場合は要素なし)
以下の属性を持ちます。

  • totalShippingMethodAvailable:配送方法数です。

Method 実際の詳しい情報です。
Name 配送方法名です。
SinglePrice 全国一律送料です。(設定されていない場合は要素なし)
\記号やカンマは含みません。小数点第二位までの精度です。
PriceURL 料金表ページリンクです。(設定されていない場合は要素なし)
BaggageInfo 荷物に関する情報です。(設定されていない場合は要素なし)
Size 縦、横、高さの合計(こん包後)です。
Weight 重量 (こん包後)です。

サンプルレスポンス

以下は、auctionID=x12345 のクエリーの結果です。

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

以下は、auctionID=123456789 のクエリーの結果です。

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

以下は、auctionID=123456789, callback=loaded のクエリーの結果です。

エラー

商品詳細Web APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

利用制限


このAPIを使ったサンプルコード

開発者ブログ

Yahoo! JAPANのスタッフや著名なデベロッパーのブログを紹介しています。新しいサービスのアイデアにお役立てください。

開発者コミュニティ

Yahoo!グループに開発者のためのグループを用意しています。ほかのデベロッパーと交流し、質問やアイデアの共有にお役立てください。

法人デベロッパー専用お問い合わせ