Apartment

Create or update an apartment

post/v2/apartment

Request

  • Base URL: https://provider-api-sandbox.holidu.com
  • URL: https://provider-api-sandbox.holidu.com/v2/apartment
  • Auth: API key in header api-key

Query parameters

providerApartmentIdstring
providerstring
holiduApartmentIdinteger

Request body

providerApartmentGroupIdstring

ID of the house where apartment is located. If several apartments are located in one house, they'll share the same providerApartmentGroupId

latnumber required

Latitude

lngnumber required

Longitude

namestring

Name of the apartment

numberOfBedroomsinteger
numberOfLivingroomsinteger
numberOfBathroomsinteger
sizeInSqmnumber

Size of apartment in square meters

apartmentType'ALLOTMENT_GARDEN' | 'APARTMENT' | 'APARTMENT_HOTEL' | 'BARN' | 'BEACH_HUT' | 'BED_AND_BREAKFAST' | 'BOAT' | 'BUNGALOW' | 'CAMPER' | 'CAMPING' | 'CARAVAN' | 'CASTLE' | 'CAVE' | 'CHACARA' | 'CHALET' | 'COTTAGE' | 'COUNTRY_HOUSE' | 'FARM' | 'FARMHOUSE' | 'FINCA' | 'FISHING_HOUSE' | 'GITE' | 'GLAMPING' | 'GUEST_HOUSE' | 'GUEST_ROOM' | 'HOLIDAY_VILLAGE' | 'HOMESTAY' | 'HOSTEL' | 'HOTEL' | 'HOUSE_BOAT' | 'HUT' | 'LIGHTHOUSE' | 'LODGE' | 'LOG_CABIN' | 'LUXURY_TENT' | 'MANOR' | 'MILL' | 'MOBILE_HOME' | 'MOUNTAIN_HUT' | 'PENSION' | 'PENTHOUSE' | 'RESIDENCE' | 'RESORT' | 'RIAD' | 'ROOM' | 'ROOM_BREAKFAST' | 'STUDIO' | 'TENT' | 'TINY_HOME' | 'TIPI' | 'TOWER' | 'TREE_HOUSE' | 'TRULLO' | 'VACATION_APARTMENT' | 'VACATION_HOME' | 'VILLA' | 'YACHT' | 'YURT' required

Type of the apartment

floorinteger

The floor on which the property is located, starting with 0 for the ground floor

sizeOfPlotnumber

Total area includes the whole area of the property accessible to the guest. This includes the garden, terraces or garages

buildYearinteger

Build year of the property

modernizedYearinteger

Year of renovation

licensestring

License number of the property (the license number is required for properties in the Balearic area in Spain)

regulatoryInformationobject

Store regulatory information for the apartment

isTestApartmentboolean

Mark as test apartment

leadTimeHoursinteger

Booking lead time in hours

Example request

{
  "providerApartmentGroupId": "house-123",
  "lat": 50.9293009,
  "lng": 5.9779776,
  "name": "Villa Munich Center",
  "apartmentAddress": {
    "street": "Karlstrasse 66",
    "zipCode": "76133",
    "city": "Munich",
    "countryCode": "DE"
  },
  "contactDetails": {
    "contactName": "John Doe",
    "contactPhone": "+123(4)56789",
    "contactEmail": "john@doe.com"
  },
  "guestCapacityRules": {
    "standardCapacity": 1,
    "maxBabies": 2
  },
  "numberOfBedrooms": 2,
  "numberOfLivingrooms": 1,
  "numberOfBathrooms": 2,
  "sizeInSqm": 100,
  "apartmentType": "VILLA",
  "checkInCheckOutTimes": {
    "checkIn": [
      {
        "checkInFrom": "12:00",
        "checkInTo": "21:00"
      }
    ],
    "checkOutUntil": "14:30"
  },
  "sizeOfPlot": 140.5,
  "buildYear": 2001,
  "modernizedYear": 2007,
  "license": "1231882",
  "duplicateFrom": [
    {
      "provider": "HRS",
      "duplicatedApartmentId": "123654"
    }
  ]
}

