楽天商品検索API XML構造
URLをリクエストしたときに返ってくるXMLの構造を説明しています。
関連ページ リクエストの作成 サンプルコード
XML構造 主要な部分のみ掲載
おもに使用するであろう部分のみ掲載しています。その他必要な部分は、XMLを見て解析して下さい。
| Response | ||||||
 |
Body | |||||
|
itemSearch:ItemSearch | |||||
|
Items | |||||
|
Item | |||||
 |
itemName | ･･･商品名 | ||||
|
itemPrice | ･･･商品価格 | ||||
|
itemCaption | ･･･商品説明 | ||||
|
affiliateUrl | ･･･アフィリエイトURL | ||||
|
smallImageUrl | ･･･商品画像64x64URL | ||||
|
mediumImageUrl | ･･･商品画像128x128URL | ||||
XMLのフィールド名とその内容
XMLのフィールド名とその内容の一覧です。ここからのコピー
コードに関しては、サンプルコードで説明しています。
| 楽天商品検索API（ItemSearch) 出力パラメーター version:2008-09-01 | ||||||
| 区分 | ID | 大分類 | 分類 | 項目名 | フィールド名 | 備考 |
| 共 通 パ ラ メ | タ | |
1 | ARG | --- | User-Agent | Valueにはユーザのユーザエージェントが表示される | |
| 2 | --- | developerId | ValueにはデベロッパーIDが表示される | |||
| 3 | --- | operation | Valueにはユーザの指定した操作名が表示される | |||
| 4 | --- | version | Valueにはユーザの指定した操作のバージョンが表示される | |||
| 5 | Status | --- | Status | Success / NotFound / ServerError / ClientError / Maintenance のいずれか | ||
| 6 | 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 | 商品情報 （全体：<Items> ～ </Items> 、個別商品：<Item> ～ </Item>） |
商品情報詳細 | 商品名 | itemName | ||
| 9 | 商品コード | itemCode | ||||
| 10 | 商品価格 | itemPrice | ||||
| 11 | 商品説明分 | itemCaption | ||||
| 12 | 商品URL | itemUrl | ||||
| 13 | アフィリエイトURL | affiliateUrl | （入力パラメーターにアフィリエイトIDが含まれていた時のみ） | |||
| 14 | 商品画像有無フラグ | imageFlag | 0：商品画像無し 1：商品画像有り |
|||
| 15 | 商品画像64x64URL | smallImageUrl | （画像サイズ64px*64px） | |||
| 16 | 商品画像128x128URL | mediumImageUrl | （画像サイズ128px*128px） | |||
| 17 | 販売可能フラグ | availability | 0：販売不可能 1：販売可能 |
|||
| 18 | 消費税フラグ | taxFlag | 0：税込 1：税別 |
|||
| 19 | 送料フラグ | postageFlag | 0：送料込 1：送料別 |
|||
| 20 | クレジットカード利用可能フラグ | creditCardFlag | 0：カード利用不可 1：カード利用可 |
|||
| 21 | ショップオブザイヤーフラグ | shopOfTheYearFlag | 1：ショップオブザイヤー受賞店舗 | |||
| 22 | アフィリエイト利用利率 | affiliateRate | ||||
| 23 | 販売開始時刻 | startTime | タイムセールが設定されている場合のみ（YYYY-MM-DD HH:MM形式） | |||
| 24 | 販売終了時刻 | endTime | タイムセールが設定されている場合のみ（YYYY-MM-DD HH:MM形式） | |||
| 25 | レビュー件数 | reviewCount | ||||
| 26 | レビュー平均 | reviewAverage | ||||
| 27 | 店舗情報 | 店舗名 | shopName | |||
| 28 | 店舗コード | shopCode | 店舗ごとのURL （http:// www.rakuten.co.jp/[xyz]） におけるxyzのこと |
|||
| 29 | 店舗URL | shopUrl | httpからはじまる店舗ごとのURL | |||
| 30 | ジャンル情報 | ジャンルID | genreId | |||
| 31 | ジャンルごとの商品数 （全体：<GenreInformation> ～ </GenreInformation> 、個別ジャンル：<current> ～ </current>もしくは<child> ～ </child>） |
自ジャンル | --- | current | ユーザの入力したジャンルID | |
| 32 | ジャンルID | genreId | ||||
| 33 | ジャンル名 | genreName | ||||
| 34 | ジャンルに紐づく商品数 | itemCount | ||||
| 35 | ジャンル階層 | genreLevel | ||||
| 36 | 子ジャンル | --- | child | ユーザの入力したジャンルIDの子ジャンル 複数の子ジャンルがある場合は<child> ～ </child>が複数生成される 入力が「genreId=0」の時はgenreLevel=1の ジャンルが<child> ～ </child>に表示される |
||
| 37 | ジャンルID | genreId | ||||
| 38 | ジャンル名 | genreName | ||||
| 39 | ジャンルに紐づく商品数 | itemCount | ||||
| 40 | ジャンル階層 | genreLevel | ||||
