BooksForeignBook/Search

Description

Gets up to 30 foreign book items by title, author, publisher, ISBN or genre.

Resource URL

https://app.rakuten.co.jp/services/api/BooksForeignBook/Search/20130522

Resource Information

Auth Type App Key
Affiliation Support Yes

Parameters

App ID (string)

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

Title (string)

Search for a book title.

This parameter must be UTF-8 encoded.

You can search multiple keywords separating them by a space.

Author (string)

Search for an author's name.

This parameter must be UTF-8 encoded.

You can search multiple keywords separating them by a space.

Publisher name (string)

Search for a publisher.

This parameter must be UTF-8 encoded.

You can search multiple keywords separating them by a space.

Book ISBN code (string)

Search for a ISBN code (book code).

Book genre ID (string)

Use it for narrow results to a specific book genre ID.

Only genres under bookGenreId = 005 (Foreign Book) are valid.

Please use the Book Genre Search API to look up book genre names and genre relations.

Please note that this genre is different from the Rakuten Ichiba genre.

Default Value: 005

How many results to display on each page (integer)

An integer between 1 and 30.

Default Value: 30

Result page (integer)

An integer between 1 and 100.

Default Value: 1

Availability (integer)

Valid Values:

  • 0 all items
  • 1 In Stock
  • 2 Usually ships in about 3 to 7 days
  • 3 Usually ships in about 3 to 9 days
  • 4 Manufacturer stock
  • 5 Preorder
  • 6 Check stock with manufacturer

Default Value: 0

Out of Stock Flag (integer)

Valid Values:

  • 0 Do not include out of stock items.
  • 1 Include out of stock items.

Default Value: 0

Sort (string)

*UTF-8 URL encoding is required.

Valid Values:

  • standard
  • sales
  • +releaseDate Release date (Ascending order)
  • -releaseDate Release date (Descending order)
  • +itemPrice Item price (Ascending order)
  • -itemPrice Item price (Descending order)
  • reviewCount
  • reviewAverage

Default Value: 0

Limited Flag (integer)

※ Limited Edition include products such as limited time, limited quantity or reservation limited.

Valid Values:

  • 0 All items
  • 1 Limited Edition only

Default Value: 0

Platform (integer)

Valid Values:

  • 0 PC
  • 1 Mobile

Default Value: 0

Genre information flag (integer)

Valid Values:

  • 0 Do not get number of item in each genre.
  • 1 Get number of item in each genre.

Default Value: 0

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/.

title

Title
string At least one is required

Search for a book title.

This parameter must be UTF-8 encoded.

You can search multiple keywords separating them by a space.

author

Author
string At least one is required

Search for an author's name.

This parameter must be UTF-8 encoded.

You can search multiple keywords separating them by a space.

publisherName

Publisher name
string At least one is required

Search for a publisher.

This parameter must be UTF-8 encoded.

You can search multiple keywords separating them by a space.

isbn

Book ISBN code
string At least one is required

Search for a ISBN code (book code).

booksGenreId

Book genre ID
string At least one is required

Use it for narrow results to a specific book genre ID.

Only genres under bookGenreId = 005 (Foreign Book) are valid.

Please use the Book Genre Search API to look up book genre names and genre relations.

Please note that this genre is different from the Rakuten Ichiba genre.

Default Value: 005

hits

How many results to display on each page
integer Optional

An integer between 1 and 30.

Default Value: 30

page

Result page
integer Optional

An integer between 1 and 100.

Default Value: 1

availability

Availability
integer Optional

Valid Values:

  • 0 all items
  • 1 In Stock
  • 2 Usually ships in about 3 to 7 days
  • 3 Usually ships in about 3 to 9 days
  • 4 Manufacturer stock
  • 5 Preorder
  • 6 Check stock with manufacturer

Default Value: 0

outOfStockFlag

Out of Stock Flag
integer Optional

Valid Values:

  • 0 Do not include out of stock items.
  • 1 Include out of stock items.

Default Value: 0

sort

Sort
string Optional

*UTF-8 URL encoding is required.

Valid Values:

  • standard
  • sales
  • +releaseDate Release date (Ascending order)
  • -releaseDate Release date (Descending order)
  • +itemPrice Item price (Ascending order)
  • -itemPrice Item price (Descending order)
  • reviewCount
  • reviewAverage

Default Value: 0

limitedFlag

Limited Flag
integer Optional

※ Limited Edition include products such as limited time, limited quantity or reservation limited.

Valid Values:

  • 0 All items
  • 1 Limited Edition only

Default Value: 0

carrier

Platform
integer Optional

Valid Values:

  • 0 PC
  • 1 Mobile

Default Value: 0

genreInformationFlag

Genre information flag
integer Optional

