|
楽天オークション商品コード検索APIとは
| 楽天オークション商品検索APIは、楽天オークションの商品の商品コードから商品情報を取得することが可能なAPIです。 |
|
|
■リクエストURL
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を指定することで出力されます。
たとえば、オークション商品コードがi:aaa:1234567の商品情報を取得したい場合のリクエストURLは下記になります。（実際には改行せずに1行につなげてリクエストしてください。）
オークション商品コードは、楽天オークション商品検索API（AuctionItemSearch）の出力結果に含まれます。
http://api.rakuten.co.jp/rws/3.0/rest?
developerId=[YOUR_developerID]
&operation=AuctionItemCodeSearch
&version=2012-02-02
&itemCode=i:aaa:1234567
| ※ |
短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。 |
■入力パラメーター
| 楽天オークション商品コード検索API（AuctionItemCodeSearch) 入力パラメーター version:2012-02-02 |
| 区分 |
ID |
項目名 |
フィールド名 |
型
(括弧内は
最大
バイト数） |
必須 |
デフォルト |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
デベロッパーID |
developerId |
String |
○ |
--- |
デベロッパーID |
| 2 |
アフィリエイトID |
affiliateId |
String |
- |
指定無し |
アフィリエイトID |
| 3 |
操作 |
operation |
String |
○ |
--- |
使用するAPIの操作名:AuctionItemCodeSearch |
| 4 |
コールバック関数名 |
callBack |
String |
- |
--- |
JSONPとして出力する際のコールバック関数名
（UTF-8でURLエンコードした文字列）
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
| |
1 |
バージョン |
version |
String |
○ |
--- |
2012-02-02 |
| 2 |
オークション商品コード |
itemCode |
String |
○ |
--- |
楽天オークション商品検索API（AuctionItemSearch）の出力に含まれる |
| 3 |
キャリア |
carrier |
int(1) |
- |
0 |
PC用の情報を返すのか、モバイル用の情報を返すのかを選択
PC:0
mobile:1 |
|
■出力パラメーター
| 楽天オークション商品コード検索API（AuctionItemCodeSearch) 出力パラメーター version:2012-02-02 |
| 区分 |
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 |
全体情報 |
キャリア情報 |
carrier |
PC=0 or mobile=1 |
| 2 |
出品商品情報 |
商品名 |
itemName |
従来の商品名を表示させたい場合は、「catchcopy＋itemName」で表示してください。 |
| 3 |
キャッチコピー |
catchcopy |
| 4 |
オークション商品コード |
itemCode |
|
| 5 |
出品商品現在価格 |
itemPrice |
|
| 6 |
最低入札価格 |
minPrice |
|
| 7 |
商品説明文 |
itemCaption |
|
| 8 |
商品URL |
itemUrl |
|
| 9 |
アフィリエイトURL |
affiliateUrl |
（入力パラメーターにアフィリエイトIDが含まれていた時のみ）
※carrierパラメーターの指定に関わらずPC/mobile両対応のURLを返却 |
| 10 |
商品画像有無フラグ |
imageFlag |
0:商品画像無し
1:商品画像有り |
| 11 |
商品画像 64x64URL |
smallImageUrl |
(画像サイズ 64px*64px) |
| 12 |
商品画像 128x128URL |
mediumImageUrl |
(画像サイズ 128px*128px) |
| 13 |
即落フラグ |
blowFlag |
0:通常のオークション商品
1:即落商品 |
| 14 |
即落価格 |
blowPrice |
即落商品だった場合のみ表示 |
| 15 |
結果フラグ |
resultFlag |
0:取引中の場合
1:取引が終了した場合 |
| 16 |
入札件数 |
bidCount |
|
| 17 |
消費税フラグ |
taxFlag |
0:税別
1:税込
2:税なし
3:非課税 |
| 18 |
送料フラグ |
postageFlag |
0:送料込
1:送料別 |
| 19 |
配送タイプ |
deliveryType |
0：条件なし
1：送料無料で配送
2：匿名配送
3：匿名配送かつ送料無料で配送 |
| 20 |
クレジットカード利用可能フラグ |
creditCardFlag |
0:カード利用不可
1:カード利用可 |
| 21 |
アフィリエイト利用利率 |
affiliateRate |
|
| 22 |
入札開始時間 |
startTime |
|
| 23 |
入札終了時間 |
endTime |
|
| 24 |
注目のオークション設定金額【NEW】 |
searchwordcost |
|
| 25 |
出品者情報 |
出品者名 |
shopName |
|
| 26 |
出品者種別フラグ |
shopStatusFlag |
1:個人 2:楽天市場店舗 3:楽オク事業者 |
| 27 |
ジャンル情報 |
楽天オークションジャンルID |
auctionGenreId |
|
|
■アフィリエイトに関して
デベロッパーは、楽天オークション商品コード検索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の過去のバージョンは下記からご覧いただけます。
|
