楽天グループのウェブサービス/API/商品データベース。アフィリエイトにも対応
楽天ウェブサービス 楽天ウェブサービス

BETA

my Rakuten | 楽天市場へ
ウェブサービス規約 | ヘルプ
ウェブサービストップ 楽天市場 RMSパートナー 楽天アフィリエイトを利用
トップ > 楽天商品検索API(SOAP開発用)
楽天ウェブサービス
オンラインドキュメント
楽天ウェブサービス規約
FAQ
APIステータス
クレジット表示
ウェブサービスチームブログ
旧ブログ
楽天市場系API
楽天商品検索API
楽天ジャンル検索API
楽天商品コード検索API
楽天商品ランキングAPI
楽天プロダクト製品検索API
楽天プロダクト製品詳細API
楽天プロダクトジャンル情報API
楽天プロダクトメーカー情報API
楽天ブックス系API
楽天ブックス総合検索API
楽天ブックス書籍API
楽天ブックスCD検索API
楽天ブックスDVD/Blu-ray検索API
楽天ブックス洋書検索API
楽天ブックス雑誌検索API
楽天ブックスゲーム検索API
楽天ブックスソフトウェア検索API
楽天ブックスジャンル検索API
楽天オークション系API
楽天オークション商品検索API
楽天オークション商品コード検索API
楽天オークションジャンル検索API
楽天トラベル系API
楽天トラベル施設検索API
楽天トラベル施設情報API
楽天トラベル空室検索API
楽天トラベル地区コードAPI
楽天トラベルキーワード検索API
楽天トラベルホテルチェーンAPI
楽天トラベルランキングAPI
>> 楽天トラベル系APIサンプル集
その他のAPI
楽天GORAゴルフ場検索API
楽天GORAゴルフ場詳細API
楽天GORAプラン検索API
楽天ダイナミックアドAPI
楽天ダイナミックアドAPI トラベル
楽天アフィリエイト高料率ショップAPI

提供API
楽天商品検索API(SOAP開発用) (version:2007-10-25)
 
アカウント情報
デベロッパーIDの確認ヘルプ
アフィリエイトIDの確認ヘルプ
■リクエストURL
http://api.rakuten.co.jp/rws/soap/ItemSearch/2007-10-25
リクエストURLは取得するデータ種別にかかわらず、すべて同じです。
■インターフェース仕様
SOAPでは、インタフェース仕様はWSDLによって定義されます。下記のWSDLを参照してください。
http://api.rakuten.co.jp/rws/soap/ItemSearch/2007-10-25?wsdl
■入力パラメーター
楽天商品検索API(ItemSearch) SOAP用入力パラメーター version:2007-10-25
区分 ID 項目名 フィールド名 必須 デフォルト 備考





|

|
1 デベロッパID developerId String --- デベロッパーID
2 アフィリエイトID affiliateId String - 指定無し アフィリエイトID

|







|

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





|

|
1 arg --- String User-Agent Valueにはユーザのユーザエージェントが表示される
2 --- String developerId ValueにはデベロッパーIDが表示される
3 --- String operation Valueにはユーザの指定した操作名が表示される
4 --- String version Valueにはユーザの指定した操作のバージョンが表示される
5 --- String apiVersion Valueにはユーザの指定した楽天ウェブサービスのバージョンが表示される
6 status --- String status Success / NotFound / ServerError / ClientError / Maintenance のいずれか
7 statusMsg --- String statusMsg Statusに特化したメッセージを出力

|







|

|
1 全体情報 検索数 int count 検索結果の総商品数
2 ページ番号 int page 現在のページ番号
3 ページ内商品始追番 int first 検索結果の何件目からか
4 ページ内商品終追番 int last 検索結果の何件目までか
5 ヒット件数 int hits 1度に返却する商品数
6 キャリア情報 int carrier PC=0 or mobile=1
7 総ページ数 int pageCount 最大100
8 商品情報(item
Array)
商品情報詳細 商品名 String itemName  
9 商品コード String itemCode  
10 商品価格 long itemPrice  
11 商品説明分 String itemCaption  
12 商品URL String itemUrl  
13 アフィリエイトURL String affiliateUrl (入力パラメーターにアフィリエイトIDが含まれていた時のみ)
14 商品画像有無フラグ int imageFlag 0:商品画像無し
1:商品画像有り
15 商品画像64x64URL String smallImageUrl (画像サイズ64px*64px)
16 商品画像128x128URL String mediumImageUrl (画像サイズ128px*128px)
17 販売可能フラグ int availability 0:販売不可能
1:販売可能
18 消費税フラグ int taxFlag 0:税込
1:税別
19 送料フラグ int postageFlag 0:送料込
1:送料別
20 クレジットカード利用可能フラグ int creditCardFlag 0:カード利用不可
1:カード利用可
21 ショップオブザイヤーフラグ int shopOfTheYearFlag 1:ショップオブザイヤー受賞店舗
22 アフィリエイト利用利率 double affiliateRate  
23 販売開始時刻 String startTime タイムセールが設定されている場合のみ(YYYY-MM-DD HH:MM形式)
24 販売終了時刻 String endTime タイムセールが設定されている場合のみ(YYYY-MM-DD HH:MM形式)
25 レビュー件数 long reviewCount  
26 レビュー平均 double reviewAverage  
27 店舗情報 店舗名 String shopName  
28 店舗コード String shopCode 店舗ごとのURL (http://
www.rakuten
.co.jp/
[xyz])
におけるxyzのこと
29 店舗URL String shopUrl httpからはじまる店舗ごとのURL
30 ジャンル情報 ジャンルID String genreId  
31 ジャンルごとの商品数 自ジャンル(current
Genre)
      ユーザの入力したジャンルID
32 ジャンルID int genreId  
33 ジャンル名 String genreName  
34 ジャンルに紐づく商品数 int itemCount  
35 ジャンル階層 int genreLevel  
36 子ジャンル(child
Genre)
      ユーザの入力したジャンルIDの子ジャンル
「genreId=0」の時はgenreLevel=1のジャンルが表示される
37 ジャンルID int genreId  
38 ジャンル名 String genreName  
39 ジャンルに紐づく商品数 int itemCount  
40 ジャンル階層 int 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 メンテナンス。

個人情報保護方針
Copyright (c) 1997-2012 Rakuten, Inc. All Rights Reserved.