Travel/HotelDetailSeach

Description

Gets a hotel details by hotel number.

Resource URL

https://app.rakuten.co.jp/services/api/Travel/HotelDetailSearch/20131024

Resource Information

Auth Type App Key
Affiliation Support Yes

Parameters

Hotel Number (integer)

Hotel number from Rakuten Travel API.

App ID (string)

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

Platform (integer)

Whether to return information for PC/smartphone or mobile phone.

Valid Values:

  • 0 PC / smartphone
  • 1 feature phones

Default Value: 0

Latitude and longitude type (integer)

It specifies the latitude and longitude type of input and output parameters.

Valid Values:

  • 1 World Geodetic System.
  • 2 Japan geodetic system.

Default Value: 2

Hotel Thumbnail Size (integer)

Specify the image size of the hotel image thumbnail URL of the output parameters.

Valid Values:

  • 1 Small
  • 2 Medium
  • 3 Large

Default Value: 2

Response Type (string)

Specify the amount of information returned in the response:

Valid Values:

  • small minimum amount of information
  • middle standard amount of information
  • large all the information

Default Value: middle

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

hotelNo

Hotel Number
integer Required

Hotel number from Rakuten Travel API.

applicationId

App ID
string Required

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

carrier

Platform
integer Optional

Whether to return information for PC/smartphone or mobile phone.

Valid Values:

  • 0 PC / smartphone
  • 1 feature phones

Default Value: 0

datumType

Latitude and longitude type
integer Optional

It specifies the latitude and longitude type of input and output parameters.

Valid Values:

  • 1 World Geodetic System.
  • 2 Japan geodetic system.

Default Value: 2

hotelThumbnailSize

Hotel Thumbnail Size
integer Optional

Specify the image size of the hotel image thumbnail URL of the output parameters.

Valid Values:

  • 1 Small
  • 2 Medium
  • 3 Large

Default Value: 2

responseType

Response Type
string Optional

Specify the amount of information returned in the response:

Valid Values:

  • small minimum amount of information
  • middle standard amount of information
  • large all the information

Default Value: middle

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/Travel/HotelDetailSearch/20131024?applicationId=REPLACE_WITH_YOUR_APP_ID&hotelNo=136197

Response
{
  "hotels": [
    {
      "hotel": [
        {
          "hotelBasicInfo": {
            "hotelNo": 136197,
            "hotelName": "葵 KYOTO STAY",
            "hotelInformationUrl": "http://img.travel.rakuten.co.jp/image/tr/api/if/uPw0Q/?f_no=136197",
            "planListUrl": "http://img.travel.rakuten.co.jp/image/tr/api/if/ZwI4Q/?f_no=136197&f_flg=PLAN",
            "dpPlanListUrl": "http://img.travel.rakuten.co.jp/image/tr/api/if/G02wZ/?noTomariHotel=136197",
            "reviewUrl": "http://img.travel.rakuten.co.jp/image/tr/api/if/50xNk/?f_hotel_no=136197",
            "hotelKanaName": "あおい きょうと すてい",
            "hotelSpecial": "川面のきらめく光。選び抜かれた骨董が古き良き時代へ誘います。ライブラリーで読書、川床テラスでお茶を。",
            "hotelMinCharge": 14800,
            "latitude": 125994.28,
            "longitude": 488781.51,
            "postalCode": "600-8013",
            "address1": "京都府",
            "address2": "京都市下京区木屋町通仏光寺上る天王町145-1 (オフィス)※町家は別の場所になります。",
            "telephoneNo": "075-354-7770",
            "faxNo": "075-354-7772",
            "access": "京阪「清水五条駅」徒歩5分/阪急「河原町駅」、京阪「祇園四条駅」徒歩10分/JR「京都駅」タクシーで10分",
            "parkingInformation": "無し:お近くのコインパーキングをご案内致します。",
            "nearestStation": null,
            "hotelImageUrl": "http://img.travel.rakuten.co.jp/share/HOTEL/136197/136197.jpg",
            "hotelThumbnailUrl": "http://img.travel.rakuten.co.jp/HIMG/90/136197.jpg",
            "roomImageUrl": "http://img.travel.rakuten.co.jp/share/HOTEL/136197/136197_1f.jpg",
            "roomThumbnailUrl": "http://img.travel.rakuten.co.jp/HIMG/INTERIOR/136197.jpg",
            "hotelMapImageUrl": "http://img.travel.rakuten.co.jp/share/HOTEL/136197/136197map.gif",
            "reviewCount": null,
            "reviewAverage": null,
            "userReview": null
          }
        },
        {
          "hotelRatingInfo": {
            "serviceAverage": null,
            "locationAverage": null,
            "roomAverage": null,
            "equipmentAverage": null,
            "bathAverage": null,
            "mealAverage": null
          }
        }
      ]
    }
  ]
}

Try It

Set the Parameters

  Show More Parameters

Request

https://app.rakuten.co.jp/services/api/Travel/HotelDetailSearch/20131024?applicationId=REPLACE_WITH_YOUR_APP_ID

Response