Create a quote
POST/property/{connection_id}/quote
Creates a PropertyQuote. Provide the unified PropertyQuote fields in the request body; they are mapped to the provider's API. Returns the created PropertyQuote.
Parameters
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
Payload
idstring
unique identifier for the quote
created_atdate-time
when the quote was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
listing_idstring
pointer to the Property Listing to price
unittype_idstring
pointer to the Property Unittype (room type) to price
start_atdate-time
the arrival (check-in) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atdate-time
the departure (check-out) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
guestsnumber
total number of guests
adultsnumber
number of adults
childrennumber
number of children
promotion_codestring
promotion or coupon code to apply
currencystring
ISO 4217 currency code
total_amountnumber
the total price of the stay
deposit_amountnumber
the deposit due at booking
Returns
| Response field | Type | Required | Description |
|---|---|---|---|
id | string | No | unique identifier for the quote |
created_at | string (date-time) | No | when the quote was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
listing_id | string | No | pointer to the Property Listing to price |
unittype_id | string | No | pointer to the Property Unittype (room type) to price |
start_at | string (date-time) | No | the arrival (check-in) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_at | string (date-time) | No | the departure (check-out) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
guests | number | No | total number of guests |
adults | number | No | number of adults |
children | number | No | number of children |
promotion_code | string | No | promotion or coupon code to apply |
currency | string | No | ISO 4217 currency code |
total_amount | number | No | the total price of the stay |
deposit_amount | number | No | the deposit due at booking |
line_items | PropertyLineitem[] | No | price breakdown (base price, fees, taxes, discounts) |
line_items[].type | enum | No | base price, fee, tax, discount or deposit Values: BASE, FEE, TAX, DISCOUNT, DEPOSIT, OTHER |
line_items[].name | string | No | the line item name, eg. Cleaning fee |
line_items[].description | string | No | free-text description of the line item |
line_items[].amount | number | No | the line item amount (discounts are negative) |
line_items[].is_mandatory | boolean | No | whether the line item is mandatory |
Errors
Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).
{
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to unified.to API; max requests per minute: N"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not supported by this integration. |
Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.
429 Too Many Requests
A 429 has two possible sources:
- The integration's own rate limit, passed through.
- Unified's workspace limit: a rolling 60 seconds, set by plan, with the message
Too many requests to unified.to API; max requests per minute: N.
const options = {
method: 'POST',
url: 'https://api.unified.to/property/5de520f96e439b002043d8dc/quote',
headers: {
authorization: 'bearer .....'
},
data: undefined,
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know
Was this page helpful?