楽天市場API:楽天プロダクト情報取得

楽天市場API:楽天プロダクト情報取得

楽天プロダクト情報が取得できるAPI

楽天市場が保持している製品情報カタログから【標準価格/メーカー名】といった情報を取得できます。

APIメソッド:product.search

この機能を利用すると、楽天プロダクトIDをキーに楽天内に登録されている製品の情報を取得することができます。

Endpoint / HTTP Method

Endpoint HTTP Method
https://api.rms.rakuten.co.jp/es/2.0/product/search GET

Request

HTTP Header
No Key Value Note
1 Authorization ESA Base64(serviceSecret:licenseKey)
Query parameters
No Parameter Description Type Mandatory Multiplicity Note
1 productId 楽天プロダクトID String ※1 0…30 製品コードを指定
※同時に30個まで指定可能、複数指定する場合はカンマ( , )区切りでつないでください。
2 keyword キーワード検索 String 0,1 製品名、製品番号、ブランド名のどれかを指定
3 genreId ジャンルID検索 String 0,1
4 makerName メーカー名検索 String 0,1
5 releaseDateFrom 発売日範囲指定 (いつから) dateTime 0,1 yyyy-mm-ddThh:mm:ss.mmm+09:00
ISO8601 拡張表記に準じます。
リクエストの作成時、URLエンコードが必要です。
( “+” のURLエンコードは%2B)
タイムゾーンの指定がない場合は、自動的に+09:00となります。
6 releaseDateTo 発売日範囲指定 (いつまで) dateTime 0,1 yyyy-mm-ddThh:mm:ss.mmm+09:00
ISO8601 拡張表記に準じます。
リクエストの作成時、URLエンコードが必要です。
( “+” のURLエンコードは%2B)
タイムゾーンの指定がない場合は、自動的に+09:00となります。
7 sortBy ソート(昇順、降順) String 0,1 ■楽天プロダクトIDによるソート
昇順 : sortBy=productIdAsc
降順 : sortBy=productIdDesc■製品名によるソート
昇順 : sortBy=productNameAsc
降順 : sortBy=productNameDesc■型番によるソート
昇順 : sortBy=productNoAsc
降順 : sortBy=productNoDesc■ブランド名によるソート
昇順 : sortBy=brandNameAsc
降順 : sortBy=brandNameDesc■発売日によるソート
昇順 : sortBy=releaseDateAsc
降順 : sortBy=releaseDateDesc■更新日によるソート
昇順 : sortBy=updateDateAsc
降順 : sortBy=updateDateDesc■価格によるソート
昇順 : sortBy=standardPriceAsc
降順 : sortBy=standardPriceDesc
8 offset 検索結果取得開始位置 int 0,1 0を基準値とした検索結果取得開始位置
例:11件目から25件目の情報を取得する場合は、offset=10、limit=15
null の場合はデフォルト値で検索されます。
9 limit 検索結果取得上限数 int 0,1 検索結果の取得上限数
例:11件目から25件目の情報を取得する場合は、offset=10、limit=15
null の場合はデフォルト値で検索されます。
※値は30まで指定可能です。

Response

HTTP Header
No Key Value
1 Content-Type text/xml
HTTP Body
XML:result
NElement Description Type Size(byte) Multiplicity Note
result.status ステータス XML : status 1 <interfaceId> は “product.search
result.productSearchResult プロダクト取得情報 XML : productSearchResult 1
XML:productSearchResult
No Element Description Type Size(byte) Multiplicity Note
1 productSearchResult.pagination ページ付け XML : pagination 1
2 productSearchResult.products プロダクト XML : products 1
XML:pagination
No Element Description Type Multiplicity Note
1 pagination.numFound 検索結果ヒット数 int 1
2 pagination.offset 検索結果取得開始位置 (0からカウントします) int 1
XML:products
No Element Description Type Size(byte) Multiplicity Note
1 products.product プロダクト情報 XML : product 1 … n
XML:product
No Element Description Type Size(byte) Multiplicity Note
1 product.productId 楽天プロダクトID String 17 1
2 product.productNo 型番 String 60 1
3 product.reviewCount レビュー数 integer 11 1
4 product.reviewAverage レビュー平均 Decimal 6 1
5 product.reviewUrlPC レビューページURL(PC) String 255 1
6 product.reviewUrlMobile レビューページURL(モバイル) String 255 1
7 product.rank ランキング順位 int 4 1
8 product.rankTargetGenreId ランキングの対象ジャンルID int 4 1
9 product.rankTargetProductCount ランキングの対象製品数 int 4 1
10 product.genreId ジャンルID String 11 1
11 product.genreName ジャンル名 String 11 1
12 product.productName 製品名 String 255 1
13 product.releaseDateDisp 発売年月日(表記) String 255 1 yyyy-mm-ddThh:mm:ss.mmm+09:00
ISO8601 拡張表記に準じます。
14 product,detailInfo 詳細情報 String 255 1
15 product.brandName ブランド名 String 100 1
16 product.standardPrice 標準価格 String 11 1
17 product.isOpenPrice オープン価格フラグ boolean 1 1 0:通常の製品
1:オープン価格製品
18 product.taxCategory 税区分 int 4 1
19 product.releaseDate 発売日 dateTime 32 1 yyyy-mm-ddThh:mm:ss.mmm+09:00
ISO8601 拡張表記に準じます。
20 product.makerName メーカー名 String 60 1
21 product.updateDate データ更新日 dateTime 32 1 yyyy-mm-ddThh:mm:ss.mmm+09:00
ISO8601 拡張表記に準じます。