First things first - the core apartment

📘
Apartment basics

To create an apartment, make an API request to this endpoint as a first step.

Here you will be able to add the general core data of each property.

To update an apartment you need to PUSH the entire apartments object, updates for single fields are not possible.

The core apartment holds all information related to the property itself. Here you will be able to configure the basic details of a property as well as the capacity rules, location and contact details of the host for communication purposes e.g. when the traveller books a property.

Parameter	Type	Required	Usage
`providerApartmentGroupId`	string		You will use this parameter ONLY if the apartment belongs to a <glossary:multi-unit>. If several apartments are located in one house, they'll share the same providerApartmentGroupId.
`lat`	number	YES	Latitude: is used to show your property on the map. Additionally, we also use it to determine the distances to the diff. <glossary:POI>.
`lng`	number	YES	Longitud: it is important to notice that the distances to the diff POI are aerial, hence these may vary in contrast with road distances.
`name`	string		This value will be used for communication purposes with the partner. e.g. in the booking notification email after a successful booking -This will NOT be the title of the property displayed on the Holidu website, that one will be taken from the `descriptions` endpoint.
`apartmentAddress`	object		This will only be used in the communication to the guest from Holidu. This way we can share the address of the property.
`apartmentAddress.street`	string
`apartmentAddress.zipCode`	string
`apartmentAddress.city`	string
`apartmentAddress.countryCode`	string
`contactDetails`	object
`contactDetails.contactName`	string		Host / agency data: Meaning the person / group / entity that is the point of contact for checkin details and that handle anything related to helping when the travel happens.
`contactDetails.contactPhone`	string		Phone number of the above
`contactDetails.contactEmail`	string		E-Mail of the above
`guestCapacityRules`	object	YES	To define the maximum capacity of people allowed in a property, as well as children and babies.
`guestCapacityRules.standardCapacity`	int32	YES	The max adult capacity of the property.
`guestCapacityRules.adultsOnly`	boolean		This should be set as `true` in chase children and babies are not allowed.
`guestCapacityRules.additionalChildren`	int32		This is the number of additional children that can be added on top of `standardCapacity` of the property.
`guestCapacityRules.maxBabies`	int32		This is the max number of babies allowed on the property.
`numberOfBedrooms`	int32	YES	This is the number of bedrooms on the property.
`numberOfLivingrooms`	int32		This is the number of living rooms on the property.
`numberOfBathrooms`	int32		This is the number of bathrooms on the property.
`sizeInSqm`	number	YES	This value will be displayed on the Holidu website.
`apartmentType`	string	YES	This determines if the property is e.g. APARTMENT, LODGE, etc. You can check the complete list at the end of this page.
`checkInCheckOutTimes`	object		These are the times when the guest can check in and out.
`checkInCheckOutTimes.checkIn`	array of objects	YES*	It is possible to define multiple check in windows, e.g. from 12:00 to 14:00 and from 16:00 to18:00
`checkInCheckOutTimes.checkIn.checkInFrom`	string	YES*
`checkInCheckOutTimes.checkIn.checkInTo`	string	YES*
`checkInCheckOutTimes.checkOutUntil`	string	YES*	It is ONLY possible to have one checkout until time.
`floor`	int32		This is the floor on which the property is located, starting with 0 for the ground floor.
`sizeOfPlot`	number		This is the entire area of the property accessible to the guest. This includes the garden, terraces or garages, etc.
`buildYear`	int32		Build year of the property
`modernizedYear`	int32		Year of renovation, in case there was one.
`license`	string	It depends	In certain regions, the property requires a licence number to be shown, e.g. all the Balearic Islands in Spain. More info.
`regulatoryInformation`	object	It depends	Store mandatory regulatory information for the apartment in specific regions. As an example, all rental properties in Italy must display a CIN number (Codice Identificativo Nazionale) on booking platforms.
`regulatoryInformation.CIN_LICENSE_NUMBER`	string	It depends	CIN number (Codice Identificativo Nazionale) is REQUIRED for properties in Italy.
`regulatoryInformation.NRA_LICENSE_NUMBER`	string	It depends	NRA number (Número de Registro de Alquiler) is REQUIRED for properties in Spain.
`isTestApartment`	boolean	YES	If set to `true`, this boolean will prevent the property to be visible from all live domains. At the same time, it will enable you to perform end-to-end testing to verify that the data is being sent correctly!
`leadTimeHours`	int32		Booking lead time in hours - This field defines the minimum amount of hours before check-in a booking can be generated

❗️
Be aware

Be aware to only use the fields guestCapacityRules.adultsOnly and/or guestCapacityRules.additionalChildren under the following conditions:

when children and/or babies are NOT considered an adult in terms of price

when** guest categories on partner level** are set to distinguish children and/or babies from adults in terms of age ranges and price

In doubt always make sure to consult with your Technical Account Manager before using the above fields

guestCapacityRules.maxBabies is currently taken into account, If not defined as "unlimited" on partner level.

If not discussed otherwise with your Technical Account Manager at Holidu, please never push the onRequestDetails object. The field bookableOnRequest and hostEmailAddress should only be used after close consultation with us.

The default use case is that properties pushed to use will be directly instant bookable.

APARTMENTS JSON object

Scroll down inside the table to see the entire object:

