Create a quote

Updated:

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
line_items array
price breakdown (base price, fees, taxes, discounts)

Returns

Response fieldTypeRequiredDescription
idstringNounique identifier for the quote
created_atstring (date-time)Nowhen the quote was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
listing_idstringNopointer to the Property Listing to price
unittype_idstringNopointer to the Property Unittype (room type) to price
start_atstring (date-time)Nothe arrival (check-in) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)Nothe departure (check-out) date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
guestsnumberNototal number of guests
adultsnumberNonumber of adults
childrennumberNonumber of children
promotion_codestringNopromotion or coupon code to apply
currencystringNoISO 4217 currency code
total_amountnumberNothe total price of the stay
deposit_amountnumberNothe deposit due at booking
line_itemsPropertyLineitem[]Noprice breakdown (base price, fees, taxes, discounts)
line_items[].typeenumNobase price, fee, tax, discount or deposit Values: BASE, FEE, TAX, DISCOUNT, DEPOSIT, OTHER
line_items[].namestringNothe line item name, eg. Cleaning fee
line_items[].descriptionstringNofree-text description of the line item
line_items[].amountnumberNothe line item amount (discounts are negative)
line_items[].is_mandatorybooleanNowhether 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"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot 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?