トップ > API一覧

楽天商品検索API (version:2007-04-11)
楽天 商品検索APIとは
楽天商品検索APIは、楽天市場の商品(共同購入商品・オークション商品・フリマ商品・楽天オークションの個人間オークション商品は除く。)の情報を取得することが可能なAPIです。デベロッパーはキーワードでの商品検索をはじめ、ショップ別・ジャンル別の絞込み検索も可能となります。  
アカウント情報
デベロッパーIDの確認ヘルプ
アフィリエイトIDの確認ヘルプ
■リ クエストURL
http://api.rakuten.co.jp/rws/1.7/rest?[parameter]=[value]...
http://api.rakuten.co.jp/rws/1.7/json?[parameter]=[value]...

※JSONP形式は、JSON形式で入力パラメーターにcallBackを指定することで出力されます。

フィールド名keyword, sortに対応する[value]はUTF-8でURLエンコードされている必要があります。(リクエストURL全体をエンコードするのではなく、 [value]部分を個別にエンコードしてください。)
たとえば、「福袋」という検索キーワードで検索し、結果を価格が安い順に並べたい(sort=+itemPrice)場合のリクエストURLは下記になり ます。(実際には改行せずに1行につなげてリクエストしてください。)
http://api.rakuten.co.jp/rws/1.7/rest?
developerId=[YOUR_developerID]
&operation=ItemSearch
&version=2007-04-11
&keyword=%E7%A6%8F%E8%A2%8B
&sort=%2BitemPrice
短い時間の間に大量に、同一のリクエスト URLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。
■入力パラメーター
楽天商品検索API(ItemSearch) 入力パラメーター version:2007-04-11
区分 ID 項目名 フィールド名
(括弧内は
最大
バイト数)
必須 デフォルト 備考





|

|
1 デベロッパID developerId String --- デベロッパーID
2 アフィリエイトID affiliateId String - 指定無し アフィリエイトID
3 操作 operation String --- 使用するAPIの操作 名:ItemSearch
4 コールバック関数名
【NEW】
callBack String - 指定無し JSONPとして出力する際のコールバック関数名
(UTF-8でURLエンコードした文字列)
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上

|







|

|
1 検索キーワード keyword String
(*1)
--- UTF-8でURLエ ンコードした文字列
(*1)検索キーワード、ジャンルIDのいずれかが指定されていることが必須です。
2 バージョン version String --- 2007-04-11
3 ショップコード shopCode String - 指定無し ショップごとのURL
(http://
www.rakuten.co.jp/[xyz])におけるxyzのこと
4 ジャンルID genreId long
(*1)
0 楽天市場におけるジャ ンルを特定するためのID
ジャンル名、ジャンルの親子関係を調べたい場合は、「楽天ジャンル検索API(GenreSearch)」をご利用ください
(*1)検索キーワード、ジャンルIDのいずれかが指定されていることが必須です。
5 1ページあたりの取得 件数 hits int - 30 1から30までの整数
6 取得ページ page int - 1 1から100までの整 数
7 ソート sort String - -review
Count
+affiliateRate:
アフィリエイト料率順(昇順)
-affiliateRate:
アフィリエイト料率順(降順)
+reviewCount:
レビュー件数順(昇順)
-reviewCount:
レビュー件数順(降順)
+itemPrice:
価格順(昇順)
-itemPrice:
価格順(降順)
+updateTimestamp:
商品更新日時順(昇順)
-updateTimestamp:
商品更新日時順(降順)
random:
ランダム順
※UTF-8でURLエンコードされている必要があります。
8 最小価格 minPrice long - 指定無し 0以上の整数
9 最大価格 maxPrice long - 指定無し 0以上の整数
maxPriceはminPriceより大きい必要がある
10 販売可能 availability int(1) - 1 0:すべての商品
1:販売可能な商品のみ
11 検索フィールド field int(1) - 1 0:検索対象が広い (同じ検索キーワードでも多くの検索結果が得られる)
1:検索対象範囲が限定される(同じ検索キーワードでも少ない検索結果が得られる)
12 キャリア carrier int(1) - 0 PC用の情報を返すの か、モバイル用の情報を返すのかを選択
PC: 0
mobile: 1
13 商品画像有無フラグ imageFlag int(1) - 0 0 : すべての商品を検索対象とする
1 : 商品画像ありの商品のみを検索対象とする
14 OR検索フラグ【NEW】 orFlag int(1) - 0 複数キーワードが設定された場合に、AND検索、OR検索のいずれかが選択可能。
0:AND検索
1:OR検索
※ただし、(A and B) or Cといった複雑な検索条件設定は指定不可。
15 除外キーワード【NEW】 NGKeyword String - 指定無し 検索結果から除外したいキーワード
UTF-8でURLエンコードした文字列
■出力パラメーター
楽天商品検索API(ItemSearch) 出力パラメーター version:2007-04-11
区分 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 商品情報 商品名 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  
■ア フィリエイトに関して
デベロッパー は、楽天商品検索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 メンテナンス。
AccessForbidden リクエスト回数制限オーバー。
※しばらく時間を空けて、再度ご利用ください