楽天オークション商品検索API XML構造
URLをリクエストしたときに返ってくるXMLの構造を説明しています。
関連ページ リクエストの作成 サンプルコード
XML構造 主要な部分のみ掲載
おもに使用するであろう部分のみ掲載しています。その他必要な部分は、XMLを見て解析して下さい。
| Response | ||||||
 |
Body | |||||
|
auctionItemSearch:AuctionItemSearch | |||||
|
Items | |||||
|
Item | |||||
 |
itemName | ･･･商品名 | ||||
|
itemPrice | ･･･現在価格 | ||||
|
itemCaption | ･･･商品説明 | ||||
|
affiliateUrl | ･･･アフィリエイトURL | ||||
|
smallImageUrl | ･･･商品画像64x64URL | ||||
|
mediumImageUrl | ･･･商品画像128x128URL | ||||
|
bidCount | ･･･入札件数 | ||||
XMLのフィールド名とその内容
XMLのフィールド名とその内容の一覧です。
コードに関しては、サンプルコードで説明しています。
| 楽天オークション商品検索API（AuctionItemSearch) 出力パラメーター version:2007-12-13 | |||||
| 区分 | ID | 分類 | 項目名 | フィールド名 | 備考 |
| 共 通 パ ラ メ | タ | |
1 | Arg | --- | User-Agent | Valueにはユーザのユーザエージェントが表示される |
| 2 | --- | developerId | ValueにはデベロッパーIDが表示される | ||
| 3 | --- | affiliateId | Valueにはユーザの指定したアフィリエイトIDが表示される | ||
| 4 | --- | operation | Valueにはユーザの指定した操作名が表示される | ||
| 5 | --- | version | Valueにはユーザの指定した操作のバージョンが表示される | ||
| 6 | Status | --- | Status | Success / NotFound / ServerError / ClientError / Maintenance のいずれか | |
| 7 | StatusMsg | --- | StatusMsg | Statusに特化したメッセージを出力 | |
| サ | ビ ス 固 有 パ ラ メ | タ | |
1 | 全体情報 | 検索数 | count | 検索結果の総商品数 |
| 2 | ページ番号 | page | 現在のページ番号 | ||
| 3 | ページ内商品始追番 | first | 検索結果の何件目からか | ||
| 4 | ページ内商品終追番 | last | 検索結果の何件目までか | ||
| 5 | ヒット件数 | hits | 1度に返却する商品数 | ||
| 6 | キャリア情報 | carrier | PC=0 or mobile=1 | ||
| 7 | 総ページ数 | pageCount | 最大100 | ||
| 8 | 出品商品情報 | 商品名 | itemName | ||
| 9 | オークション商品コード | itemCode | |||
| 10 | 出品商品現在価格 | itemPrice | |||
| 11 | 最低入札価格 | minPrice | |||
| 12 | 商品説明文 | itemCaption | |||
| 13 | 商品URL | itemUrl | |||
| 14 | アフィリエイトURL | affiliateUrl | （入力パラメーターにアフィリエイトIDが含まれていた時のみ） | ||
| 15 | 商品画像有無フラグ | imageFlag | 0:商品画像無し 1:商品画像有り |
||
| 16 | 商品画像 64x64URL | smallImageUrl | (画像サイズ 64px*64px) | ||
| 17 | 商品画像 128x128URL | mediumImageUrl | (画像サイズ 128px*128px) | ||
| 18 | 即落フラグ | blowFlag | 0:通常のオークション商品 1:即落商品 |
||
| 19 | 結果フラグ | resultFlag | 0:取引中の場合 1:取引が終了した場合 |
||
| 20 | 入札件数 | bidCount | |||
| 21 | 消費税フラグ | taxFlag | 0:税込 1:税別 2:税なし 3:非課税 |
||
| 22 | 送料フラグ | postageFlag | 0:送料込 1:送料別 |
||
| 23 | クレジットカード利用可能フラグ | creditCardFlag | 0:カード利用不可 1:カード利用可 |
||
| 24 | アフィリエイト利用利率 | affiliateRate | |||
| 25 | 入札開始時間 | startTime | |||
| 26 | 入札終了時間 | endTime | |||
| 27 | 出品者情報 | 出品者名 | shopName | ||
| 28 | 出品者種別フラグ | shopStatusFlag | 1:個人 2:楽天市場店舗 3:楽オク事業者 | ||
| 29 | ジャンル情報 | ジャンルID | genreId | ||
