Rakuten Webservice API Documentation

https://webservice.rakuten.co.jp/documentation/
Admin
Rakuten Webservice API Documentation provides comprehensive API references for integrating with...
Tokens:11,731
Snippets:139
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Ranking API Request Examples

Source: https://webservice.rakuten.co.jp/documentation/ichiba-item-ranking

Examples of constructing request URLs for different ranking criteria.

```text
https://openapi.rakuten.co.jp/ichibaranking/api/IchibaItem/Ranking/20220601?  
             applicationId=[application ID]
```

```text
https://openapi.rakuten.co.jp/ichibaranking/api/IchibaItem/Ranking/20220601?  
             applicationId=[application ID]  
             &genreId=100283
```

```text
https://openapi.rakuten.co.jp/ichibaranking/api/IchibaItem/Ranking/20220601?  
             applicationId=[application ID]  
             &age=20  
             &sex=1
```

--------------------------------

### Genre List Request Example

Source: https://webservice.rakuten.co.jp/documentation/ichiba-genre-search

Example request URL to retrieve the first level of the genre list.

```text
https://openapi.rakuten.co.jp/ichibagt/api/IchibaGenre/Search/20260701?
applicationId=[APPLICATION ID]&
genreId=0
```

--------------------------------

### Example Request URL

Source: https://webservice.rakuten.co.jp/documentation/ichiba-item-search

A sample URL demonstrating a keyword search for '福袋' sorted by price.

```text
https://openapi.rakuten.co.jp/ichibams/api/IchibaItem/Search/20260701?  
                 applicationId=[APPLICATION ID]  
                 &keyword=%E7%A6%8F%E8%A2%8B  
                 &sort=%2BitemPrice
```

--------------------------------

### Example Request URL

Source: https://webservice.rakuten.co.jp/documentation/ichiba-attribute-search

A sample request URL structure for retrieving attribute information for a specific genre.

```text
https://openapi.rakuten.co.jp/ichibagt/api/IchibaAttribute/Search/20260701?
applicationId=[APPLICATION ID]&
genreId=[GENRE ID]
```

--------------------------------

### Field Selection Parameter

Source: https://webservice.rakuten.co.jp/documentation/ichiba-genre-search

Example of the elements parameter to filter specific fields in the response.

```text
elements=itemName,itemPrice,itemUrl
```

--------------------------------

### Example API Request URL

Source: https://webservice.rakuten.co.jp/documentation/books-total-search

A sample request URL demonstrating keyword search, negative keyword filtering, and sorting by price.

```text
https://openapi.rakuten.co.jp/services/api/BooksTotal/Search/20170404?
        applicationId=[APPLICATION ID]
        &keyword=%E6%9C%AC
        &NGKeyword=%E4%BA%88%E7%B4%84
        &sort=%2BitemPrice
```

--------------------------------

### Example API Request URL

Source: https://webservice.rakuten.co.jp/documentation/books-book-search

A sample request URL demonstrating keyword search with sorting and genre filtering. Ensure values are URL encoded in UTF-8.

```text
https://openapi.rakuten.co.jp/services/api/BooksBook/Search/20170404?
        applicationId=[APPLICATION ID]
        &title=%E5%A4%AA%E9%99%BD
        &booksGenreId=001004008
        &sort=%2BitemPrice
```

--------------------------------

### Response Format Version 1 Example

Source: https://webservice.rakuten.co.jp/documentation/books-total-search

JSON response structure when formatVersion is set to 1, requiring nested access to item properties.

```json
{"items": [    {"item": {        "itemName": "a",        "itemPrice": 10    }},    {"item": {        "itemName": "b",        "itemPrice": 20    }}]}
```

--------------------------------

### Handle 400 Parameter Errors

Source: https://webservice.rakuten.co.jp/documentation/books-magazine-search

Examples of JSON error responses when required parameters like applicationId or keyword are missing or invalid.

```json
{
    "error": "wrong_parameter",
    "error_description": "specify valid applicationId"
}
```

```json
{
    "error": "wrong_parameter",
    "error_description": "keyword parameter is not valid"
}
```

--------------------------------

### Response Format Version 2 Example

Source: https://webservice.rakuten.co.jp/documentation/books-total-search

JSON response structure when formatVersion is set to 2, providing a flatter structure for easier data access.

```json
{"items": [    {        "itemName": "a",        "itemPrice": 10    },    {        "itemName": "b",        "itemPrice": 20    }]}
```

