|
楽天プロダクト製品詳細APIとは
| 楽天プロダクト製品詳細APIは、楽天プロダクトの製品の詳細情報を取得することが可能なAPIです。 |
|
|
■リクエストURL（REST／JSON形式の場合）
http://api.rakuten.co.jp/rws/3.0/rest?[parameter]=[value]…
http://api.rakuten.co.jp/rws/3.0/json?[parameter]=[value]…
※JSONP形式は、JSON形式で入力パラメーターにcallBackを指定することで出力されます。
フィールド名keyword, sortに対応する[value]はUTF-8でURLエンコードされている必要があります。（リクエストURL全体をエンコードするのではなく、[value]部分を個別にエンコードしてください。）
たとえば、「a1b2c3d4e5f6g7h8i9j0k」という楽天プロダクト製品IDで検索し、詳細情報を取得したい場合のリクエストURLは下記になります。（実際には改行せずに1行につなげてリクエストしてください。）
http://api.rakuten.co.jp/rws/3.0/rest?
developerId=[YOUR_developerID]
&operation=ProductDetail
&version=2011-07-14
&productId=a1b2c3d4e5f6g7h8i9j0k
&&detailFlag=1
| ※ |
短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。 |
■入力パラメーター
| 楽天プロダクト製品詳細API（ProductDetail) 入力パラメーター version:2011-07-14 |
| 区分 |
ID |
項目名 |
フィールド名 |
型
(括弧内は
最大
バイト数） |
必須 |
デフォルト |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
デベロッパID |
developerId |
String |
○ |
--- |
デベロッパーID |
| 2 |
アフィリエイトID |
affiliateId |
String |
- |
指定無し |
アフィリエイトID |
| 3 |
操作 |
operation |
String |
○ |
--- |
使用するAPIの操作名：
ProductDetail |
| 4 |
コールバック関数名 |
callBack |
String |
- |
指定無し |
JSONPとして出力する際のコールバック関数名
（UTF-8でURLエンコードした文字列）
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
| |
1 |
楽天プロダクト製品ID |
productId |
String |
○ |
--- |
楽天プロダクト用の製品ID
楽天プロダクト製品検索API(ProductSearch)や楽天プロダクトジャンル情報API(ProductGenreInfo)、楽天プロダクトメーカー情報API(ProductMakerInfo)の出力に含まれる。 |
| 2 |
バージョン |
version |
String |
○ |
--- |
2011-07-14 |
| 3 |
詳細情報取得フラグ |
detailFlag |
int(1) |
- |
0 |
0：製品の詳細情報を取得しない
1：製品の詳細情報を取得する |
|
■出力パラメーター
| 楽天プロダクト製品詳細API（ProductDetail) 出力パラメーター version:2011-07-14 |
| 区分 |
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 |
製品情報 |
製品基本情報 |
楽天プロダクト製品ID |
productId |
|
| 2 |
製品名 |
productName |
|
| 3 |
型番 |
productNo |
|
| 4 |
ブランド名 |
brandName |
|
| 5 |
製品ページURL(PC) |
productUrlPC |
|
| 6 |
製品ページURL(モバイル) |
productUrlMobile |
|
| 7 |
アフィリエイトURL |
affiliateUrl |
PC/モバイル両対応のURLを返却 |
| 8 |
製品画像64x64URL |
smallImageUrl |
（画像サイズ64px*64px） |
| 9 |
製品画像128x128URL |
mediumImageUrl |
（画像サイズ128px*128px） |
| 10 |
製品説明文 |
productCaption |
|
| 11 |
発売年月日 |
releaseDate |
|
| 12 |
当該製品の取扱商品数 |
itemCount |
|
| 13 |
当該製品の取扱商品数(中古品を除く)【NEW】 |
usedExcludeItemCount |
|
| 14 |
購入可能商品数 |
salesItemCount |
|
| 15 |
購入可能商品数(中古品を除く)【NEW】 |
usedExcludeSalesItemCount |
|
| 16 |
メーカー情報 |
楽天プロダクトメーカーコード |
makerCode |
|
| 17 |
会社名 |
makerName |
|
| 18 |
会社名カナ |
makerNameKana |
|
| 19 |
会社正式名称 |
makerNameFormal |
|
| 20 |
価格情報 |
標準価格 |
productPrice |
オープン価格フラグが「1」の場合、もしくは、標準価格の情報がない場合には、
標準価格の値は「0」になる |
| 21 |
オープン価格フラグ |
openPriceFlag |
0：通常の製品
1：オープン価格製品 |
| 22 |
消費税フラグ |
taxFlag |
0：不明 1：税込 2：税抜
※オープン価格フラグが「1」の場合、もしくは、標準価格の情報がない場合には、
消費税フラグは「0」になる |
| 23 |
最高価格 |
maxPrice |
|
| 24 |
最高価格(中古品を除く)【NEW】 |
usedExcludeMaxPrice |
|
| 25 |
購入可能商品の最高価格 |
salesMaxPrice |
|
| 26 |
購入可能商品の最高価格(中古品を除く)【NEW】 |
usedExcludeSalesMaxPrice |
|
| 27 |
最低価格 |
minPrice |
|
| 28 |
最低価格(中古品を除く)【NEW】 |
usedExcludeMinPrice |
|
| 29 |
購入可能商品の最低価格 |
salesMinPrice |
|
| 30 |
購入可能商品の最低価格(中古品を除く)【NEW】 |
usedExcludeSalesMinPrice |
|
| 31 |
平均価格 |
averagePrice |
|
| 32 |
評価情報 |
レビュー数 |
reviewCount |
|
| 33 |
レビュー平均 |
reviewAverage |
|
| 34 |
レビューページURL(PC) |
reviewUrlPC |
|
| 35 |
レビューページURL(モバイル) |
reviewUrlMobile |
|
| 36 |
ランキング順位 |
rank |
|
| 37 |
ランキングの対象ジャンルID |
rankTargetGenreId |
ランキング順位がどのジャンルIDに所属している製品を対象としているものか |
| 38 |
ランキングの対象製品数 |
rankTargetProductCount |
ランキング順位が、何製品中の順位なのか |
| 39 |
ジャンル情報 |
ジャンルID |
genreId |
|
| 40 |
ジャンル名 |
genreName |
|
| 41 |
製品詳細情報
（全体：<ProductDetails>
〜 </ProductDetails>、
個別項目：<detail> 〜 </detail>） |
--- |
詳細項目数 |
detailCount |
製品の詳細情報の数 |
| 42 |
製品詳細 |
--- |
detail |
製品の詳細情報
複数ある場合は<detail> 〜 </detail>が複数生成される |
| 43 |
項目番号 |
detailNo |
|
| 44 |
項目名 |
name |
|
| 45 |
項目値 |
value |
|
|
■アフィリエイトに関して
デベロッパーは、楽天プロダクト製品詳細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）]&m=[商品URL（モバイル）]
|
■エラー
エラーが起こった際は、出力中の「共通パラメーター」のStatusに下表に記載されたいずれかが表示されます。
| Statusでの表示 |
内容 |
| NotFound |
検索結果が存在しない。 |
| ServerError |
楽天ウェブサービス側のエラー。 |
| ClientError |
デベロッパーの入力に起因するエラー。 |
| Maintenance |
メンテナンス。 |
| AccessForbidden |
リクエスト回数制限オーバー。
※しばらく時間を空けて、再度ご利用ください |
|
■過去のバージョン
本APIの過去のバージョンは下記からご覧いただけます。
|
