Sign in

v1

latestOpenAPI 3.0.02026-07-26190104.7 KB
Reservation quote

Create inquiry for reservation based on quote

Create a request for a reservation to be confirmed by the Guesty user based on a quote. Pre-SCA Stripe tokens (starting with tok_...) are NOT SUPPORTED. The API supports only Stripe SCA tokens (starting with pm_...).

❗ Important

Before using the Booking Engine (BE) API reservation endpoints, ensure your Guesty account is properly activated by following these steps:

  1. Activate Manual Source (skip this step if you already have direct reservations in Guesty account):
    • Create a manual reservation directly in the Guesty UI. This step is required to activate the "Manual" booking source in your account.
  2. Activate BE API Source:
    • Create your first reservation using the Booking Engine API endpoints.
    • This step is essential to initialize the BE API source, which allows you to set up additional fees, taxes, auto payments and automated messages.
post/api/reservations/quotes/{quoteId}/inquiry

Path parameters

quoteIdstring required
Example:5d6e7a7ebf8e3800207735ae

ID of quote

Request body

ratePlanIdstring required

Rate plan ID. Ensure you supply one of the rate plan IDs returned in the quote payload. Attempts to use any other string will result in an error.

reservedUntil-1 | 12 | 24 | 36 | 48 | 72

Time in hours to reserve the reservation for. Valid values: -1, 12, 24, 36, 48, 72

ccTokenstring

payment token id, see tokenization guide https://booking-api-docs.guesty.com/docs/tokenizing-payment-methods

Example request

{
  "ratePlanId": "5bf544a600a9b000389f81d8",
  "reservedUntil": 12,
  "ccToken": "pm_1KTRn22eZvKYlo2CkHIARaGo",
  "guest": {
    "firstName": "Jhon",
    "lastName": "Dou",
    "email": "jhon.dou@guesty.com",
    "phone": "380111111111",
    "address": {
      "street": "1000 5th Ave",
      "city": "New York",
      "country": "United State",
      "countryCode": "US",
      "zipCode": "10028",
      "state": "New York"
    }
  },
  "policy": {
    "privacy": {
      "version": 1
    }
  }
}

Response

successful operation

_idstring required

ID of reservation

status'reserved' required
platform'direct' required
createdAtstring required
guestIdstring required

Example response

{
  "_id": "5d6e7a7ebf8e3800207735ae",
  "createdAt": "11/7/2021, 3:57:29 PM",
  "guestId": "5e384c9fc2700d002670b61b"
}