FavoriteBookmark/List

Description

Gets up to 40 favorite bookmarks from the user performing the API call.

Resource URL

https://app.rakuten.co.jp/services/api/FavoriteBookmark/List/20120627

Resource Information

Auth Type OAuth
OAuth Scope rakuten_favoritebookmark_read
Affiliation Support Yes

Parameters

App ID (string)

The Application ID that identifies your application. You can get it from https://webservice.rakuten.co.jp/.

Page number (integer)

Starting number of the page to get

Default Value: 1

Number of results (integer)

Items per page. Maximum: 40.

Default Value: 1

Sort (string)

* In the case of the same registration date and time and the same price, the order cannot be predicted.

Valid Values:

  • regist_datetime Favorites registration date ascending order
  • regist_datetime:desc Favorites registration date descending order
  • price Price ascending order
  • price:desc Price descending order

Default Value: regist_datetime:desc

Only get public items (string)

Valid Values:

  • "" Unespecified
  • false Private items only
  • true Public items only

Default Value: false

Affiliate ID (string)

If this endpoint supports affiliation, here you can enter your affiliate ID. If you do, the links in the API response will include your affiliate ID.

Response format (string)

Format for the response output.

You can set this parameter to json or xml. JSON is usually the best option.

If you choose JSON, you can also set the callback parameter in order to use JSONP.

Valid Values:

  • json
  • xml

Default Value: json

Callback function name (string)

Function name to be used with the JSONP output

Please make sure you enter a UTF-8 URL encoded string, containing only a combination of alphanumeric characters, periods and underscores.

Choosing output fields (string)

By default API will return all the fields. You can specify what fields should be returned by using this parameter.

If you want to specify more than one parameter, please use comma (,) as separator.

For example, following request will only return itemName, itemPrice and itemUrl.

elements=itemName,itemPrice,itemUrl

Format version (integer)

Response format version.

If formatVersion=2 is set, the response format (JSON) will be improved.

In case of formatVersion=1:

The API response will return an array using the following format.

For example, you would need to use notation items[0].item.itemName to access itemName parameter.

{"items": [

{"item": {

"itemName": "a",

"itemPrice": 10

}},

{"item": {

"itemName": "b",

"itemPrice": 20

}}

]}

In case of formatVersion=2:

The API response will return an array using the following format.

For example, you would use the notation items[0].itemName to access the itemName parameter.

{"items": [

{

"itemName": "a",

"itemPrice": 10

},

{

"itemName": "b",

"itemPrice": 20

}

]}

Valid Values:

  • 1
  • 2

Default Value: 1

applicationId

App ID
string Required

The Application ID that identifies your application. You can get it from https://webservice.rakuten.co.jp/.

page

Page number
integer Optional

Starting number of the page to get

Default Value: 1

hits

Number of results
integer Optional

Items per page. Maximum: 40.

Default Value: 1

sort

Sort
string Optional

* In the case of the same registration date and time and the same price, the order cannot be predicted.

Valid Values:

  • regist_datetime Favorites registration date ascending order
  • regist_datetime:desc Favorites registration date descending order
  • price Price ascending order
  • price:desc Price descending order

Default Value: regist_datetime:desc

ispublic

Only get public items
string Optional

Valid Values:

  • "" Unespecified
  • false Private items only
  • true Public items only

Default Value: false

affiliateId

Affiliate ID
string Optional

If this endpoint supports affiliation, here you can enter your affiliate ID. If you do, the links in the API response will include your affiliate ID.

format

Response format
string Optional

Format for the response output.

You can set this parameter to json or xml. JSON is usually the best option.

If you choose JSON, you can also set the callback parameter in order to use JSONP.

Valid Values:

  • json
  • xml

Default Value: json

callback

Callback function name
string Optional

Function name to be used with the JSONP output

Please make sure you enter a UTF-8 URL encoded string, containing only a combination of alphanumeric characters, periods and underscores.

elements

Choosing output fields
string Optional

By default API will return all the fields. You can specify what fields should be returned by using this parameter.

If you want to specify more than one parameter, please use comma (,) as separator.

For example, following request will only return itemName, itemPrice and itemUrl.

elements=itemName,itemPrice,itemUrl

formatVersion

Format version
integer Optional

Response format version.

If formatVersion=2 is set, the response format (JSON) will be improved.

In case of formatVersion=1:

The API response will return an array using the following format.

For example, you would need to use notation items[0].item.itemName to access itemName parameter.

{"items": [

{"item": {

"itemName": "a",

"itemPrice": 10

}},

{"item": {

"itemName": "b",

"itemPrice": 20

}}

]}

In case of formatVersion=2:

The API response will return an array using the following format.

For example, you would use the notation items[0].itemName to access the itemName parameter.

{"items": [

{

"itemName": "a",

"itemPrice": 10

},

{

"itemName": "b",

"itemPrice": 20

}

]}

Valid Values:

  • 1
  • 2

Default Value: 1

Response Example

Request

https://app.rakuten.co.jp/services/api/FavoriteBookmark/List/20120627?access_token=REPLACE_WITH_THE_USER_ACCESS_TOKEN

Response
{
  "summary": {
    "count": 2,
    "hits": 1,
    "pageCount": 2
  },
  "items": [
    {
      "item": {
        "bookmarkId": "4857547",
        "itemCode": "",
        "productId": "7e9f338152a7cf385b990611358ebd77",
        "shopName": "商品価格ナビ",
        "shopUrl": "http://product.rakuten.co.jp/",
        "itemName": "ねんどろいど チノ グッドスマイルカンパニー",
        "itemUrl": "http://product.rakuten.co.jp/product/-/7e9f338152a7cf385b990611358ebd77/",
        "smallImageUrl": "http://thumbnail.image.rakuten.co.jp/ran/img/1001/0004/580/416/900/522/10010004580416900522_1.jpg?_ex=64x64",
        "mediumImageUrl": "http://thumbnail.image.rakuten.co.jp/ran/img/1001/0004/580/416/900/522/10010004580416900522_1.jpg?_ex=128x128",
        "reviewCount": 0,
        "reviewUrl": "",
        "pointRate": 0,
        "reviewAverage": "",
        "postageFlag": 99,
        "taxFlag": 0,
        "affiliateUrl": ""
      }
    }
  ]
}

Try It

OAuth Credentials

Generate Access Token

Set the Parameters

  Show More Parameters

Request

https://app.rakuten.co.jp/services/api/FavoriteBookmark/List/20120627?access_token=REPLACE_WITH_THE_USER_ACCESS_TOKEN

Response