Top  > API一覧 > 楽天オークション商品コード検索API

2013年7月、API名称「楽天オークション商品コード検索検索API2」は「楽天オークション商品コード検索検索API」に変更されました

楽天オークション商品コード検索検索APIは、楽天オークションの商品の商品コードから商品情報を取得することが可能なAPIです。

リクエストURL


https://app.rakuten.co.jp/services/api/AuctionItemCode/Search/20121010?[parameter]=[value]…
    

※JSONP形式は、JSON形式で入力パラメーターにcallBackを指定することで出力されます。

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

https://app.rakuten.co.jp/services/api/AuctionItemCode/Search/20121010?
applicationId=[アプリID]&
itemCode=i:aaa:1234567

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

入力パラメーター


楽天オークション商品コード検索API 入力パラメーター version:2012-10-10

ID 項目名 パラメーター 型(括弧内は最大バイト数) 必須 デフォルト 備考
区分:共通パラメーター
1 アプリID applicationId String Affiliate対応あり - こちらで確認できます。
2 アフィリエイトID affiliateId String - 指定無し こちらで確認できます。
3 レスポンス形式 format String - json json か xml を選択することができます。
json を選択した場合、 callback パラメーター指定により jsonp 形式にすることもできます。
4 コールバック関数名 callback String - 指定無し JSONPとして出力する際のコールバック関数名
(UTF-8でURLエンコードした文字列)
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上
5 出力パラメーター指定 elements String - ALL カンマ区切りで、必要な出力パラメータを指定した場合、
指定された出力パラメータのみを返却します。
(例)elements=reviewCount,reviewAverage
区分:サービス固有パラメーター
1 オークション商品コード itemCode String Affiliate対応あり - 楽天オークション商品検索APIの出力に含まれる
2 キャリア carrier int(1) - 0 PC用の情報を返すのか、モバイル用の情報を返すのかを選択
PC:0
mobile:1

出力パラメーター


楽天オークション商品コード検索API 出力パラメーター version:2012-10-10

区分:サービス固有パラメーター
1 全体情報 キャリア情報 carrier PC=0 or mobile=1
2 出品商品情報
(全体:<Items> ~ </Items> 、
個別商品:<Item> ~ </Item>)
商品名 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 注目のオークション設定金額 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)]&m=[商品URL(モバイル)]

エラー

エラー内容はHTTPステータスコードとレスポンスボディから判断できます。

HTTPステータスコード 意味 レスポンスボディ例 (JSON)
400 パラメーターエラー (必須パラメータ不足)

applicationId を指定しなかった場合

{
    "error": "wrong_parameter",
    "error_description": "specify valid applicationId"
}

keyword が正しい値でなかった時。(半角1文字のみ指定など)

{
    "error": "wrong_parameter",
    "error_description": "keyword parameter is not valid"
}
404 対象のデータが存在しなかった場合
{
    "error": "not_found",
    "error_description": "not found"
}
429 リクエスト過多 (各ユーザ制限値超過)

APIリクエスト数が上限に達した場合のエラーです。しばらく時間を空けてから、ご利用ください。

{
    "error": "too_many_requests",
    "error_description": "number of allowed requests has been exceeded for this API. please try again soon."
}
500 楽天ウェブサービス内のエラー

システムエラー。長時間続くようであれば、こちらよりごお問い合わせください。

{
    "error": "system_error",
    "error_description": "api logic error"
}
503 メンテナンス・リクエスト過多 (全ユーザ制限値超過)

メンテナンス (XXX/XXX にはAPI名が入る)

{
    "error": "service_unavailable",
    "error_description": "XXX/XXX is under maintenance"
}

レスポンスボディの形式は format に従います。

format エラー出力例
json
{
    "error": "wrong_parameter",
    "error_description": "page must be a number"
}
xml
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <error>wrong_parameter</error>
    <error_description>page must be a number</error_description>
</root>