トップ  > API一覧 > お気に入りブックマーク取得API

楽天お気に入りブックマーク取得APIは楽天のお気に入りブックマークの情報を取得することが可能なAPIです。
デベロッパーはOAuth2.0(API認可方式)を使用して、
ユーザーにユーザー自身のお気に入りブックマークのリストを表示させることが可能です。

リクエスト方法


  1. OAuth2.0(API認可方式)で、access_tokenを取得します。
    ※アプリ登録後に表示されるアプリIDとapplication_secretを使用します。
       アプリ未登録の方は登録してください。
    ※OAuth2.0(API認可方式)を使用したaccess_token取得方法についてはこちらをご覧ください。
  2. 取得したaccess_tokenを利用して、リクエストします。
    ※APIテストフォームでテストすることができます。
https://app.rakuten.co.jp/services/api/FavoriteBookmark/List/20120627?
        format=json&
        access_token=[access_token]

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

使用許可スコープ


rakuten_favoritebookmark_read

入力パラメーター


お気に入り商品取得API 入力パラメータ

ID 項目名 パラメーター 型(括弧内は最大バイト数) 必須 デフォルト 備考
1 アクセストークン access_token String Affiliate対応あり - アクセストークンの取得方法はこちらを参照してください
2 レスポンス形式 format String json json か xml かどちらかを指定することができます。
3 アフィリエイトID affiliateId String - 指定無し アフィリエイトIDが指定された場合は商品URLがアフィリエイト対応のURLになります
4 ページ番号 page Int - 1 取得するページの開始番号
5 取得件数 hits int - 1 1ページあたりに取得する商品数(最大40件)
6 並び順 sort option - regist_datetime:desc お気に入り登録日時新しい順 :regist_datetime:desc
お気に入り登録日時古い順 :regist_datetime
登録時金額安い順 :price
登録時金額高い順 :price:desc
※同一登録日時および同一金額の場合の順番、並び順は保障しません
7 公開有無指定 ispublic option - false 未指定 :""
非公開商品のみ :false
公開商品のみ :true

出力パラメーター


お気に入り商品取得API 出力パラメータ

ID 項目名 パラメーター 型(括弧内は最大バイト数) 備考
1 検索数 count int お気に入りブックマーク検索結果数
2 ヒット数 hits int 1ページあたりに返却しているお気に入りブックマーク数
3 ページ数 pageCount int 総ページ数
最大100ページ
4 ブックマークID bookmarkId String ブックマーク削除時に使用します
5 商品コード itemCode String ブックマークが、楽天市場商品の場合は商品コードを返却します。
プロダクトコードの場合はプロダクトIDを返却します
6 楽天プロダクト製品ID productId String
7 店舗名 shopName String  
8 店舗URL shopUrl String httpからはじまる店舗ごとのURL
9 商品名 itemName String  
10 商品URL itemUrl String  
11 商品画像64x64URL smallImageUrl String (画像サイズ64px*64px)
12 商品画像128x128URL mediumImageUrl String (画像サイズ128px*128px)
13 レビュー件数 reviewCount int  
14 レビューURL reviewUrl String  
15 商品別ポイント倍付け pointRate int 例)5 →ポイント5倍
商品別ポイント倍付けについてはこちらをご確認ください。
16 レビュー平均 reviewAverage String  
17 送料フラグ postageFlag int 0:送料込
1:送料別
18 消費税フラグ taxFlag int "0:税込
1:税別"

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


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

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

エラー

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

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

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

{
    "error": "wrong_parameter",
    "error_description": "keyword parameter is not valid"
}
401 無効な access_token (期限切れ・不正)

access_token が期限切れの場合

{
    "error": "invalid_token",
    "error_description": "specified access token is expired"
}

正しくない access_token を指定しなかった場合

{
    "error": "invalid_token",
    "error_description": "specify valid access token"
}
403 無効な access_token (スコープ不足)

スコープ不足 (xxxxx には必要なスコープ名が入る)

{
    "error": "insufficient_scope",
    "error_description": "specified access token has no permission for xxxxx"
}
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>