{
    "providerApartmentGroupId": "123456",
    "lat": 35.36498,
    "lng": 24.49886,
    "name": "Modern cosy apt, walking distance to the beach!",
    "apartmentAddress": {
        "street": "Test Street",
        "zipCode": "741 00",
        "city": "Citytest",
        "countryCode": "ES"
    },
    "contactDetails": {
        "contactName": "Jane Doe",
        "contactPhone": "948927780",
        "contactEmail": "[email protected]"
    },
    "guestCapacityRules": {
        "standardCapacity": 8,
        "adultsOnly": false,
        "additionalChildren": 4,
        "maxBabies": 3
    },
    "numberOfBedrooms": 2,
    "numberOfLivingrooms": 1,
    "numberOfBathrooms": 1,
    "sizeInSqm": 74,
    "apartmentType": "APARTMENT",
    "checkInCheckOutTimes": {
        "checkIn": [
            {
                "checkInFrom": "09:00",
                "checkInTo": "20:00"
            }
        ],
        "checkOutUntil": "11:00"
    },
    "floor": 3,
    "sizeOfPlot": 100,
    "buildYear": 1998,
    "modernizedYear": 2020,
    "license": "96541227-8",
    "regulatoryInformation": {
        "CIN_LICENSE_NUMBER": "XXX-123-XYZ"
    },
    "isTestApartment": false
}

Table of apartment types with explanation

Apartment type	Description
APARTMENT
VACATION_APARTMENT	Parent property type for all apartments that can be rented.
FISHING_HOUSE	House that is close to a fishing area and/or with fishing equipment.
BED_AND_BREAKFAST	Sleeping accommodation for a night and a meal in the morning, provided in guest houses and hotels.
HOLIDAY_VILLAGE1
HOLIDAY_VILLAGE2
HOLIDAY_VILLAGE3
APARTMENT_HOTEL	Hotel where you can rent an independent apartment.
FARMHOUSE	Building that serves as the primary residence in a rural or agricultural setting.
COTTAGE	Typically a small house, usually modest, often cosy dwelling, typically in a rural or semi-rural location.
CAMPING	Every property that can be rented at a camping facility.
CHALET	Apartment/house in a ski area. It is not a Villa!
VACATION_HOME	Parent property type for all independent houses that can be rented.
GUEST_ROOM	Room for rent. Could be in a hotel or in a family house.
HOSTEL	Inexpensive hotel usually for younger people, it also offers stays in non-private rooms (usually with facilities such as a kitchen and laundromat).
HOTEL
BOAT	A boat, floating house, yacht...
MANOR	Luxurious country house.
MOBILE_HOME	House that does not have a definite structure, could potentially be moved (even though in most cases it doesn’t).
LODGE	A more remote accommodation for mountain sports and nature experiences. In other countries "Lodge" is originally a term for a relatively small building, often associated with a larger one.
HOUSE_BOAT	Floating house.
PENTHOUSE	Luxurious apartment, usually on a top floor or with a terrace. It is NOT a house.
CASTLE	A castle.
STUDIO	Smaller apartment, usually for 1 or 2 persons, with open spaces and same area for sleeping & living.
VILLA	Luxurious country house, although not necessarily in a rural area. It is a standalone complex with its own land and building.
RESIDENCE
ROOM	Hotel room, or room in a guest house / shared apartment.
BARN	Agricultural building, usually on farms, and used for various purposes. In some countries, a barn refers to structures that house livestock, including cattle and horses, as well as equipment and fodder.
CAVE	House excavated in stone. Or a house with a cave (some rooms are part of a cave).
ALLOTMENT_GARDEN	An allotment garden (British English), often called simply an allotment, or a community garden (North America), is a plot of land made available for individual, non-commercial gardening or growing food plants.
ROOM_BREAKFAST	Room with breakfast included.
BUNGALOW	A house, normally detached, that may contain a small loft.
YACHT	Glamorous houseboat (usually a boat that can reach higher speeds).
CAMPER
CARAVAN
LUXURY_TENT	Luxurious camping tent. Also luxurious tent in a remote location (like dessert, savannah, etc.).
TENT
TIPI
YURT	A traditional yurt (from the Turkic languages) or ger (Mongolian) is a portable, round tent covered with skins or felt.
GUEST_HOUSE	A private house offering accommodation to paying guests; a boarding house; a bed and breakfast.
PENSION	Small hotel or guest house accommodation. (usually with front desk & service hours hotel-like).
BEACH_HUT	A hut, a small house in a beach area / by the beach.
CHACARA	Small rural property (or a large urban property) with a dwelling house, animal husbandry and fruit and vegetable growing for sale
COUNTRY_HOUSE	A house in the country. An English country house is a large house or mansion in the English countryside.
FARM	An area of land that is devoted primarily to agricultural processes with the primary objective of producing food and other crops.
FINCA	Holiday home in a rural setting. With rural or agricultural land.
GITE	A gîte is a holiday home available for rent. Gîtes are usually fully furnished and equipped for self-catering.
HUT	Small house typically built with local materials.
LIGHTHOUSE	A tower, building, or another type of structure designed to emit light from a system of lamps and lenses and to serve as a navigational aid for maritime pilots at sea or on inland waterways.
LOG_CABIN	Small log house, especially a less finished or architecturally sophisticated structure.
MILL	House that used to be a mill or has a mill (not necessarily a windmill, it could also be for flour, or powered by water).
MOUNTAIN_HUT	A house, hut or smaller house in the mountains, although not necessarily in a ski area.
RIAD	Traditional Moroccan house with courtyard.
TOWER	House that is a tower or has a tower.
TREE_HOUSE	A house in a tree.
TRULLO	Traditional Apulian dry stone hut with a conical roof. Their style of construction is specific to the Itria Valley, in the Murge area of the Italian region of Apulia.
RESORT	Also a holiday village in a remote/glamorous location.
GLAMPING	Glamorous camping.
HOMESTAY	Rooms in a shared accommodation with the house owner

Array of apartment types

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

Places that require License

France (some areas)
Italy
- Apulia
- Lazio
- Sardinia
Portugal (in total)
Spain
- Catalonia
- Balearic Islands
- Comunidad Valenciana
- Andalusia
- Madrid
- Cantabria
- Extremadura