・ オンラインドキュメント ・ 楽天ウェブサービス規約 ・ FAQ ・ クレジット表示 ・ ウェブサービスチームブログ ・ 旧ブログ ・ デベロッパーズ・コミュニティ ・ 楽天商品検索API ・ 楽天ジャンル検索API ・ 楽天商品コード検索API ・ 楽天カタログ検索API ・ 楽天商品ランキングAPI ・ 楽天ブックス総合検索API ・ 楽天ブックス書籍API ・ 楽天ブックスCD検索API ・ 楽天ブックスDVD/Blu-ray検索API ・ 楽天ブックス洋書検索API ・ 楽天ブックス雑誌検索API ・ 楽天ブックスゲーム検索API ・ 楽天ブックスソフトウェア検索API ・ 楽天ブックスジャンル検索API ・ 楽天オークション商品検索API ・ 楽天オークション商品コード検索API ・ 楽天トラベル施設検索API【NEW】 ・ 楽天トラベル施設情報API ・ 楽天トラベル空室検索API【NEW】 ・ 楽天トラベル地区コードAPI ・ 楽天トラベルキーワード検索API【NEW】 ・ 楽天トラベルホテルチェーンAPI ・ 楽天トラベルランキングAPI >> 楽天トラベル系APIサンプル集 ・ 楽天ダイナミックアドAPI ・ 楽天ダイナミックアドAPI トラベル