--------------------------------

### API Error Response Formats

Source: https://webservice.rakuten.co.jp/documentation/books-foreign-search

Examples of error responses in different data formats.

```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>
```

--------------------------------

### GET https://openapi.rakuten.co.jp/ichibagt/api/IchibaGenre/Search/20260701

Source: https://webservice.rakuten.co.jp/documentation/ichiba-genre-search

Retrieves genre information based on the provided Genre ID.

```APIDOC
## GET https://openapi.rakuten.co.jp/ichibagt/api/IchibaGenre/Search/20260701

### Description
Retrieves genre names and their structure used in Rakuten Ichiba. Use genreId=0 to search from the genre root.

### Method
GET

### Endpoint
https://openapi.rakuten.co.jp/ichibagt/api/IchibaGenre/Search/20260701

### Parameters
#### Query Parameters
- **applicationId** (String) - Required - Application ID
- **accessKey** (String) - Required - Access key (can also be provided in header)
- **genreId** (String) - Optional - Use genreId=0 to search from the genre root
- **affiliateId** (String) - Optional - Affiliate ID
- **format** (String) - Optional - Response format (json or xml)
- **callback** (String) - Optional - Function name for JSONP output
- **elements** (String) - Optional - Comma-separated list of fields to include in response
- **formatVersion** (int) - Optional - Response format version (1 or 2)
```

--------------------------------

### GET https://openapi.rakuten.co.jp/services/api/BooksBook/Search/20170404

Source: https://webservice.rakuten.co.jp/documentation/books-book-search

Retrieves information about books on Rakuten Books based on specified search criteria.

```APIDOC
## GET https://openapi.rakuten.co.jp/services/api/BooksBook/Search/20170404

### Description
Retrieves book information from Rakuten Books. Requires at least one of the following parameters: title, author, publisherName, or other specific identifiers.

### Method
GET

### Endpoint
https://openapi.rakuten.co.jp/services/api/BooksBook/Search/20170404

### Parameters
#### Query Parameters
- **applicationId** (String) - Required - The application ID for authentication.
- **accessKey** (String) - Required - The access key for authentication.
- **title** (String) - Optional - Search by book title (UTF-8 URL encoded).
- **author** (String) - Optional - Search by author name (UTF-8 URL encoded).
- **publisherName** (String) - Optional - Search by publisher (UTF-8 URL encoded).
- **format** (String) - Optional - Response format (json or xml, default: json).
- **formatVersion** (int) - Optional - Response format version (1 or 2, default: 1).
- **elements** (String) - Optional - Comma-separated list of fields to include in the response.
```

--------------------------------

### Get Hotel Chain List API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves information about hotel chains.

```APIDOC
## Get Hotel Chain List API

### Description
Enables developers to retrieve information of hotel chains on Rakuten Travel.

### Authentication
App ID approval
```

--------------------------------

### GET https://openapi.rakuten.co.jp/services/api/BooksTotal/Search/20170404

Source: https://webservice.rakuten.co.jp/documentation/books-total-search

Retrieves book data based on search keywords and optional parameters.

```APIDOC
## GET https://openapi.rakuten.co.jp/services/api/BooksTotal/Search/20170404

### Description
Retrieves data about items listed on Rakuten Books. Developers can search by keyword and limit results by various parameters.

### Method
GET

### Endpoint
https://openapi.rakuten.co.jp/services/api/BooksTotal/Search/20170404

### Parameters
#### Query Parameters
- **applicationId** (String) - Required - Application ID for authentication.
- **accessKey** (String) - Required - Access key for authentication (can also be provided in header).
- **keyword** (String) - Required - Search keywords, UTF-8 URL encoded.
- **affiliateId** (String) - Optional - Affiliate ID.
- **format** (String) - Optional - Response format (json or xml). Defaults to json.
- **callback** (String) - Optional - Function name for JSONP output.
- **elements** (String) - Optional - Comma-separated list of fields to include in the response.
- **formatVersion** (int) - Optional - Response format version (1 or 2). Defaults to 1.
```

--------------------------------

### Get Area Class API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves district code information.

```APIDOC
## Get Area Class API

### Description
Enables developers to retrieve district code information on Rakuten Travel.

### Authentication
App ID approval
```

--------------------------------

### GET https://openapi.rakuten.co.jp/ichibagt/api/IchibaAttribute/Search/20260701

