Get a Quote

Get a quote for a given property for a given reservation.

HTTP Request

GET https://dev.calry.app/api/v1/vrs/quote/{propertyId}

HTTP Request

Header	Value
Authorization	Bearer YOUR_ACCESS_TOKEN
workspaceId	YOUR_WORKSPACE_ID
integrationAccountId	YOUR_INTEGRATION_ACCOUNT_ID

Query Parameters

Parameter	Type	Description
startDate	Required string (YYYY-MM-DD)	The start date of the quote.
endDate	Required string (YYYY-MM-DD)	The end date of the quote.
guests	Required int	The number of guests.
roomId	Optional string	The room id of the property.
promotionCode	Optional string	The promotion code to apply to the quote.

• Note that the roomId parameter is optional. Some PMS systems require the room id to get the availability of the property. If the room id is not provided, the API will return the availability of the property without the room id.

Example Request

curl --location 'https://dev.calry.app/api/v1/vrs/quote/212815?startDate=2024-01-22&endDate=2024-01-25&guests=3&promotionCode=SUMMER10' \
--header 'Authorization: Bearer eyJraWQiOiJzLWJhNjY5YzZhLTE0OTktNDQ1MS05MjFhLTExYzQyNDZhZTQ1NSIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjMwMDAvYXV0aCIsInVzZXJJZCI6IjE2NjI0N2U3LTNiYjktNDExYy05ZDBjLTBjMDY3ZTg0ODhmNCIsIndvcmtzcGFjZUlkIjoiZjAzYzNjOTctNDJjZC00MzMwLTk5OWMtZmM5OTA2ZDgzMzY1IiwibmFtZSI6InNhZGFzIiwic291cmNlIjoibWljcm9zZXJ2aWNlIiwiaWF0IjoxNzA1OTI4ODQ5LCJleHAiOjIyOTA4MTMwMDUxfQ.Vft46kRiDKRXA8u7iOB1USkvECs3bI5qmT0kpU2cpogONrg0HFfoUNj658uBRLoyoUr_tq2TrUqf7S1MGqf58I_1zlpKJ0-7wLlKCA5atWGXDPJqaY6xqsJGwqf3z6Yb1QR7o_r3YsLUizSzHc7BT2wFdHaIBydUyNG_kQEogyFWieMTNFFHwU0aUq1LoSyyIL5nWoDeM-pFd0nd659_HOP1ZlvJIGWjVYB94-IrF1q-i4NKokhx6WEaftuIpSKLEsJAskuDWIzvittcq4RszAvaAVHUOKZd907JASGNpzBF812vggr_HmXVAxdVSo5cmzexh-fcgXfe8npXgkiEhg' \
--header 'workspaceId: f03c3c97-42cd-4330-999c-fc9906d83365' \
--header 'integrationAccountId: 526bcda0-7312-449f-8525-66048fd03fb7'

Example Response

{
    "data": {
        "propertyId": "212815",
        "numberOfGuests": 3,
        "arrivalDate": "2024-01-22",
        "departureDate": "2024-01-25",
        "currency": "USD",
        "totalPrice": 581,
        "basePrice": {
            "totalBasePrice": 360,
            "breakdown": [
                {
                    "name": "Base rate",
                    "description": "Base rate",
                    "type": "BASE_PRICE",
                    "units": 1,
                    "total": 300,
                    "isMandatory": false
                },
                {
                    "name": "Price for extra person",
                    "description": "Price for extra person",
                    "type": "PRICE_PER_GUEST",
                    "units": 1,
                    "total": 60,
                    "isMandatory": false
                }
            ]
        },
        "fee": {
            "totalFee": 125,
            "breakdown": [
                {
                    "name": "Cleaning fee",
                    "description": "Cleaning fee",
                    "type": "CLEANING_FEE",
                    "units": 1,
                    "total": 30,
                    "isMandatory": true
                },
                {
                    "name": "Additional Cleaning Fee",
                    "description": "Additional cleaning fee",
                    "type": "ADDITIONAL_CLEANING_FEE",
                    "units": 1,
                    "total": 5,
                    "isMandatory": true
                },
                {
                    "name": "Booking fee",
                    "description": "Booking fee",
                    "type": "BOOKING_FEE",
                    "units": 1,
                    "total": 1,
                    "isMandatory": true
                },
                {
                    "name": "credit",
                    "description": "Credit Card fee",
                    "type": "CREDIT_CARD_FEE",
                    "units": 1,
                    "total": 1,
                    "isMandatory": true
                },
                {
                    "name": "Reservation change fee",
                    "description": "Reservation change fee",
                    "type": "RESERVATION_CHANGE_FEE",
                    "units": 1,
                    "total": 1,
                    "isMandatory": true
                },
                {
                    "name": "Resort fee",
                    "description": "Resort fee",
                    "type": "RESORT_FEE",
                    "units": 1,
                    "total": 1,
                    "isMandatory": true
                },
                {
                    "name": "Service",
                    "description": "Service fee",
                    "type": "SERVICE_FEE",
                    "units": 1,
                    "total": 75,
                    "isMandatory": true
                },
                {
                    "name": "Tourism fee",
                    "description": "Tourism fee",
                    "type": "TOURISM_FEE",
                    "units": 1,
                    "total": 1,
                    "isMandatory": true
                },
                {
                    "name": "Damage deposit",
                    "description": "Damage deposit",
                    "type": "DAMAGE_DEPOSIT",
                    "units": 1,
                    "total": 10,
                    "isMandatory": true
                }
            ]
        },
        "tax": {
            "totalTax": 96,
            "breakdown": [
                {
                    "name": "City / Tourism tax",
                    "description": "City / Tourism tax",
                    "type": "CITY_TOURISM_TAX",
                    "units": 1,
                    "total": 11,
                    "isMandatory": false
                },
                {
                    "name": "Hotel tax",
                    "description": "Hotel tax",
                    "type": "HOTEL_TAX",
                    "units": 1,
                    "total": 11,
                    "isMandatory": false
                },
                {
                    "name": "Lodging tax",
                    "description": "Lodging tax",
                    "type": "LODGING_TAX",
                    "units": 1,
                    "total": 11,
                    "isMandatory": false
                },
                {
                    "name": "Transient occupancy tax",
                    "description": "Transient occupancy tax",
                    "type": "TRANSIENT_OCCUPANCY_TAX",
                    "units": 1,
                    "total": 11,
                    "isMandatory": false
                },
                {
                    "name": "Other taxes",
                    "description": "Other taxes",
                    "type": "OTHER_TAX",
                    "units": 1,
                    "total": 11,
                    "isMandatory": false
                },
                {
                    "name": "Room tax",
                    "description": "Room tax",
                    "type": "ROOM_TAX",
                    "units": 1,
                    "total": 11,
                    "isMandatory": false
                },
                {
                    "name": "Sales tax",
                    "description": "Sales tax",
                    "type": "SALES_TAX",
                    "units": 1,
                    "total": 10,
                    "isMandatory": false
                },
                {
                    "name": "VAT / GST",
                    "description": "VAT / GST",
                    "type": "VAT_GST",
                    "units": 1,
                    "total": 20,
                    "isMandatory": false
                }
            ]
        },
        "discount": {
            "totalDiscount": 0,
            "breakdown": []
        }
    }
}