Top > API一覧 > 楽天商品コード検索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を指定することで出力されます。

たとえば、商品コードがaaa:1234567の商品情報を取得したい場合のリクエストURLは下記になります。(実際には改行せずに1行につなげてリクエストしてください。)
商品コードは、楽天商品検索API(ItemSearch)の出力結果に含まれます。

http://api.rakuten.co.jp/rws/3.0/rest? developerId=[YOUR_developerID] &operation=ItemCodeSearch &version=2010-08-05 &itemCode=aaa:1234567

※短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。

SOAPについて


SOAPを用いることで、より高度なアプリの開発が可能となります。SOAPに関しての詳細は「楽天商品コード検索API(ItemCodeSearch)SOAP開発用」をご覧ください。
※version:2010-08-05は、現在SOAP未対応です。

入力パラメーター


楽天商品コード検索API(ItemCodeSearch) 入力パラメーター version:2010-08-05

ID 項目名 パラメーター 型(括弧内は最大バイト数) 必須 デフォルト 備考
区分:共通パラメーター
1 デベロッパID developerId String Affiliate対応あり - デベロッパーID(こちらで確認できるアプリケーションIDのことです)
2 アフィリエイトID affiliateId String - 指定無し アフィリエイトID
3 操作 operation String Affiliate対応あり - 使用するAPIの操作名:ItemCodeSearch
4 コールバック関数名 callBack String - 指定無し JSONPとして出力する際のコールバック関数名
(UTF-8でURLエンコードした文字列)
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上
区分:サービス固有パラメーター
1 商品コード itemCode String Affiliate対応あり
(*1)
- 商品コード
楽天商品検索API(ItemSearch)の出力に含まれる
2 バージョン version String Affiliate対応あり - 2010-08-05
3 キャリア carrier int(1) - 0 PC用の情報を返すのか、モバイル用の情報を返すのかを選択
PC: 0
mobile: 1

出力パラメーター


楽天商品コード検索API(ItemCodeSearch) 出力パラメーター version:2010-08-05

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」で表示してください。
※キャリア(carrier)の指定により返却情報が異なります。
3 キャッチコピー catchcopy
4 商品コード itemCode  
5 商品価格 itemPrice  
6 商品説明文 itemCaption ※キャリア(carrier)の指定により返却情報が異なります。
7 商品URL itemUrl ※キャリア(carrier)の指定により返却情報が異なります。
8 アフィリエイトURL【NEW】 affiliateUrl (入力パラメーターにアフィリエイトIDが含まれていた時のみ)
※carrierパラメーターの指定に関わらずPC/mobile両対応のURLを返却
9 商品画像有無フラグ imageFlag 0:商品画像無し
1:商品画像有り
10 商品画像64x64URL smallImageUrl (画像サイズ64px*64px)
11 商品画像128x128URL mediumImageUrl (画像サイズ128px*128px)
12 販売可能フラグ availability 0:販売不可能
1:販売可能
13 消費税フラグ taxFlag 0:税込
1:税別
14 送料フラグ postageFlag 0:送料込
1:送料別
15 クレジットカード利用可能フラグ creditCardFlag 0:カード利用不可
1:カード利用可
16 ショップオブザイヤーフラグ shopOfTheYearFlag 1:ショップオブザイヤー受賞店舗
17 海外配送フラグ shipOverseasFlag 0:海外配送不可
1:海外配送可能
18 海外配送対象地域 shipOverseasArea 「/」(スラッシュ)区切りで対応国が表示されます。
19 あす楽フラグ asurakuFlag 0:翌日配送不可
1:翌日配送可能
※「あす楽」の詳細はこちらをご覧ください
20 あす楽配送対象地域 asurakuArea 「/」(スラッシュ)区切りで対応地域が表示されます。
21 アフィリエイト利用利率 affiliateRate  
22 販売開始時刻 startTime タイムセールが設定されている場合のみ(YYYY-MM-DD HH:MM形式)
23 販売終了時刻 endTime タイムセールが設定されている場合のみ(YYYY-MM-DD HH:MM形式)
24 レビュー件数 reviewCount  
25 レビュー平均 reviewAverage  
26 商品別ポイント倍付け【NEW】 pointRate 例)5 →ポイント5倍
商品別ポイント倍付けについてはこちらをご確認ください。
27 商品別ポイント倍付け開始日時【NEW】 pointRateStartTime 商品別ポイント倍付け(pointRate)の適用開始日時
28 商品別ポイント倍付け終了日時【NEW】 pointRateEndTime 商品別ポイント倍付け(pointRate)の適用終了日時
29 店舗情報 店舗名 shopName  
30 店舗コード shopCode 店舗ごとのURL (http://www.rakuten.co.jp/[xyz])におけるxyzのこと
31 店舗URL shopUrl httpからはじまる店舗ごとのURL
32 ジャンル情報 ジャンルID genreId  

商品別ポイント倍付けに関して


商品購入時に付与される楽天スーパーポイントは、通常、購入金額の1%ですが、ポイント倍付けが設定されている商品は、設定期間中に商品を購入すると、設定された倍率が適用されます。ポイント倍付けの詳しい仕組みは、こちらでご確認ください。

ショップが設定するポイント倍付けには、特定商品のみに適用される商品別ポイント倍付けと、特定ショップの全商品に適用されるショップ別ポイント倍付けの2種類があります。本APIでは、現在のところ、商品別ポイント倍付けの情報を提供しています。

例)5 →ポイント5倍
商品別ポイント倍付けについてはこちらをご確認ください。
※ポイント倍付けの終了日時がリクエスト日時から24時間後以降の場合のみ表示されます

アフィリエイトに関して


デベロッパーは、楽天商品コード検索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の過去のバージョンは下記からご覧いただけます。

楽天商品コード検索API(2007-04-11)
楽天商品コード検索API(2010-06-30)