Sign in

v1

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

Create a reservation from quote

Create a reservation based on an existing quote with all the necessary reservation data. You can create a quote using the dedicated endpoint or the booking engine API.

post/reservations-v3/quote

Request body

quoteIdstring required

The quote to convert into a reservation

status'confirmed' | 'reserved' | 'awaiting_payment' | 'inquiry' | 'canceled' | 'closed' | 'declined' | 'expired' required

Choose from: "inquiry", "reserved", or "confirmed"

ratePlanIdstring

The ID of an active rate plan when you wish to apply it to the reservation

reservedUntil-1 | 0.5 | 0.25 | 0.17 | 12 | 24 | 36 | 48 | 72

It can be -1 (no limit), 0.17 (10 minutes), 0.25 (15 minutes), 0.5 (30 minutes), or 24/48/72 hours when the reservation is a booking request that reserves dates (i.e., status = “reserved”)

guestIdstring

The primary ID for returning/existing guests and new guests that were created beforehand

ignoreCalendarboolean

The system will check calendar availability and decline (401) if unavailable unless this flag is set to true

ignoreTermsboolean

The system will ensure the reservation accords with the terms (min, max nights, any other terms) of the property and will decline(401) if it is. To override, set this flag to true

ignoreBlocksboolean

Set this flag to true to ignore existing flexible blocks (advance notice, preparation time, etc)

confirmedAtstring date-time

Define the confirmation date. If null and status is confirmed, use the current date (YYYY-MM-DDTHh.mm.ssZ). If null and status is not confirmed, leave it as null

confirmationCodestring

Define the confirmation code

originstring

The origin of the reservation

originIdstring

The origin id of the reservation

Example request

{
  "quoteId": "6213b03e7f0ba50032296f4a",
  "status": "confirmed",
  "ratePlanId": "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"
    }
  },
  "origin": "YourPorter",
  "originId": "external-id-example"
}

Response

Success

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
  }
}