楽天オークション商品検索API (version:2009-05-20) 楽天オークション商品検索APIとは 楽天オークション商品検索APIは、楽天オークションの商品情報を取得することが可能なAPIです。デベロッパーはキーワードでの商品検索をはじめ、ジャンル別や商品の状態などの絞り込み検索も可能となります。   アカウント情報 ・ デベロッパーIDの確認 ・ アフィリエイトIDの確認 ・リクエストURL ・入力パラメーター ・出力パラメーター ・アフィリエイトに関して ・エラー ・過去のバージョン ■リクエストURL http://api.rakuten.co.jp/rws/2.0/rest?[parameter]=[value]... http://api.rakuten.co.jp/rws/2.0/json?[parameter]=[value]... ※JSONP形式は、JSON形式で入力パラメーターにcallBackを指定することで出力されます。 フィールド名keyword, sortに対応する[value]はUTF-8でURLエンコードされている必要があります。（リクエストURL全体をエンコードするのではなく、[value]部分を個別にエンコードしてください。） たとえば、「福袋」という検索キーワードで検索し、結果を入札件数が少ない順に並べたい（sort=+bidCount）場合のリクエストURLは下記になります。（実際には改行せずに1行につなげてリクエストしてください。） http://api.rakuten.co.jp/rws/2.0/rest? developerId=[YOUR_developerID] &operation=AuctionItemSearch &version=2009-05-20 &keyword=%E7%A6%8F%E8%A2%8B &sort=%2BbidCount ※ 短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。 ■入力パラメーター 楽天オークション商品検索API（AuctionItemSearch) 入力パラメーター version:2009-05-20 区分 ID 項目名 フィールド名 型 (括弧内は 最大 バイト数） 必須 デフォルト 備考 共 通 パ ラ メ | タ | 1 デベロッパーID developerId String ○ --- デベロッパーID 2 アフィリエイトID affiliateId String - 指定無し アフィリエイトID 3 操作 operation String ○ --- 使用するAPIの操作名:AuctionItemSearch 4 コールバック関数名 callBack String - --- JSONPとして出力する際のコールバック関数名 （UTF-8でURLエンコードした文字列） 英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 サ | ビ ス 固 有 パ ラ メ | タ | 1 検索キーワード keyword String ○ (*1) --- UTF-8でURLエンコードした文字列 (*1)検索キーワード、ジャンルIDのいずれかが指定されていることが必須です 2 バージョン version String ○ --- 2009-05-20 3 ジャンルID genreId long ○ (*1) --- 楽天オークションにおけるジャンルを特定するためのID。 ジャンル名、ジャンルの親子関係を調べたい場合は、「楽天ジャンル検索API(GenreSearch)」をご利用ください。 (*1)検索キーワード、ジャンルIDのいずれかが指定されていることが必須です 4 1ページあたりの取得件数 hits int - 30 1から30までの整数 5 取得ページ page int - 1 1から100までの整数 6 最低入札価格 minPrice long - 指定無し 0以上の整数 7 最高入札価格 maxPrice long - 指定無し 0以上の整数 maxPriceはminPriceより大きい必要がある 8 ソート sort String - +endTime +endTime: 残り時間順（昇順） -endTime: 残り時間順（降順） +itemPrice: 現在価格順（昇順） -itemPrice: 現在価格順（降順） +bidCount: 入札件数順（昇順） -bidCount: 入札件数順（降順） +affiliateRate: アフィリエイト料率順（昇順） -affiliateRate: アフィリエイト料率順（降順） ※UTF-8でURLエンコードされている必要があります。 9 即落フラグ blowFlag int(1) - 0 0:すべての商品を検索対象とする 1:即落商品のみ検索対象とする ※即落商品とは、オークションの入札期間終了を待たずに即落札することが可能な商品のことです。 10 対象商品識別フラグ itemType int(1) - 0 0:すべての商品を検索対象とする 1:個人の出品商品のみ検索対象とする 2:楽天市場店舗の出品商品のみ検索対象とする 3:楽オク事業者の出品商品のみ検索対象とする (複数指定可) 11 商品状態フラグ newFlag int(1) - 0 0:すべて 1:中古のみ 2:新品のみ 12 検索フィールド field int(1) - 1 0:検索対象が広い（同じ検索キーワードでも多くの検索結果が得られる） 1:検索対象範囲が限定される（同じ検索キーワードでも少ない検索結果が得られる） 13 キャリア carrier int(1) - 0 PC用の情報を返すのか、モバイル用の情報を返すのかを選択 PC: 0 mobile: 1 14 商品画像有無フラグ imageFlag int(1) - 0 0:すべての商品を検索対象とする 1:商品画像ありの商品のみを検索対象とする 15 OR検索フラグ orFlag int(1) - 0 複数キーワードが設定された場合に、AND検索、OR検索のいずれかが選択可能。 0:AND検索 1:OR検索 ※ただし、(A and B) or Cといった複雑な検索条件設定は指定不可。 16 除外キーワード NGKeyword String - 指定無し 検索結果から除外したいキーワード UTF-8でURLエンコードした文字列 17 ジャンルごとの商品数取得フラグ【NEW】 genreInformationFlag int(1) - 0 0:ジャンルごとの商品数の情報を取得しない 1:ジャンルごとの商品数の情報を取得する ▲上へ ■出力パラメーター 楽天オークション商品検索API（AuctionItemSearch) 出力パラメーター version:2009-05-20 区分 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 商品情報 （全体：<Items> 〜 </Items> 、個別商品：<Item> 〜 </Item>） 出品商品情報詳細 商品名 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   30 ジャンルごとの商品数 （全体：<GenreInformation> 〜 </GenreInformation> 、個別ジャンル：<parent> 〜 </parent>もしくは<current> 〜 </current>もしくは<child> 〜 </child>）【NEW】 親ジャンル --- parent 入力したジャンルIDの親ジャンル 31 ジャンルID genreId   32 ジャンル名 genreName   33 ジャンル階層 genreLevel   34 自ジャンル --- current ユーザの入力したジャンルID 35 ジャンルID genreId   36 ジャンル名 genreName   37 ジャンルに紐づく商品数 itemCount   38 ジャンル階層 genreLevel   39 子ジャンル --- child ユーザの入力したジャンルIDの子ジャンル 複数の子ジャンルがある場合は<child> 〜 </child>が複数生成される 入力が「genreId=0」の時はgenreLevel=1の ジャンルが<child> 〜 </child>に表示される 40 ジャンルID genreId   41 ジャンル名 genreName   42 ジャンルに紐づく商品数 itemCount   43 ジャンル階層 genreLevel   ▲上へ ■アフィリエイトに関して デベロッパーは、楽天オークション商品検索APIから取得した商品情報からアフィリエイトURLを作成することが可能です。リンク先にそのアフィリエイトURLを指定することで、楽天アフィリエイト経由の成果報酬を獲得することができます。 アフィリエイトURLの作り方は2通りあります。入力パラメーターcarrierでPCが指定された場合でもモバイルが指定された場合でも同様の方法でアフィリエイトURLを作成することができます。 （1） APIの入力パラメーターに「アフィリエイトID」を含める場合: APIの出力に「アフィリエイトURL」が含まれます。 （2） デベロッパーが自ら、（APIから取得した）「商品URL」と「アフィリエイトID（β版）」から「アフィリエイトURL」を作成する場合: 「アフィリエイトURL」は以下のルールで生成可能です。ただし、「商品URL」の部分はURLエンコードされている必要があります。 http://hb.afl.rakuten.co.jp/hgc/[アフィリエイトID]/?pc=[商品URL（PC）] もしくは、 http://hb.afl.rakuten.co.jp/hgc/[アフィリエイトID]/?m=[商品URL（モバイル）] ▲上へ ■エラー エラーが起こった際は、出力中の「共通パラメーター」のStatusに下表に記載されたいずれかが表示されます。 Statusでの表示 内容 NotFound 検索結果が存在しない。 ServerError 楽天ウェブサービス側のエラー。 ClientError デベロッパーの入力に起因するエラー。 Maintenance メンテナンス。 ▲上へ ■過去のバージョン 本APIの過去のバージョンは下記からご覧いただけます。 ・ 楽天オークション商品検索API（2007-12-13） ▲上へ

---

個人情報保護方針

Copyright (c) 1997-2009 Rakuten, Inc. All Rights Reserved.