Quote

This operation allows you to confirm the price of a property and room type combination before booking. You can request quotes for single rooms as well as multi-room bookings.


For detailed information about the type definitions, see the DOCS tab on the Reservation GraphQL Docs.

Values for htIdentifier can be retrieved by using the Search operation.
All fields in the Quote request are mandatory fields. If any of the fields are missing, an error along with an error code will be returned in the response. For more information on the list of error codes, see the Error Codes page.

Schema

query quote($Quote: [QuoteRequestInput]) {
  quote(quoteRequest: $Quote) {
    aggregateGrossPrice
    aggregateNetPrice
    aggregateTax
    aggregatePayAtProperty
    consolidatedComments
    rooms {
      htIdentifier
      grossPriceChanged
      message
      cancellationPolicies {
        startWindowTime
        endWindowTime
        currency
        cancellationCharge
        timeZone
        timeZoneUTC
      }
      mealplanOptions {
        mealplanDescription
        mealplanCode
        mealplanName
        }
      rates {
        bar
        binding
        commissionable
        commissionAmount
        currency
        netPrice
        tax
        grossPrice
        payAtProperty
        dailyPrice
        dailyTax
        aggregateTaxInfo {
          payAtBooking {
            description
            name
            value
            currency
          }
          payAtProperty {
            description
            name
            value
            currency
          }
        }
      }
    }
  }
}

Sample Requests

Single Room Request

{
    "Quote": [
        {
            "htIdentifier": "6131514161|1312101315121|1419131812141|121012131-112-11101|121012131-112-112|1816101c121e16131-1e1816131-141d1f131-191a16191-131416191715191d1b13201|1116192315111814131113191|1O1D1C22131|1K111",
            "occupancy": {
                "guestAges": "30,5"
            },
            "rates": {
                "netPrice": 300.17,
                "tax": 30.01,
                "grossPrice": 330.18,
                "payAtProperty": 50,
                "dailyPrice": [
                    300.17
                ],
                "dailyTax": [
                    30.01
                ]
            }
        }
    ]
}

Multi-room Request

{
  "Quote": [
    {
      "htIdentifier": "11019171|1117101511101|111416142|121012141-10111-10111|121012141-10111-10121|121f1718161917101-1c151f161-1416151d1-18151f2-1f1a2d1f191e10181b19171|111618161516171017161118141",
      "occupancy": {
        "guestAges": "30,5"
      },
      "rates": {
        "netPrice": 242.42,
        "tax": 14.64,
        "grossPrice": 257.06,
        "payAtProperty": 30,
        "dailyPrice": [
          242.42
        ],
        "dailyTax": [
          14.64
        ]
      }
    },
    {
      "htIdentifier": "11019171|1117101511101|111416142|121012141-10111-11151|121012141-10111-11181|131b1e171a15191d1-131b1a2-14111c121-1a10171e1-162e191b111b1c14151e121|11161816151623192116191",
      "occupancy": {
        "guestAges": "30,5"
      },
      "rates": {
        "netPrice": 690,
        "tax": 41.49,
        "grossPrice": 731.49,
        "payAtProperty": 90,
        "dailyPrice": [
          230,
          230,
          230
        ],
        "dailyTax": [
          13.83,
          13.83,
          13.83
        ]
      }
    }
  ]
}

Sample Response

Single Room Success Response

{

    "quote": {
        "aggregateGrossPrice": 330.18,
        "aggregateNetPrice": 300.17,
        "aggregateTax": 30.01,
        "aggregatePayAtProperty": 50,
        "consolidatedComments": "Free Breakfast. A Resort Fee totaling EUR50.00 will be charged for the stay. Mandatory Charge. Plus applicable taxes.. Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest.. Minimum adult age at check in is 21 years.",
        "rooms": [
            {
                "htIdentifier": "6131514161|1312101315121|1419131812141|121012131-112-11101|121012131-112-112|1816101c121e16131-1e1816131-141d1f131-191a16191-131416191715191d1b13201|1116192315111814131113191|1O1D1C22131|1K111",
                "grossPriceChanged": false,
                "message": "Confirm Price Success. Please proceed to Book stage.",
                "cancellationPolicies": [
                    {
                        "startWindowTime": "2023-11-09 23:59:00",
                        "endWindowTime": "2023-11-10 16:00:00",
                        "currency": "EUR",
                        "cancellationCharge": 330.18,
                        "timeZone": "Europe/Istanbul",
                        "timeZoneUTC": "+03:00"
                    }
                ],
                "mealplanOptions" : {
                    "mealplanDescription": "Free Breakfast",
                    "mealplanCode": "BBF",
                    "mealplanName": "Free Breakfast"
                },
                "rates": {
                    "bar": null,
                    "binding": null,
                    "commissionable": false,
                    "commissionAmount": null,
                    "currency": "EUR",
                    "netPrice": 300.17,
                    "tax": 30.01,
                    "grossPrice": 330.18,
                    "payAtProperty": 50,
                    "dailyPrice": [
                        300.17
                    ],
                    "dailyTax": [
                        30.01
                    ],
                    "aggregateTaxInfo": {
                        "payAtBooking": [
                            {
                                "description": null,
                                "name": "percent",
                                "currency": "EUR",
                                "value": 30.01
                            }
                        ],
                        "payAtProperty": [
                            {
                                "description": "Mandatory Charge. Plus applicable taxes.",
                                "name": "Mandatory Charge",
                                "currency": "EUR",
                                "value": 50
                            }
                        ]
                    }
                }
            }
        ]
    }
}