Source: https://webservice.rakuten.co.jp/documentation/ichiba-attribute-search

Retrieves attribute information for items in Rakuten Ichiba based on the provided genre and attribute identifiers.

```APIDOC
## GET https://openapi.rakuten.co.jp/ichibagt/api/IchibaAttribute/Search/20260701

### Description
Retrieves attribute information for items in Rakuten Ichiba. Developers can retrieve attribute information by specifying Genre ID and optionally Attribute ID.

### Method
GET

### Endpoint
https://openapi.rakuten.co.jp/ichibagt/api/IchibaAttribute/Search/20260701

### Parameters
#### Query Parameters
- **applicationId** (String) - Required - App ID for authentication.
- **accessKey** (String) - Required - Access key for authentication (can also be provided in header).
- **genreId** (String) - Required - Genre ID to search attributes for.
- **attributeId** (String) - Optional - Specific attribute ID to retrieve.
- **affiliateId** (String) - Optional - Affiliate ID.
- **format** (String) - Optional - Response format (json or xml). Default is json.
- **callback** (String) - Optional - Function name for JSONP output.
- **elements** (String) - Optional - Comma-separated list of fields to include in the response.
- **formatVersion** (int) - Optional - Response format version (1 or 2). Default is 1.
```

--------------------------------

### API Error Response Examples

Source: https://webservice.rakuten.co.jp/documentation/books-foreign-search

JSON error response bodies for various HTTP status codes returned by the API.

```json
{
    "error": "wrong_parameter",
    "error_description": "specify valid applicationId"
}
```

```json
{
    "error": "wrong_parameter",
    "error_description": "keyword parameter is not valid"
}
```

```json
{
    "error": "not_found",
    "error_description": "not found"
}
```

```json
{
    "error": "too_many_requests",
    "error_description": "number of allowed requests has been exceeded for this API. please try again soon."
}
```

```json
{
    "error": "system_error",
    "error_description": "api logic error"
}
```

```json
{
    "error": "service_unavailable",
    "error_description": "XXX/XXX is under maintenance"
}
```

--------------------------------

### GET https://openapi.rakuten.co.jp/ichibams/api/IchibaItem/Search/20260701

Source: https://webservice.rakuten.co.jp/documentation/ichiba-item-search

Retrieves a list of items from Rakuten Ichiba based on search criteria such as keywords, shop codes, or genre IDs.

```APIDOC
## GET https://openapi.rakuten.co.jp/ichibams/api/IchibaItem/Search/20260701

### Description
Retrieves item data from Rakuten Ichiba. Users can search by keyword, shop code, or other criteria.

### Method
GET

### Endpoint
https://openapi.rakuten.co.jp/ichibams/api/IchibaItem/Search/20260701

### Parameters
#### Query Parameters
- **applicationId** (String) - Required - The App ID for the request.
- **accessKey** (String) - Required - The access key for the request (can also be provided in headers).
- **keyword** (String) - Optional - Search keywords (UTF-8 URL encoded).
- **shopCode** (String) - Optional - The shop code identifier.
- **affiliateId** (String) - Optional - Affiliate ID.
- **format** (String) - Optional - Response format (json or xml).
- **callback** (String) - Optional - Callback function name for JSONP.
- **elements** (String) - Optional - Comma-separated list of fields to include in the response.
- **formatVersion** (int) - Optional - Response format version (1 or 2).
```

--------------------------------

### GET /BooksTotalSearch

Source: https://webservice.rakuten.co.jp/documentation/books-total-search

Performs a search across Rakuten Books based on provided criteria. At least one of search keyword, Rakuten Books genre ID, or ISBN/JAN code is required.