Valid Values:

  • 0 Do not get number of item in each genre.
  • 1 Get number of item in each genre.

Default Value: 0

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/BooksForeignBook/Search/20130522?applicationId=REPLACE_WITH_YOUR_APP_ID&author=cervantes&hits=3

Response
{
  "count": 62,
  "page": 1,
  "first": 1,
  "last": 3,
  "hits": 3,
  "carrier": 0,
  "pageCount": 21,
  "Items": [
    {
      "Item": {
        "title": "Gaby, Lost and Found",
        "titleKana": "",
        "japaneseTitle": "Gaby, Lost and Found",
        "author": "Angela Cervantes",
        "authorKana": "Angela Cervantes",
        "publisherName": "PERFECTION LEARNING CORP",
        "isbn": "9781680650211",
        "itemCaption": "",
        "salesDate": "2015年",
        "itemPrice": 2695,
        "listPrice": 0,
        "discountRate": 0,
        "discountPrice": 0,
        "itemUrl": "http://books.rakuten.co.jp/rb/13476669/",
        "affiliateUrl": "",
        "smallImageUrl": "http://thumbnail.image.rakuten.co.jp/@0_mall/book/cabinet/noimage_01.gif?_ex=64x64",
        "mediumImageUrl": "http://thumbnail.image.rakuten.co.jp/@0_mall/book/cabinet/noimage_01.gif?_ex=120x120",
        "largeImageUrl": "http://thumbnail.image.rakuten.co.jp/@0_mall/book/cabinet/noimage_01.gif?_ex=200x200",
        "availability": "4",
        "postageFlag": 1,
        "limitedFlag": 0,
        "reviewCount": 0,
        "reviewAverage": "0.0",
        "booksGenreId": "005407002"
      }
    },
    {
      "Item": {
        "title": "Diccionario Practico del Estudiante",
        "titleKana": "",
        "japaneseTitle": "Diccionario Practico del Estudiante",
        "author": "Miguel De Cervantes",
        "authorKana": "Miguel De Cervantes",
        "publisherName": "REAL ACADEMIA ESPANOLA",
        "isbn": "9788430699537",
        "itemCaption": "",
        "salesDate": "2015年",
        "itemPrice": 2488,
        "listPrice": 0,
        "discountRate": 0,
        "discountPrice": 0,
        "itemUrl": "http://books.rakuten.co.jp/rb/13399589/",
        "affiliateUrl": "",
        "smallImageUrl": "http://thumbnail.image.rakuten.co.jp/@0_mall/book/cabinet/9537/9788430699537.jpg?_ex=64x64",
        "mediumImageUrl": "http://thumbnail.image.rakuten.co.jp/@0_mall/book/cabinet/9537/9788430699537.jpg?_ex=120x120",
        "largeImageUrl": "http://thumbnail.image.rakuten.co.jp/@0_mall/book/cabinet/9537/9788430699537.jpg?_ex=200x200",
        "availability": "4",
        "postageFlag": 1,
        "limitedFlag": 0,
        "reviewCount": 0,
        "reviewAverage": "0.0",
        "booksGenreId": "005408004"
      }
    },
    {
      "Item": {
        "title": "Diccionario del Estudiante",
        "titleKana": "",
        "japaneseTitle": "Diccionario del Estudiante",
        "author": "Miguel De Cervantes",
        "authorKana": "Miguel De Cervantes",
        "publisherName": "TAURUS",
        "isbn": "9788430617494",
        "itemCaption": "",
        "salesDate": "2015年",
        "itemPrice": 6220,
        "listPrice": 0,
        "discountRate": 0,
        "discountPrice": 0,
        "itemUrl": "http://books.rakuten.co.jp/rb/13399587/",
        "affiliateUrl": "",
        "smallImageUrl": "http://thumbnail.image.rakuten.co.jp/@0_mall/book/cabinet/7494/9788430617494.jpg?_ex=64x64",
        "mediumImageUrl": "http://thumbnail.image.rakuten.co.jp/@0_mall/book/cabinet/7494/9788430617494.jpg?_ex=120x120",
        "largeImageUrl": "http://thumbnail.image.rakuten.co.jp/@0_mall/book/cabinet/7494/9788430617494.jpg?_ex=200x200",
        "availability": "4",
        "postageFlag": 2,
        "limitedFlag": 0,
        "reviewCount": 0,
        "reviewAverage": "0.0",
        "booksGenreId": "005408004"
      }
    }
  ],
  "GenreInformation": []
}

Try It

Set the Parameters

  Show More Parameters

Request

https://app.rakuten.co.jp/services/api/BooksForeignBook/Search/20130522?applicationId=REPLACE_WITH_YOUR_APP_ID

Response