Multi-Room Success Response

{
  "data": {
    "quote": {
      "aggregateGrossPrice": 988.55,
      "aggregateNetPrice": 932.42,
      "aggregateTax": 56.13,
      "aggregatePayAtProperty": 120,
      "consolidatedComments": " Room#1: Free Breakfast.  Room#2: Free Breakfast.  Room#1: A Resort Fee totaling $30.00 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city..  Room#2: A Resort Fee totaling $90.00 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.. Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest.. Minimum adult age at check in is 21 years.",
      "rooms": [
        {
          "htIdentifier": "11019171|1117101511101|111416142|121012141-10111-10111|121012141-10111-10121|121f1718161917101-1c151f161-1416151d1-18151f2-1f1a2d1f191e10181b19171|111618161516171017161118141",
          "grossPriceChanged": false,
          "message": "Confirm Price Success. Please proceed to Book stage.",
          "cancellationPolicies": [
            {
              "startWindowTime": "2023-12-31 16:00:00",
              "endWindowTime": "2025-01-01 16:00:00",
              "currency": "USD",
              "cancellationCharge": 257.06,
              "timeZone": "America/New_York",
              "timeZoneUTC": "-05:00"
            }
          ],
          "mealplanOptions" : {
              "mealplanDescription": "Free Breakfast",
              "mealplanCode": "BBF",
              "mealplanName": "Free Breakfast"
          },
          "rates": {
            "bar": null,
            "binding": null,
            "currency": "USD",
            "commissionable": true,
            "commissionAmount": 30.85,
            "netPrice": 242.42,
            "tax": 14.64,
            "grossPrice": 257.06,
            "payAtProperty": 30,
            "dailyPrice": [
              242.42
            ],
            "dailyTax": [
              14.64
            ],
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 0.1
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 14.54
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 30
                }
              ]
            }
          }
        },
        {
          "htIdentifier": "11019171|1117101511101|111416142|121012141-10111-11151|121012141-10111-11181|131b1e171a15191d1-131b1a2-14111c121-1a10171e1-162e191b111b1c14151e121|11161816151623192116191",
          "grossPriceChanged": false,
          "message": "Confirm Price Success. Please proceed to Book stage.",
          "cancellationPolicies": [
            {
              "startWindowTime": "2025-01-14 16:00:00",
              "endWindowTime": "2025-01-15 16:00:00",
              "currency": "USD",
              "cancellationCharge": 731.49,
              "timeZone": "America/New_York",
              "timeZoneUTC": "-05:00"
            }
          ],
          "mealplanOptions" : {
              "mealplanDescription": "Free Breakfast",
              "mealplanCode": "BBF",
              "mealplanName": "Free Breakfast"
          },
          "rates": {
            "bar": null,
            "binding": null,
            "currency": "USD",
            "commissionable": true,
            "commissionAmount": 87.78,
            "netPrice": 690,
            "tax": 41.49,
            "grossPrice": 731.49,
            "payAtProperty": 90,
            "dailyPrice": [
              230,
              230,
              230
            ],
            "dailyTax": [
              13.83,
              13.83,
              13.83
            ],
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 0.09
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 41.4
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 90
                }
              ]
            }
          }
        }
      ]
    }
  }
}

Sample Error Response

{
  "errors": [
    {
      "message": "Invalid htIdentifier, already used for a different request, invalid htIdentifier = 2172|1117101417181|151813111|121012111-11121-10111|121012111-11121-10121|1a131c16101b15121-181f291-141b17111-181c16181-171915131b18101e151e151f1|11162810181723111812161",
      "extensions": {
        "errorCode": 1045
      }
    }
  ],
  "data": {
    "quote": null
  }
}