```APIDOC
## GET /BooksTotalSearch

### Description
Search for items in Rakuten Books. Requires at least one of: search keyword, booksGenreId, or isbnjan.

### Method
GET

### Query Parameters
- **keyword** (String) - Optional - Search keyword (UTF-8 URL encoded)
- **booksGenreId** (String) - Optional - ID to specify the genre in Rakuten Books
- **isbnjan** (String) - Optional - ISBN or JAN code (13 numeric characters)
- **hits** (int) - Optional - Number of results per page (1-30, default 30)
- **page** (int) - Optional - Result page (1-100, default 1)
- **availability** (int) - Optional - Filter by availability status (0-6)
- **outOfStockFlag** (int) - Optional - Include/exclude unavailable items (0 or 1)
- **chirayomiFlag** (int) - Optional - Filter by Chirayomi availability (0 or 1)
- **sort** (String) - Optional - Sort order (standard, sales, +releaseDate, -releaseDate, +itemPrice, -itemPrice, reviewCount, reviewAverage)
- **limitedFlag** (int) - Optional - Filter by limited item status (0 or 1)
- **field** (int) - Optional - Search field breadth (0 or 1)
- **carrier** (int) - Optional - Device type (0 for PC, 1 for mobile)
- **orFlag** (int) - Optional - AND/OR search flag (0 or 1)
- **NGKeyword** (String) - Optional - Excluded keywords (UTF-8 URL encoded)
- **genreInformationFlag** (int) - Optional - Include genre item counts (0 or 1)
```

--------------------------------

### GET /ichibaranking/api/IchibaItem/Ranking/20220601

Source: https://webservice.rakuten.co.jp/documentation/ichiba-item-ranking

Retrieves ranking information from Rakuten Ichiba. Parameters can be used to filter by genre, age, or gender.

```APIDOC
## GET /ichibaranking/api/IchibaItem/Ranking/20220601

### Description
Retrieves sales ranking data from the Rakuten Ichiba Ranking section. Data can be filtered by genre, age, or gender.

### Method
GET

### Endpoint
https://openapi.rakuten.co.jp/ichibaranking/api/IchibaItem/Ranking/20220601

### Parameters
#### Query Parameters
- **applicationId** (String) - Required - The application ID for authentication.
- **accessKey** (String) - Optional - Access key, can be provided as a header or query parameter.
- **genreId** (Integer) - Optional - The ID of the genre to filter by. Cannot be used with age or sex.
- **age** (Integer) - Optional - The age group to filter by.
- **sex** (Integer) - Optional - The gender to filter by (1 for male, etc.).
```

--------------------------------

### Create Affiliate URL

Source: https://webservice.rakuten.co.jp/documentation/ichiba-item-ranking

Manual construction of an affiliate URL using the Item URL and Affiliate ID.

```text
http://hb.afl.rakuten.co.jp/hgc/[Affiliate ID]/?pc=[Item URL(PC)]&m=[Item URL(mobile)]
```

--------------------------------

### Books Software Search API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves information about selling software on Rakuten Books with advanced search capabilities.

```APIDOC
## Books Software Search API

### Description
Enables developers to retrieve information of selling software on Rakuten Books. Allows advanced search by specifying software name and publisher, with additional filtering options.
```

--------------------------------

### Generate Affiliate URL Manually

Source: https://webservice.rakuten.co.jp/documentation/books-total-search

Use this URL pattern to manually construct an affiliate link using the item URL and affiliate ID.

```text
https://hb.afl.rakuten.co.jp/hgc/[Affiliate]/?pc=[Item URL(PC)]&m=[Item URL(mobile)]
```

--------------------------------

### Handle 404 Not Found Error

Source: https://webservice.rakuten.co.jp/documentation/books-magazine-search

JSON response returned when the requested data cannot be found.

```json
{
    "error": "not_found",
    "error_description": "not found"
}
```

--------------------------------

### Item Price Navi API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves information about products selling on Rakuten Product.

```APIDOC
## Item Price Navi API

### Description
Retrieves information of selling products on Rakuten Product.

### Parameters
- **Keyword** (string) - Required - Search term for products.
- **Genre** (string) - Required - Filter by product genre.
```

--------------------------------

### API Endpoint Base URL

Source: https://webservice.rakuten.co.jp/documentation/books-total-search

The base URL for the Rakuten Books Total Search API. Parameters should be appended as query strings.

```text
https://openapi.rakuten.co.jp/services/api/BooksTotal/Search/20170404?[parameter]=[value]…
```

--------------------------------

### Rakuten Ichiba Item Search API Parameters

Source: https://webservice.rakuten.co.jp/documentation/ichiba-item-search

Overview of the available input parameters and output fields for the Item Search API.

