Create Reservation

Creates a new reservation for a given property.

HTTP Request

POST https://dev.calry.app/api/v1/vrs/reservations

Headers

Header	Value
Authorization	Bearer YOUR_ACCESS_TOKEN
workspaceId	YOUR_WORKSPACE_ID
integrationAccountId	YOUR_INTEGRATION_ACCOUNT_ID

Request Body

The request body should be a JSON object containing the following fields:

Field	Type	Description
propertyId	string/number
roomId	string/number	Room identifier. (If not provided pass same as propertyId)
arrivalDate	string
departureDate	string
arrivalEstimatedTime	string/number	Optional. Estimated time of arrival.
departureEstimatedTime	string/number	Optional. Estimated time of departure.
guest	object
guest.name	string	Optional. Full name of the guest.
guest.firstName	string	Optional. First name of the guest.
guest.lastName	string	Optional. Last name of the guest.
guest.email	string	Optional. Email address of the guest.
guest.phone	string/number	Optional. Phone number of the guest.
guest.address	object
guest.address.line1	string	Optional. Address line 1 of the guest.
guest.address.line2	string	Optional. Address line 2 of the guest.
guest.address.postalCode	string	Optional. Postal code of the guest's address.
guest.address.city	string	Optional. City of the guest's address.
guest.address.state	string	Optional. State of the guest's address.
guest.address.country	string	Optional. Country of the guest's address.
numberOfGuests	number	Optional. Total number of guests.
numberOfAdults	number	Optional. Number of adults among the guests.
numberOfChildren	number	Optional. Number of children among the guests.
numberOfInfants	number	Optional. Number of infants among the guests.
numberOfPets	number	Optional. Number of pets accompanying the guests.
totalPrice	number	Optional. Total price for the stay.
currency	string	Optional. Currency in which the payment is made.
notes	string	Optional. Additional notes regarding the stay.
comments	string	Optional. Additional comments regarding the stay.
paymentProviderKey	string	Optional. Payment provider key. (Stripe payment token)
paymentProviderId	string	Optional. Payment provider id. (Website payment id)

Note -

• If room identifier is not provided, pass the roomId same as propertyId.
• If you are using Lodgify as a payment provider then paymentProviderId is the website ID for Lodgify,

Example Request

curl --location 'https://dev.calry.app/api/v1/vrs/reservations' \
--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' \
--header 'Content-Type: application/json' \
--data-raw '{
    "propertyId": 212815,
    "roomId": 223121,
    "arrivalDate": "2024-03-10",
    "departureDate": "2024-03-12",
    "arrivalEstimatedTime": "18:00",
    "departureEstimatedTime": "12:00",
    "guest": {
        "name": "Alice Johnson",
        "firstName": "Alice",
        "lastName": "Johnson",
        "email": "alicej@example.com",
        "phone": "9876543210",
        "address": {
            "line1": "456 Oak Lane",
            "line2": "Suite 12",
            "postalCode": "67890",
            "city": "Laketown",
            "state": "Lakestate",
            "country": "Wonderland"
        }
    },
    "status": "confirmed",
    "numberOfGuests": 3,
    "numberOfAdults": 2,
    "numberOfChildren": 1,
    "numberOfInfants": 0,
    "numberOfPets": 1,
    "totalPrice": 950,
    "currency": "USD",
    "notes": "Need a crib for the child.",
    "comments": "Looking forward to a lakeside view.",
    "paymentProviderId": 514166
}'

Example Response

{
    "success": true,
    "data": {
        "id": 9961197,
        "createdAt": "2024-05-31T19:18:36.000Z",
        "updatedAt": "2024-05-31T19:18:37.000Z",
        "cancelledAt": "",
        "arrivalDate": "2024-08-02T00:00:00.000Z",
        "departureDate": "2024-08-03T00:00:00.000Z",
        "nights": 1,
        "propertyId": 573484,
        "numberOfGuests": 2,
        "primaryGuest": {
            "name": "Alonso Doe",
            "emails": [
                "adarsh32017@gmail.com"
            ],
            "mobileNumbers": [
                "123456789"
            ],
            "nationality": null
        },
        "source": "UNKNOWN",
        "totalPrice": 3,
        "currency": "USD",
        "status": "CONFIRMED",
        "arrivalEstimatedTime": "",
        "departureEstimatedTime": "",
        "codes": {
            "accessCode": [
                ""
            ]
        },
        "notes": null,
        "paymentUrl": "https://vivek-raj-3bc786.lodgify.com/pay/?ownerHomepageId=514166&payment=pl__h2P8i2AqTwB9fVUe7jtavNbL03YVc2VuyKNxMeWUnRuX7wh3bCNU3R2A9L92vNg61O-F@oJufBWlmgRwKVN5TEI6Rk1P3gpyEAk3bNGTYewQ3f5HQ2hnd9W4ssQkdlpT",
        "finances": {
            "totalPrice": 3,
            "currency": "USD",
            "totalPaid": 0,
            "remainingBalance": 3,
            "basePrice": {
                "totalBasePrice": 1,
                "breakdown": [
                    {
                        "name": "SEA_URCHIN_·_WEST_COAST_CEDAR_LOFT_&_BEAM_SUITE!",
                        "type": "RoomRate",
                        "total": 1
                    }
                ]
            },
            "fee": {
                "totalFee": 1,
                "breakdown": [
                    {
                        "name": "CLEANING_FEE",
                        "type": "Fee",
                        "total": 1
                    }
                ]
            },
            "tax": {
                "totalTax": 1,
                "breakdown": [
                    {
                        "name": "HOTEL_TAX",
                        "type": "Tax",
                        "total": 1
                    }
                ]
            },
            "discount": {
                "totalDiscount": 0,
                "breakdown": []
            }
        }
    }
}