Company logoHelp Center
Visit api.bungalow.net

House Details

7 min. readlast update: 11.28.2024

The House Details endpoint provides detailed information about specific holiday houses. This includes data on capacity, features, services, and availability. Use this endpoint to fetch details about a house using its unique identifier (houseId).

House details

Accommodations can have mandatory services, optional services, preferences and features linked to them.

Mandatory services

These are additional costs beyond the rental price that are essential for ensuring a quality guest experience, such as electricity, water usage, etc. Mandatory costs are included in the total price calculation.

Mandatory service examples:

  • electricity
  • water
  • final cleaning
  • extra cleaning in case of pets

Optional services

Optional services can be added to the reservation for an additional fee. These should be displayed during the reservation process, allowing guests to choose the services they wish to include.

Optional service examples:

  • extra baby bed
  • baby high chair
  • barbeque package
  • linen change
  • extra cleaning
  • breakfast
  • kids comfort package
  • adults comfort package
  • extra towel set
  • extra kitchen towel set

Preferences

Preferences can be selected at an additional cost when creating a reservation. It's important to note that the availability of specific preferences varies by house unit—some units offer certain preferences, while others offer different ones. Therefore, if preferences are used, the available house units must be filtered accordingly during the reservation process.

Additionally, certain checks are required during the reservation process. For instance, if guests indicate they are bringing pets, the "pet-free accommodation" preference should no longer be applicable. These checks must be implemented by the partner, as they are not handled by the API.

Preference examples:

  • patio heater
  • enclosed garden
  • shielded terrace
  • private jetty
  • outdoor storage room
  • specific house number
  • pet-free accommodation

Features or amenities

Each accommodation type offers specific features or amenities that are important to guests. These should be clearly presented to help them make an informed choice when selecting a holiday house.

Feature examples:

  • playground
  • bathtub
  • equiped kitchen
  • own terrace
  • parking
  • private swimming pool
  • jacuzzi
  • sauna

Endpoint

URL:
GET /bungalow/api/v1/booking/houseDetails

Description:
Retrieve detailed information about a holiday house by its unique houseId.

Authentication:
Requires a a partner ID and a valid API key in the request header.

Request Parameters

  • Path Parameter:

    • houseId (integer): The unique identifier for the house. Required.

  • Optional Query Parameters:

    • startDate (string, format: YYYY-MM-DD): Specify the desired start date for availability and pricing.
    • endDate (string, format: YYYY-MM-DD): Specify the desired end date for availability and pricing.

Response Model

The endpoint returns a JSON object structured as follows:

HouseSearchResult

Field Type Description
numberOfPersons NumberOfPersonsModel Breakdown of age groups queried for the house.
houseId integer Unique identifier of the house.
name string Name of the house.
nrPersons TranslatedProperty Total capacity of the house (number of persons).
pictures Array[string] URLs of house images.
pictureThumbnails Array[string] URLs of thumbnail images.
bedrooms TranslatedProperty Number of bedrooms.
bathrooms TranslatedProperty Number of bathrooms.
numberOfBeds TranslatedProperty Total number of beds.
numberOfPets TranslatedProperty Maximum number of pets allowed.
surface TranslatedPropertyString Surface area of the house.
parkingLot TranslatedProperty Indicates parking availability.
virtualTourLink string Link to the virtual tour of the house.
nationalIdentificationNumber string Internal national identifier for the house.
descriptionLocation string Description of the house’s location.
descriptionInterior string Description of the house’s interior.
descriptionSurroundings string Description of the surrounding area.
descriptionParkConditions string Description of park conditions and regulations.
selectedPeriod PriceResult Pricing details for the selected period.
availableStartDates Array[string] List of available start dates.
availableEndDates Array[string] List of available end dates.
mandatoryServices Array[HouseServiceResult] List of mandatory services and their costs.
optionalServices Array[HouseServiceResult] List of optional services and their costs.
preferences Array[HouseServiceResult] List of preferences or configurable options.
features Array[HouseFeatureResult] List of house features.