```APIDOC
## Rakuten Ichiba Item Search API (v2026-07-01)

### Description
The Item Search API allows searching for products on Rakuten Ichiba. It supports various filters and returns comprehensive item details.

### Input Parameters
- **hasMovieFlag** (int) - Optional - 0: All products, 1: Only products with movies
- **pamphletFlag** (int) - Optional - 0: All products, 1: Only products with pamphlets
- **appointDeliveryDateFlag** (int) - Optional - 0: All products, 1: Only products for which the delivery date can be specified
- **elements** (String) - Optional - Comma separated list of output elements to return
- **genreInformationFlag** (int) - Optional - 0: Do not get number of items in each genre, 1: Get number of items in each genre
- **attributeFlag** (int) - Optional - 0: Do not get attributes, 1: Get attributes (requires genreId)

### Output Parameters
- **count** (int) - Total number of items in the search results
- **page** (int) - Current page number
- **hits** (int) - Number of results returned
- **itemName** (String) - Name of the item
- **itemPrice** (int) - Price of the item
- **itemUrl** (String) - URL of the item
- **affiliateUrl** (String) - Affiliate URL (if affiliateId is provided)
- **availability** (int) - 0: Out of stock, 1: Available
- **smallImageUrls** (Array) - Array of up to three 64x64 image URLs
- **mediumImageUrls** (Array) - Array of up to three 128x128 image URLs
```

--------------------------------

### Rakuten Ichiba Ranking API Parameters

Source: https://webservice.rakuten.co.jp/documentation/ichiba-item-ranking

This section details the input parameters available for the Rakuten Ichiba Ranking API, including authentication, formatting, and filtering options.

```APIDOC
## Rakuten Ichiba Ranking API

### Description
Retrieve item ranking information from Rakuten Ichiba based on specified filters.

### Query Parameters
#### Shared Parameters
- **applicationId** (String) - Required - Application ID.
- **accessKey** (String) - Required - Access Key (can be in header or query).
- **affiliateId** (String) - Optional - Affiliate ID.
- **format** (String) - Optional - Response format (json or xml).
- **callback** (String) - Optional - Callback function name for JSONP.
- **elements** (String) - Optional - Comma-separated list of fields to include in response.
- **formatVersion** (int) - Optional - Response format version (1 or 2).

#### Service Specific Parameters
- **genreId** (long) - Optional - Genre ID for filtering.
- **age** (int) - Optional - Age group (10, 20, 30, 40, 50).
- **sex** (int) - Optional - Gender (0: Male, 1: Female).
- **carrier** (int) - Optional - Platform (0: PC, 1: mobile).
- **page** (int) - Optional - Page number (1-34).
- **period** (string) - Optional - Ranking period (e.g., realtime).

### Response
#### Success Response (200)
- **title** (String) - Ranking title.
- **lastBuildDate** (String) - Time of last update.
- **items** (Array) - List of ranked items containing rank, carrier, itemName, catchcopy, itemCode, itemPrice, itemPriceBaseField, itemPriceMax1, itemPriceMax2, and itemPriceMax3.
```

--------------------------------

### Rakuten DVD/Bluray Search API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves information about selling DVDs and Blu-rays on Rakuten Books with advanced search capabilities.

```APIDOC
## Rakuten DVD/Bluray Search API

### Description
Enables developers to retrieve information of selling DVD/Blue-ray on Rakuten Books. Allows advanced search by specifying title, actor/actress, and publisher, with additional filtering options.
```

--------------------------------

### Response Format Versions

Source: https://webservice.rakuten.co.jp/documentation/ichiba-genre-search

Comparison of JSON response structures based on the formatVersion parameter.

```json
{"items": [
    {"item": {
        "itemName": "a",
        "itemPrice": 10
    }},
    {"item": {
        "itemName": "b",
        "itemPrice": 20
    }}
]}
```

```json
{"items": [
    {
        "itemName": "a",
        "itemPrice": 10
    },
    {
        "itemName": "b",
        "itemPrice": 20
    }
]}
```

--------------------------------

### Recipe Category List API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves a list of categories available on Rakuten Recipe.

```APIDOC
## Recipe Category List API

### Description
Enables developers to retrieve a list of the categories on Rakuten Recipe.

### Authentication
App ID approval
```

--------------------------------

### Books CD Search API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves information about selling CDs on Rakuten Books with advanced search capabilities.

```APIDOC
## Books CD Search API

### Description
Enables developers to retrieve information of selling CDs on Rakuten Books. Allows advanced search by specifying CD title, artist, and publisher, with additional filtering options.
```

--------------------------------

### Handle 503 Service Unavailable Error

Source: https://webservice.rakuten.co.jp/documentation/books-magazine-search

JSON response returned when the service is undergoing maintenance or is overloaded.

