|
楽天商品コード検索APIとは
| 楽天商品コード検索APIは、楽天市場の商品（共同購入商品・オークション商品・フリマ商品・楽天オークションの個人間オークション商品は除く。）の商品コードから商品情報を取得することが可能なAPIです。 |
|
|
■リクエストURL（REST／JSON形式の場合）
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を指定することで出力されます。
たとえば、商品コードがaaa:1234567の商品情報を取得したい場合のリクエストURLは下記になります。（実際には改行せずに1行につなげてリクエストしてください。）
商品コードは、楽天商品検索API（ItemSearch）の出力結果に含まれます。
http://api.rakuten.co.jp/rws/2.0/rest?
developerId=[YOUR_developerID]
&operation=ItemCodeSearch
&version=2007-04-11
&itemCode=aaa:1234567
| ※ |
短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。 |
■SOAPについて
■入力パラメーター
| 楽天商品コード検索API（ItemCodeSearch) 入力パラメーター version:2007-04-11 |
| 区分 |
ID |
項目名 |
フィールド名 |
型
(括弧内は最大バイト数） |
必須 |
デフォルト |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
デベロッパーID |
developerId |
String |
○ |
--- |
デベロッパーID |
| 2 |
アフィリエイトID |
affiliateId |
String |
- |
指定無し |
アフィリエイトID |
| 3 |
操作 |
operation |
String |
○ |
--- |
使用するAPIの操作
名：ItemCodeSearch |
| 4 |
コールバック関数名 |
callBack |
String |
- |
指定無し |
JSONPとして出力する際のコールバック関数名
（UTF-8でURLエンコードした文字列）
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
| |
1 |
商品コード |
itemCode |
String |
○ |
--- |
商品コード
楽天商品検索API（ItemSearch）の出力に含まれる |
| 2 |
バージョン |
version |
String |
○ |
--- |
2007-04-11 |
| 3 |
キャリア |
carrier |
int(1) |
- |
0 |
PC用の情報を返すの
か、モバイル用の情報を返すのかを選択
PC: 0
mobile: 1 |
|
■出力パラメーター
| 楽天商品コード検索API（ItemCodeSearch) 出力パラメーター 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 |
全体情報 |
キャリア情報 |
carrier |
PC=0 or mobile=1 |
| 2 |
商品情報 |
商品名 |
itemName |
|
| 3 |
商品コード |
itemCode |
|
| 4 |
商品価格 |
itemPrice |
|
| 5 |
商品説明文 |
itemCaption |
|
| 6 |
商品URL |
itemUrl |
|
| 7 |
アフィリエイトURL |
affiliateUrl |
（入力パラメーターに
アフィリエイトIDが含まれていた時のみ） |
| 8 |
商品画像有無フラグ |
imageFlag |
0：商品画像無し
1：商品画像有り |
| 9 |
商品画像
64x64URL |
smallImageUrl |
（画像サイズ
64px*64px） |
| 10 |
商品画像
128x128URL |
mediumImageUrl |
（画像サイズ
128px*128px） |
| 11 |
販売可能フラグ |
availability |
0：販売不可能
1：販売可能 |
| 12 |
消費税フラグ |
taxFlag |
0：税込
1：税別 |
| 13 |
送料フラグ |
postageFlag |
0：送料込
1：送料別 |
| 14 |
クレジットカード利用
可能フラグ |
creditCardFlag |
0：カード利用不可
1：カード利用可 |
| 15 |
ショップオブザイヤー
フラグ |
shopOfTheYearFlag |
1：ショップオブザイ
ヤー受賞店舗 |
| 16 |
アフィリエイト利用利
率 |
affiliateRate |
|
| 17 |
販売開始時刻 |
startTime |
タイムセールが設定さ
れている場合のみ（YYYY-MM-DD HH:MM形式） |
| 18 |
販売終了時刻 |
endTime |
タイムセールが設定さ
れている場合のみ（YYYY-MM-DD HH:MM形式） |
| 19 |
レビュー件数 |
reviewCount |
|
| 20 |
レビュー平均 |
reviewAverage |
|
| 21 |
店舗情報 |
店舗名 |
shopName |
|
| 22 |
店舗コード |
shopCode |
店舗ごとのURL
（http://www.rakuten.co.jp/[xyz]）
におけるxyzのこと |
| 23 |
店舗URL |
shopUrl |
httpからはじまる
店舗ごとのURL |
| 24 |
ジャンル情報 |
ジャンル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 |
リクエスト回数制限オーバー。
※しばらく時間を空けて、再度ご利用ください |
|
■過去のバージョン
本APIの過去のバージョンは下記からご覧いただけます。
|
