{"__v":1,"_id":"56e7584d911296190096dd80","category":{"__v":19,"_id":"56e3719b591f620e00bf5099","pages":["56e3719c591f620e00bf509b","56e74226555c030e00a52a90","56e7447c7d693632001d5cb4","56e752bd56d59a0e00d5660e","56e755b98aa2c00e00494cd9","56e7584d911296190096dd80","56e759339b25270e001d11a0","56e7593e1b41040e009d10cf","56e7594e911296190096dd88","56e7595e8aa2c00e00494ce3","56e75d7f5669091700c5b2b4","56e77e22911296190096de13","56e77f259b25270e001d1232","56e7b2c737afb90e00e0eb9d","56ec4daf611730190000f23f","56ec4fde26db830e00afa083","56ec8f7204e8940e00966567","56f184cc9791b22d0077b9d9","56f18a2c3af4942b00bb3c47"],"project":"56e3719a591f620e00bf5095","version":"56e3719a591f620e00bf5098","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-12T01:32:11.359Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"56e3719a591f620e00bf5095","user":"56e371538b32a10e00f79750","version":{"__v":2,"_id":"56e3719a591f620e00bf5098","hasDoc":true,"hasReference":true,"project":"56e3719a591f620e00bf5095","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z","categories":["56e3719b591f620e00bf5099","56e7b24ad365390e007baeab"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-15T00:33:17.069Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n  \"amount\": 1560,\n  \"currency\": \"USD\",\n  \"extraGuestsFeeAmount\": 0,\n  \"cleaningFeeAmount\": 200,\n  \"totalWithTaxes\": 1991.25,\n  \"totalWithoutTaxes\": 1770,\n  \"totalWithTaxesAndSecDeposit\": 2241.25,\n  \"securityDepositAmount\": 250,\n  \"taxationRate\": 12.5,\n  \"customFees\": [\n    {\n      \"amount\": 10,\n      \"name\": \"Cleaning\"\n    }\n  ],\n  \"property\": {\n\t\t\"extraGuestFee\": 100,\n    \"baseGuests\": 2\n\t}  \n}","language":"json","status":200},{"name":"","code":"Orbirental API - Bad request.","language":"text","status":400},{"code":"Orbirental API - Property not found.","language":"text","status":409}]},"settings":"","auth":"required","params":[{"_id":"56e7584d911296190096dd84","ref":"","in":"query","required":true,"desc":"The check-in date with format YYYY-MM-DD","default":"","type":"yyyy-mm-dd","name":"checkInDate"},{"_id":"56e7584d911296190096dd83","ref":"","in":"query","required":true,"desc":"The check-out date with format YYYY-MM-DD","default":"","type":"yyyy-mm-dd","name":"checkOutDate"},{"_id":"56e7584d911296190096dd82","ref":"","in":"query","required":true,"desc":"The unique id of this property","default":"","type":"string","name":"propertyUid"},{"_id":"56e7584d911296190096dd81","ref":"","in":"query","required":false,"desc":"The number of guests","default":"1","type":"int","name":"guestCount"}],"url":"/quote"},"isReference":false,"order":30,"body":"This API essentially provides quote information in relation to a booking inquiry. Note that if the referenced property is not available for the provided dates, the API returns a 409 Error Code (property not available for those dates).\n\nQuotes will typically include all the monetary components associated with booking a property. Those include cleaning, taxes, mandatory and optional fees defined for the specific property. The quote will also take into account the size of the party and calculate extra guest fees based on the settings provided via the Orbirental property management system.","excerpt":"Provides quote/availability information for a booking inquiry","slug":"quote","type":"get","title":"/quote"}

get/quote

Provides quote/availability information for a booking inquiry

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

checkInDate:
required
yyyy-mm-dd
The check-in date with format YYYY-MM-DD
checkOutDate:
required
yyyy-mm-dd
The check-out date with format YYYY-MM-DD
propertyUid:
required
string
The unique id of this property
guestCount:
integer1
The number of guests

Result Format


Documentation

This API essentially provides quote information in relation to a booking inquiry. Note that if the referenced property is not available for the provided dates, the API returns a 409 Error Code (property not available for those dates). Quotes will typically include all the monetary components associated with booking a property. Those include cleaning, taxes, mandatory and optional fees defined for the specific property. The quote will also take into account the size of the party and calculate extra guest fees based on the settings provided via the Orbirental property management system.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}