Skip to main content

CompleteApartmentDto

providerApartmentGroupIdstring

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

Example: house-123
latnumberrequired

Latitude

Example: 50.9293009
lngnumberrequired

Longitude

Example: 5.9779776
namestring

Name of the apartment

Example: Villa Munich Center
apartmentAddress object

Address of the rental property

streetstring

Street

Possible values: <= 128 characters

Example: Karlstrasse 66
zipCodestring

ZIP Code (max 20 chars)

Possible values: <= 20 characters

Example: 76133
citystring

City

Possible values: <= 128 characters

Example: Munich
countryCodestring

Country code represented in standard ISO 3166-1 ALPHA-2 format

Possible values: >= 2 characters and <= 2 characters

Example: DE
contactDetails object

Contact details

contactNamestring

Contact person for this apartment

Example: John Doe
contactPhonestring

Phone number of contact person

Example: +123(4)56789
contactEmailstring

Email of contact person

Example: john@doe.com
guestCapacityRules objectrequired

Guest capacity rules applicable to apartment

standardCapacityinteger<int32>required

The standard capacity of guests allowed. This includes a minimum of 1 adult and excludes babies.

Possible values: >= 1

Example: 1
adultsOnlyboolean

Does apartment permit only adults

Example: false
additionalChildreninteger<int32>

Additional number of children.

Possible values: >= 0

Example: 0
maxBabiesinteger<int32>

Maximum number of babies allowed.

Possible values: >= 0

Example: 2
numberOfBedroomsinteger<int32>

Possible values: >= 1 and <= 30

Example: 2
numberOfLivingroomsinteger<int32>

Possible values: >= 1 and <= 30

Example: 1
numberOfBathroomsinteger<int32>

Possible values: >= 1 and <= 30

Example: 2
sizeInSqmnumber

Size of apartment in square meters

Example: 100
apartmentTypestringrequired

Type of the apartment

Possible values: [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]

Example: VILLA
checkInCheckOutTimes object

Check-ins and check-outs details

checkIn object[]required

List of possible check in times

  • Array [
    • checkInFromstring<time>required

    Check in from (24h format)

    Example: 12:00
    checkInTostring<time>required

    Check in to (24h format)

    Example: 21:00
  • ]
    • checkOutUntilstringrequired

    Check out time (24h format)

    Example: 14:30
    floorinteger<int32>

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

    Example: 0
    sizeOfPlotnumber

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

    Example: 140.5
    buildYearinteger<int32>

    Build year of the property

    Example: 2001
    modernizedYearinteger<int32>

    Year of renovation

    Example: 2007
    licensestring

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

    Example: 1231882
    regulatoryInformation object

    Store regulatory information for the apartment

    <key>string

    Store regulatory information for the apartment

    isTestApartmentboolean

    Mark as test apartment

    onRequestDetails object

    Used only for on request apartments

    bookableOnRequestboolean

    is the apartment bookable on request only (not instant bookable)?

    hostEmailAddressstring

    the email address of the host when guest sends request to the host

    leadTimeHoursinteger<int32>

    Booking lead time in hours

    duplicateFrom object[]

    Use this object if other Holidu partners also have this property in their system. Please contact us before using this.

  • Array [
    • providerstring

    Name of this provider as in our system (please ask us the right name first)

    Example: HRS
    duplicatedApartmentIdstring

    Id of the duplicate apartment in the other partner system.

    Example: 123654
  • ]
    • activeboolean

    Should apartment be activated

    holiduApartmentIdinteger<int64>

    Holidu Apartment Id

    CompleteApartmentDto
    {
      "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,
        "adultsOnly": false,
        "additionalChildren": 0,
        "maxBabies": 2
      },
      "numberOfBedrooms": 2,
      "numberOfLivingrooms": 1,
      "numberOfBathrooms": 2,
      "sizeInSqm": 100,
      "apartmentType": "VILLA",
      "checkInCheckOutTimes": {
        "checkIn": [
          {
            "checkInFrom": "12:00",
            "checkInTo": "21:00"
          }
        ],
        "checkOutUntil": "14:30"
      },
      "floor": 0,
      "sizeOfPlot": 140.5,
      "buildYear": 2001,
      "modernizedYear": 2007,
      "license": "1231882",
      "regulatoryInformation": {},
      "isTestApartment": true,
      "onRequestDetails": {
        "bookableOnRequest": true,
        "hostEmailAddress": "string"
      },
      "leadTimeHours": 0,
      "duplicateFrom": [
        {
          "provider": "HRS",
          "duplicatedApartmentId": "123654"
        }
      ],
      "active": true,
      "holiduApartmentId": 0
    }