Sign in

v1

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

Retrieve a Quote by ID

This endpoint allows retrieval of a specific quote using its unique ID. It is used to fetch details of a previously created quote. If the quote has expired, the endpoint returns an error message indicating that the quote is expired and suggests creating a new quote.

get/quotes/{quoteId}

Path parameters

quoteIdstring required
Example:df7hf01cnduhdb2125854dj8

The unique identifier of the quote being retrieved

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

Response

Successful retrieval of the quote

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