多店舗展開ECシステム開発日誌

多店舗化の命題にシステム化を選択したひとり店長奮闘記

NEW ARTICLE
流行りのChatGPTにWordPressの記事生成をさせてみた

楽天市場API：商品情報を検索する

楽天市場API：商品情報を検索する
目次

出品中の商品を検索するAPI

RMSに登録している商品情報を検索することができます。
商品名や商品管理番号はもちろん、価格ベースで検索したり、送料指定や倉庫フラグでの抽出も可能です。

APIメソッド：item.search

この機能を利用すると、商品情報を検索条件として指定して、該当する商品の情報を取得することができます。
商品を登録してから本機能の検索情報に反映されるまで、最大24時間かかります。

Endpoint / HTTP Method

Endpoint HTTP Method
https://api.rms.rakuten.co.jp/es/1.0/item/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 itemName 商品名 String ※1 0,1
2 catchcopy PC用キャッチコピー String 0,1
3 itemUrl 商品管理番号 String 0,1
4 catalogId カタログID String 0,1
5 genreId 全商品ディレクトリID int 0,1 IDの値はNavigationAPIのnavigation.genre.getをご利用いただくことで、下記の項目から取得可能です。
3.2.3. XML:genre – genreId
6 itemPriceFrom 価格下限 int 0,1 デフォルト値：指定なし
指定した値を下限とし、それ以上の値を検索する
7 itemPriceTo 価格上限 int 0,1 デフォルト値：指定なし
指定した値を上限とし、それ以下の値を検索する
8 depotFlg 倉庫フラグ int 0,1 デフォルト値：指定なし
0：販売商品
1：倉庫商品, 仮倉庫商品
9 itemMobileFlg 商品モバイルフラグ int 0,1 デフォルト値：指定なし
0：モバイル非表示
1：モバイル表示
10 limitedFlg 闇市フラグ int 0,1 デフォルト値：指定なし
0：闇市商品でない
1：闇市商品である
11 postageFlg 送料別フラグ int 0,1 デフォルト値：指定なし
0：送料込み
1：送料別
12 offset 検索結果取得開始位置 int 0,1 0を基準値とした検索結果取得開始位置
例：11件目から25件目の情報を取得する場合は、offset=10、limit=15
null の場合はデフォルト値で検索されます。
デフォルト値：0
許容値：0 ~ 10000
13 limit 検索結果取得上限数 int 0,1 検索結果の取得上限数
例：11件目から25件目の情報を取得する場合は、offset=10、limit=15
null の場合はデフォルト値で検索されます。
デフォルト値：30
許容値：0 ~ 50
14 sortKey ソートキー String 0,1 デフォルト値：itemRegTime
itemPrice：販売価格
itemRegTime：商品登録日
15 sortOrder ソート順 String 0,1 デフォルト値：desc
desc：降順
asc：昇順

Response

HTTP Header
No Key Value
1 Content-Type text/xml
HTTP Body
XML:result
No Element Description Type Size(byte) Multiplicity Note
1 result.status ステータス XML:status – 1 interfaceId = item.search
2 result.itemSearchResult 商品情報検索結果 XML:itemSearchResult – 1
XML:itemSearchResult
No Element Description Type Size(byte) Multiplicity Note
1 itemSearchResult.code 結果コード String – 0,1 200-00 ： 正常終了
2 itemSearchResult.numFound 検索結果件数 int 4 0,1
3 itemSearchResult.items 商品情報リスト XML:items – 0,1
XML:items
No Element Description Type Size(byte) Multiplicity Note
1 items.item 商品情報 XML:item – 0…n
XML:item
No Element Description Type Size(byte) Multiplicity Note
1 item.itemUrl 商品管理番号 String 255 0,1 ItemUrlの形式：^[0-9a-z\-_]+$
2 item.itemNumber 商品番号 String 32 0,1
3 item.itemName 商品名 String 255 0,1
4 item.itemPrice 販売価格 int 4 0,1
5 item.genreId 全商品ディレクトリID int 4 0,1 許容値：100000～999999
6 item.catalogId カタログID String 30 0,1
7 item.catchCopyForPC PC用キャッチコピー String 174 0,1
8 item.isincludeTax 消費税 boolean – 0,1
9 item.isIncludedPostage 送料 boolean – 0,1 true：送料込
false：送料別
10 item.displayPrice 表示価格 int 4 0,1 -999：オープン価格
1-999999999：表示価格許容値
11 item.isUnavailableForSearch サーチ非表示 boolean – 0,1 true：闇市商品である
false：闇市商品ではない
12 item.isAvailableForMobile モバイル表示 boolean – 0,1 true：モバイル表示
（trueのみが返ります）
13 item.isDepot 倉庫指定 boolean – 0,1 true：倉庫商品、仮倉庫商品
false：販売商品
14 item.detailSellType 詳細販売種別 int 4 0,1 0：通常商品
3：予約商品
※0と3しか返却されません。
15 item.releaseDate 予約商品発売日 Date 10 0,1 予約商品の場合のみ表示 YYYY-MM-DD
16 item.reviewNum 商品レビュー件数 int – 0,1
17 item.reviewAverage 商品レビュー平均点 float – 0,1
18 item.point ポイント情報 XML : point – 1
19 item.images 商品画像情報 XML : images – 1
20 item.registDate 商品登録日時 datetime – 0,1
XML:point
No Element Description Type Size(byte) Multiplicity Note
1 point.pointRate ポイント変倍率 int – 0,1
XML:images
No Element Description Type Size(byte) Multiplicity Note
1 images.image 商品画像URL String – 0,3 最大3つまでです
R-Storefrontの画面で「商品画像(1)」「商品画像(2)」「商品画像(3)」として確認できるものです