Response

Successful creation or update of an apartment

providerApartmentGroupIdstring

ID of the house where apartment is located. If several apartments are located in one house, they'll share the same providerApartmentGroupId

latnumber required

Latitude

lngnumber required

Longitude

namestring

Name of the apartment

numberOfBedroomsinteger
numberOfLivingroomsinteger
numberOfBathroomsinteger
sizeInSqmnumber

Size of apartment in square meters

apartmentType'ALLOTMENT_GARDEN' | 'APARTMENT' | 'APARTMENT_HOTEL' | 'BARN' | 'BEACH_HUT' | 'BED_AND_BREAKFAST' | 'BOAT' | 'BUNGALOW' | 'CAMPER' | 'CAMPING' | 'CARAVAN' | 'CASTLE' | 'CAVE' | 'CHACARA' | 'CHALET' | 'COTTAGE' | 'COUNTRY_HOUSE' | 'FARM' | 'FARMHOUSE' | 'FINCA' | 'FISHING_HOUSE' | 'GITE' | 'GLAMPING' | 'GUEST_HOUSE' | 'GUEST_ROOM' | 'HOLIDAY_VILLAGE' | 'HOMESTAY' | 'HOSTEL' | 'HOTEL' | 'HOUSE_BOAT' | 'HUT' | 'LIGHTHOUSE' | 'LODGE' | 'LOG_CABIN' | 'LUXURY_TENT' | 'MANOR' | 'MILL' | 'MOBILE_HOME' | 'MOUNTAIN_HUT' | 'PENSION' | 'PENTHOUSE' | 'RESIDENCE' | 'RESORT' | 'RIAD' | 'ROOM' | 'ROOM_BREAKFAST' | 'STUDIO' | 'TENT' | 'TINY_HOME' | 'TIPI' | 'TOWER' | 'TREE_HOUSE' | 'TRULLO' | 'VACATION_APARTMENT' | 'VACATION_HOME' | 'VILLA' | 'YACHT' | 'YURT' required

Type of the apartment

floorinteger

The floor on which the property is located, starting with 0 for the ground floor

sizeOfPlotnumber

Total area includes the whole area of the property accessible to the guest. This includes the garden, terraces or garages

buildYearinteger

Build year of the property

modernizedYearinteger

Year of renovation

licensestring

License number of the property (the license number is required for properties in the Balearic area in Spain)

regulatoryInformationobject

Store regulatory information for the apartment

isTestApartmentboolean

Mark as test apartment

leadTimeHoursinteger

Booking lead time in hours

activeboolean

Should apartment be activated

holiduApartmentIdinteger

Holidu Apartment Id

Example response

{
  "providerApartmentGroupId": "house-123",
  "lat": 50.9293009,
  "lng": 5.9779776,
  "name": "Villa Munich Center",
  "apartmentAddress": {
    "street": "Karlstrasse 66",
    "zipCode": "76133",
    "city": "Munich",
    "countryCode": "DE"
  },
  "contactDetails": {
    "contactName": "John Doe",
    "contactPhone": "+123(4)56789",
    "contactEmail": "john@doe.com"
  },
  "guestCapacityRules": {
    "standardCapacity": 1,
    "maxBabies": 2
  },
  "numberOfBedrooms": 2,
  "numberOfLivingrooms": 1,
  "numberOfBathrooms": 2,
  "sizeInSqm": 100,
  "apartmentType": "VILLA",
  "checkInCheckOutTimes": {
    "checkIn": [
      {
        "checkInFrom": "12:00",
        "checkInTo": "21:00"
      }
    ],
    "checkOutUntil": "14:30"
  },
  "sizeOfPlot": 140.5,
  "buildYear": 2001,
  "modernizedYear": 2007,
  "license": "1231882",
  "duplicateFrom": [
    {
      "provider": "HRS",
      "duplicatedApartmentId": "123654"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.