```json
{
    "error": "service_unavailable",
    "error_description": "XXX/XXX is under maintenance"
}
```

--------------------------------

### Rakuten Game Search API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves information about selling games on Rakuten Books with advanced search capabilities.

```APIDOC
## Rakuten Game Search API

### Description
Enables developers to retrieve information of selling games on Rakuten Books. Allows advanced search by specifying game title and publisher, with additional filtering options.
```

--------------------------------

### API Endpoint Base URL

Source: https://webservice.rakuten.co.jp/documentation/books-book-search

The base URL for making REST/JSON requests to the Books Book Search service.

```text
https://openapi.rakuten.co.jp/services/api/BooksBook/Search/20170404?[parameter]=[value]…
```

--------------------------------

### Recipe Category Ranking API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves the top rankings by category on Rakuten Recipe.

```APIDOC
## Recipe Category Ranking API

### Description
Enables developers to retrieve a list of the top rankings by category on Rakuten Recipe.

### Authentication
App ID approval
```

--------------------------------

### Kobo Genre Search API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves a list of genres on Rakuten Kobo.

```APIDOC
## Kobo Genre Search API

### Description
Enables developers to retrieve a list of the genres on Rakuten Kobo.

### Authentication
App ID approval
```

--------------------------------

### Books Total Search API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves information about selling items on Rakuten Books using keywords and filters.

```APIDOC
## Books Total Search API

### Description
Enables developers to retrieve information of selling items on Rakuten Books. Developers can obtain item information by specifying a keyword and filtering by genre, inventory status, and other criteria.
```

--------------------------------

### Books Genre Search API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves genre names and structures on Rakuten Books.

```APIDOC
## Books Genre Search API

### Description
Enables developers to retrieve genre name and genre structure on Rakuten Books by specifying a Genre ID.
```

--------------------------------

### Rakuten Ichiba Ranking API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves top-selling item information on Rakuten Ichiba.

```APIDOC
## Rakuten Ichiba Ranking API

### Description
Retrieves top-selling items based on genre, gender, or age group, providing up to 1000 items and 3 images per item.

### Parameters
- **Genre** (string) - Optional - Filter by genre.
- **Gender** (string) - Optional - Filter by gender.
- **Age Group** (string) - Optional - Filter by age group.
```

--------------------------------

### Handle 429 Too Many Requests Error

Source: https://webservice.rakuten.co.jp/documentation/books-magazine-search

JSON response returned when the API request limit has been exceeded.

```json
{
    "error": "too_many_requests",
    "error_description": "number of allowed requests has been exceeded for this API. please try again soon."
}
```

--------------------------------

### GORA Golf Plan Search API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves golf plans and reservation status on Rakuten GORA.

```APIDOC
## GORA Golf Plan Search API

### Description
Enables developers to retrieve information of golf plans and reservation status on Rakuten Gora.

### Authentication
App ID approval
```

--------------------------------

### Handle 500 Internal Server Error

Source: https://webservice.rakuten.co.jp/documentation/books-magazine-search

JSON response returned when an internal system error occurs within the Rakuten Web Service.

```json
{
    "error": "system_error",
    "error_description": "api logic error"
}
```

--------------------------------

### Books Foreign Search API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves information about selling foreign books on Rakuten Books with advanced search capabilities.

```APIDOC
## Books Foreign Search API

### Description
Enables developers to retrieve information of selling foreign books on Rakuten Books. Allows advanced search by specifying title, author, and publisher, with additional filtering options.
```

--------------------------------

### Rakuten Ichiba Genre Search API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves genre names and the genre structure on Rakuten Ichiba.

```APIDOC
## Rakuten Ichiba Genre Search API

### Description
Retrieves genre information and structure on Rakuten Ichiba.

### Parameters
- **Genre ID** (string) - Required - The identifier for the specific genre.
```

--------------------------------

### Vacant Hotel Search API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves real-time vacancy information for hotels.

```APIDOC
## Vacant Hotel Search API

### Description
Enables developers to specify district code, latitude/longitude as well as hotel number, and retrieve information of available rooms to book.

### Authentication
App ID approval
```

--------------------------------

### Kobo eBook Search API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves information about ebooks sold on Rakuten Kobo.

```APIDOC
## Kobo eBook Search API

### Description
Enables developers to retrieve information of selling ebooks on Rakuten Kobo.

### Authentication
App ID approval
```

