Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Reservations Open Api [Beta]

Create a confirmed owner reservation

Create a confirmed owner reservation - This endpoint enables the creation of an Owner Reservation instantly with minimal required input. It is designed for simplicity and speed, focusing on essential details only. Behind the scenes, it will create a quote + reservation from a quote picking the first applicable rate plan and promotions

post/reservations-v3/owner/confirmed

Request body

checkInDateLocalizedstring required

The date when the Owner will check in - with the format of YYYY-MM-DD

checkOutDateLocalizedstring required

The date when the Owner will check out - with the format of YYYY-MM-DD

listingIdstring required

Listing Id of the unit that the Owner will be staying in

guestIdstring

Guest id of the guest that will be staying in

source'owner' | 'owner-guest' required

Source of reservation. "owner" for owner reservations, "owner-guest" for owner friends & family reservations

guestsCountnumber

Count of guests

bookingDatestring date-time

Real-world booking/creation date. Defaults to createdAt when omitted.

Example request

{
  "checkInDateLocalized": "2021-01-01",
  "checkOutDateLocalized": "2021-01-02",
  "listingId": "5f92cbf10cf217478ba93561",
  "guestId": "5f92cbf10cf217478ba93532",
  "guest": {
    "firstName": "Joe",
    "lastName": "Black",
    "phones": [
      "+972-525180054",
      "+972-225146062"
    ],
    "email": "guest@email.com",
    "address": {
      "street": "1000 5th Ave",
      "zipCode": "10028",
      "city": "New York",
      "state": "New York",
      "country": "United States",
      "countryCode": "US"
    }
  },
  "numberOfGuests": {
    "numberOfAdults": 2,
    "numberOfChildren": 0,
    "numberOfInfants": 0
  },
  "source": "owner",
  "guestsCount": 2,
  "notes": {
    "other": "Other notes",
    "cleaning": "Cleaning notes",
    "guest": "Guest notes",
    "specialRequests": "Special request",
    "keyCode": "123456"
  },
  "creationInfo": {
    "owner": {
      "_id": "5f92cbf10cf217478ba93532"
    }
  },
  "bookingDate": "2024-07-06T09:12:06.574Z"
}

Response

Reservation created

reservationIdstring required
quoteIdstring required
confirmationCodestring required
statusstring required
guestIdstring required
creationTimestring date-time required
bookingDatestring date-time required
reservedExpiresAtstring date-time required
checkInDatestring date-time required
checkOutDatestring date-time required
unitTypeIdstring required
unitIdstring required
sourcestring required
channelstring required
guestsCountnumber required
creationInfoobject required

Example response

{
  "numberOfGuests": {
    "numberOfChildren": 1,
    "numberOfInfants": 1,
    "numberOfPets": 1,
    "numberOfAdults": 1
  }
}