Models

NumberOfPersonsModel

Field Type Description
total integer Total number of persons (adults + children).
child0002 integer Number of children aged 0-2.
child0304 integer Number of children aged 3-4.
child0512 integer Number of children aged 5-12.
child1317 integer Number of children aged 13-17.
adults integer Number of adults.

PriceResult

Field Type Description
startDate string Start date of the selected period.
endDate string End date of the selected period.
fullPrice number Total price for the selected period.
discountedPrice number Discounted price, if available.
cancellationFundPossible boolean Indicates if a cancellation fund is possible.
cancellationFund number Cost of the cancellation fund, if applicable.
numberOfPersons NumberOfPersonsModel Breakdown of persons.
numberOfPets integer Number of pets included in the pricing.
voucherAmount number Amount covered by a voucher, if applicable.
 
 

Example Request

curl -X GET "https://bungalow/api/v1/booking/houseDetails/12345?startDate=2024-12-01&endDate=2024-12-08" \
    -H "x-security-key: <YOUR_API_KEY> x-partner: <YOUR_PARTNER_ID>"

Example Response

{
  "numberOfPersons": {
    "total": 4,
    "child0002": 0,
    "child0304": 1,
    "child0512": 1,
    "child1317": 0,
    "adults": 2
  },
  "houseId": 12345,
  "name": "Test Villa",
  "nrPersons": {
    "name": "persons",
    "value": {4}
  },
  "pictures": [
    "https://example.com/images/villa12345-1.jpg",
        "https://example.com/images/villa12345-2.jpg"
  ],
  "pictureThumbnails": [
    "https://example.com/images/villa12345.jpg"
  ],
  "bedrooms": {
    "name": "bedrooms",
    "value": {2}
  },
  "bathrooms": {
    "name": "bathrooms",
    "value": {1}
  },
  "numberOfBeds": {
    "name": "beds",
    "value": {4}
  },
  "numberOfPets": {
    "name": "pets",
    "value": {1}
  },
  "surface": {
    "name": "surface",
    "value": "75"
  },
  "parkingLot": {
    "name": "parking",
    "value": {1}
  },
  "virtualTourLink": "string",
  "descriptionLocation": "string",
  "descriptionInterior": "string",
  "descriptionSurroundings": "string",
  "descriptionParkConditions": "string",
  "selectedPeriod": {
    "startDate": "2024-11-28T14:55:09.493Z",
    "endDate": "2024-11-30T14:55:09.493Z",
    "fullPrice": 425,
    "discountedPrice": 395,
    "cancellationFundPossible": true,
    "cancellationFund": 15,
    "numberOfPersons": {
      "total": 4,
      "child0002": 0,
      "child0304": 1,
      "child0512": 1,
      "child1317": 0,
      "adults": 2
    },
    "numberOfPets": 1,
    "voucherAmount": 0
  },
  "availableStartDates": [
    "2024-11-28T14:55:09.493Z"
  ],
  "availableEndDates": [
    "2024-11-30T14:55:09.493Z"
  ],
  "mandatoryServices": [
    {
      "id": 123,
      "serviceName": "Electricity",
      "cost": 2,
      "costType": "PER_NIGHT",
      "groupName": "General",
      "keyword": "Electra",
      "hasDatePicker": false
    }
  ],
  "optionalServices": [
    {
      "id": 234,
      "serviceName": "Towel Set",
      "cost": 5,
      "costType": "PER_STAY",
      "groupName": "Linen",
      "keyword": "linen",
      "hasDatePicker": false
    }
  ],
  "preferences": [
    {
      "id": 345,
      "serviceName": "Patio Heater",
      "cost": 10,
      "costType": "PER_STAY",
      "groupName": "string",
      "keyword": "string",
      "hasDatePicker": false
    }
  ],
  "features": [
    {
      "keyword": "bikeforrent",
      "available": true,
      "featureName": "Bike Rental"
    }
  ]
}

Notes

  • Use a valid houseId for accurate data retrieval.
Was this article helpful?