--------------------------------

### API Endpoint URL

Source: https://webservice.rakuten.co.jp/documentation/ichiba-genre-search

The base REST endpoint for the Genre Search API.

```text
https://openapi.rakuten.co.jp/ichibagt/api/IchibaGenre/Search/20260701?[parameter]=[value]…
```

--------------------------------

### API Endpoint Base URL

Source: https://webservice.rakuten.co.jp/documentation/ichiba-item-ranking

The base endpoint for the Rakuten Ichiba Item Ranking API.

```text
https://openapi.rakuten.co.jp/ichibaranking/api/IchibaItem/Ranking/20220601?[parameter]=[value]…
```

--------------------------------

### Hotel Ranking API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves top-ranked hotel information.

```APIDOC
## Hotel Ranking API

### Description
Enables developers to retrieve information of Hotel Ranking on Rakuten Travel, including Overall, Onsen Hotel, and Luxury Hotel genres.

### Authentication
App ID approval
```

--------------------------------

### Rakuten Ichiba Item Search API

Source: https://webservice.rakuten.co.jp/documentation

Enables developers to retrieve information about items selling on Rakuten Ichiba by specifying keywords or filtering by item code, shop name, or genre.

```APIDOC
## Rakuten Ichiba Item Search API

### Description
Retrieves information of selling items on Rakuten Ichiba, excluding auctions, flea markets, and C2C listings.

### Parameters
- **Keyword** (string) - Optional - Search term for items.
- **Item Code** (string) - Optional - Filter by specific item identifier.
- **Shop Name** (string) - Optional - Filter by shop name.
- **Genre Name** (string) - Optional - Filter by genre name.
```

--------------------------------

### API Endpoint URL

Source: https://webservice.rakuten.co.jp/documentation/ichiba-item-search

The base URL for making requests to the Ichiba Item Search API.

```text
https://openapi.rakuten.co.jp/ichibams/api/IchibaItem/Search/20260701?[parameter]=[value]…
```

--------------------------------

### Attribute Information Response

Source: https://webservice.rakuten.co.jp/documentation/ichiba-attribute-search

Describes the structure of the attribute information returned by the API.

```APIDOC
## Attribute Information Response

### Description
The API returns an array of attribute information objects.

### Response Fields
- **attributes** (Array) - List of attribute information
- **id** (String) - Attribute ID
- **nameJa** (String) - Attribute name (Japanese)
```

--------------------------------

### Rakuten Books Book Search API

Source: https://webservice.rakuten.co.jp/documentation/books-book-search

The Book Search API allows searching for books using various parameters. At least one of the following is required: Title, Author name, Publisher, Size of the book, ISBN code, or Rakuten Books Genre ID.

```APIDOC
## GET /Books/Search

### Description
Search for books in the Rakuten Books catalog based on specific criteria.

### Parameters
#### Query Parameters
- **size** (int) - Optional - Search by size of the book (0:All, 1:Book, 2:Paperback, 3:New book, 4:Complete set, 5:Dictionary/Encyclopedia, 6:Illustrated reference book, 7:Picture book, 8:Cassette tape/CD, 9:Comic, 10:Magazine book/other)
- **isbn** (String) - Optional - Search by ISBN code
- **booksGenreId** (String) - Optional - ID to specify the genre in Rakuten Books (must belong to 001)
- **hits** (int) - Optional - Number of results per page (1-30)
- **page** (int) - Optional - Result page (1-100)
- **availability** (int) - Optional - Filter by availability (0:All, 1:Available, 2:3-7 days, 3:3-9 days, 4:Backorder, 5:Reservations, 6:Inventory check)
- **outOfStockFlag** (int) - Optional - Include unavailable items (0:Exclude, 1:Include)
- **chirayomiFlag** (int) - Optional - Filter by Chirayomi item (0:All, 1:Chirayomi only)
- **sort** (String) - Optional - Sort order (standard, sales, +releaseDate, -releaseDate, +itemPrice, -itemPrice, reviewCount, reviewAverage)
- **limitedFlag** (int) - Optional - Filter by limited item (0:All, 1:Limited only)
- **carrier** (int) - Optional - Filter by carrier (0:PC, 1:Mobile)
- **genreInformationFlag** (int) - Optional - Get number of items for each genre (0:No, 1:Yes)

### Response
#### Success Response (200)
- **count** (int) - Total number of items
- **page** (int) - Current page number
- **first** (int) - Result number to display from
- **last** (int) - Result number to display until
- **hits** (int) - Number of results returned
- **carrier** (int) - Platform (0:PC, 1:Mobile)
- **pageCount** (int) - Total page count
- **Items** (Array) - List of book items containing title, titleKana, subTitle, subTitleKana, seriesName, seriesNameKana, contents, contentsKana, author, authorKana, publisherName, size, isbn, itemCaption, salesDate, itemPrice
```

