Sign in

v1

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

Create a Quote

This endpoint allows the creation of a price quote for a reservation. It requires details such as the listing ID, check-in and check-out dates, and guest count. The response includes detailed information about the quote, including rates, promotions, and applicable fees.

post/quotes

Query parameters

mergeAccommodationFarePriceComponentsboolean

If set to true, Markups, ExtraPersonFee, and Discounts are hidden from both the nightly rates and invoice items—they are included within the Accommodation Fee (AF). If set to false, these components are itemized separately in the response.

includePaymentsTemplateboolean

Include payments template information in the response

Request body

checkInDateLocalizedstring required

Localized to listing timezone reservation check-in date (YYYY-MM-DD)

checkOutDateLocalizedstring required

Localized to listing timezone reservation checkout date (YYYY-MM-DD)

listingIdstring required

Guesty listing ID

sourcestring required

Define the source for getting an updated price quote

guestsCountnumber required

Number of guests to be included in the quote

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)

couponCodestring

Coupon code to be applied to the quote

Example request

{
  "checkInDateLocalized": "2024-01-04",
  "checkOutDateLocalized": "2024-01-05",
  "listingId": "6213b03e7f0ba50032296f4a",
  "source": "manual",
  "guestsCount": 2,
  "couponCode": "OOM20-DISCOUNT"
}

Response

Success

_idstring required
accountIdstring required
reservationIdstring
status'valid' required
guestsCountnumber required
channel'manual_reservations' | 'owner_reservations' | 'booking_engine' required
sourcestring required
createdAtstring date-time required
expiresAtstring date-time required
unitTypeIdstring required
unitIdstring
unassignboolean
checkInDateLocalizedstring required
checkOutDateLocalizedstring required
ratesobject required
bookerIdstring
couponsobject[] required
promotionsobject required
pointOfSalestring

Example response

{
  "_id": "df7hf01cnduhdb2125854dj8",
  "guestsCount": 1,
  "source": "source-fb-for-bi",
  "stay": [
    {
      "checkInDateLocalized": "2021-12-20",
      "checkOutDateLocalized": "2021-12-22",
      "guestsCount": 3,
      "numberOfGuests": {
        "numberOfAdults": 3,
        "numberOfChildren": 0,
        "numberOfInfants": 0
      },
      "unitTypeId": "5e384c9fc2700d002670b61b",
      "unitId": "5e384c9fc2700d002670b61b",
      "ratePlanId": "5e384c9fc2700d002670b61b"
    }
  ],
  "numberOfGuests": {
    "numberOfChildren": 1,
    "numberOfInfants": 1,
    "numberOfPets": 1,
    "numberOfAdults": 1
  }
}