--------------------------------

### Books Magazine Search API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves information about selling magazines on Rakuten Books with advanced search capabilities.

```APIDOC
## Books Magazine Search API

### Description
Enables developers to retrieve information of selling magazines on Rakuten Books. Allows advanced search by specifying magazine title and publisher, with additional filtering options.
```

--------------------------------

### API Endpoint Base URL

Source: https://webservice.rakuten.co.jp/documentation/ichiba-attribute-search

The base URL for the Rakuten Ichiba Attribute Search API.

```text
https://openapi.rakuten.co.jp/ichibagt/api/IchibaAttribute/Search/20260701?[parameter]=[value]…
```

--------------------------------

### Hotel Detail Search API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves detailed information for specific hotels.

```APIDOC
## Hotel Detail Search API

### Description
Enables developers to retrieve detailed information of hotels on Rakuten Travel.

### Authentication
App ID approval
```

--------------------------------

### GORA Golf Course Detail API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves detailed information for a specific golf course on Rakuten GORA.

```APIDOC
## GORA Golf Course Detail API

### Description
Enables developers to retrieve detailed information of golf courses on Rakuten Gora.

### Authentication
App ID approval
```

--------------------------------

### Rakuten Ichiba Attribute Search API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves attribute information for items on Rakuten Ichiba.

```APIDOC
## Rakuten Ichiba Attribute Search API

### Description
Retrieves attribute information based on genre and optional attribute identifiers.

### Parameters
- **Genre ID** (string) - Required - The identifier for the genre.
- **Attribute ID** (string) - Optional - The identifier for the specific attribute.
```

--------------------------------

### Rakuten Ichiba Tag Search API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves tag names and tag structures on Rakuten Ichiba.

```APIDOC
## Rakuten Ichiba Tag Search API

### Description
Retrieves tag information using a Tag ID obtained from Item Search or Genre Search APIs.

### Parameters
- **Tag ID** (string) - Required - The identifier for the tag.
```

--------------------------------

### Simple Hotel Search API

Source: https://webservice.rakuten.co.jp/documentation

Retrieves hotel information based on hotel number, latitude/longitude, or division code.

```APIDOC
## Simple Hotel Search API

### Description
Enables developers to specify hotel number, latitude/longitude as well as division code, and retrieve information of the hotels on Rakuten Travel.

### Authentication
App ID approval
```

--------------------------------

### API Error Handling

Source: https://webservice.rakuten.co.jp/documentation/ichiba-genre-search

Details on how the API communicates errors through HTTP status codes and JSON/XML response bodies.

```APIDOC
## Error Handling

### Description
Errors are returned using standard HTTP status codes and a response body containing an error code and description.

### Error Responses
- **400** (Parameter error) - Required parameters missing or invalid.
- **404** (Not found) - Requested data does not exist.
- **429** (Too many requests) - Rate limit exceeded.
- **500** (Internal error) - Rakuten Web Service internal system error.
- **503** (Unavailable) - Service under maintenance or overloaded.

### Response Format
Errors can be returned in JSON or XML format based on the requested format parameter.
```

--------------------------------

### Keyword Hotel Search API

Source: https://webservice.rakuten.co.jp/documentation

Searches for hotels using keywords and filters.

```APIDOC
## Keyword Hotel Search API

### Description
Enables developers to specify keyword and retrieve information of hotels on Rakuten Travel. Developers are allowed to filter the search with keyword or district code.

### Authentication
App ID approval
```

--------------------------------

### GORA Golf Course Search API

Source: https://webservice.rakuten.co.jp/documentation

Searches for golf courses on Rakuten GORA using keywords, area, or coordinates.

```APIDOC
## GORA Golf Course Search API

### Description
Enables developers to specify keyword, area, latitude/longitude, and retrieve information of golf courses on Rakuten Gora.

### Authentication
App ID approval
```
Tokens:
Raw