Skip to main content

QuoteRequest

Request payload for prebooking quote

criteria objectrequired

Quote criteria (CriteriaQuoteInput proto)

optionRefIdstringrequired

Pass search options[].id here. After quote, book with optionQuote.optionRefId.

languagestring

Response language code (ISO 639-1)

Example: en
additionalData object

Optional string map forwarded to the integration. Aggregator also reads paymentMode (MERCHANT / DIRECT_ONLY) for VCC policy and skipMarkup.

property name*string
search_idstring

Analytics only (not a booking token). Funnel search ID from availability (searchId in JSON). Do not pass this value as optionRefId.

How it works:

  • Pass the search_id returned from /hotels/v1/availability to link this quote to the original search.
  • Enables funnel analysis: tracks conversion from Search → Quote.
  • If not provided, the system will attempt to link using:
    1. Request context (if same request flow)
    2. Correlation ID (as fallback for cross-request linking)
  • The source of the ID is tracked in analytics (search_id_source: "request", "context", "correlation_id").

Benefits:

  • Accurate funnel conversion metrics
  • Better analytics and reporting
  • Ability to track user journey across operations

Example: "search_id": "550e8400-e29b-41d4-a716-446655440000"

settings objectrequired

Common settings for all requests

requestIdstring

Unique request identifier for tracking

Example: req-123456789
connectionCodesstring[]required

List of provider connection codes to query

Possible values: >= 1

Example: ["testb-conn-1876","testb-conn-1877"]
auditTransactionsboolean

When true, responses may include auditData.transactions with supplier-level traces for debugging. Use sparingly in production; redact sensitive data in logs.

Default value: false
timeoutinteger<int32>

Client timeout hint in milliseconds; platform and supplier minimums may still apply (especially for book). For availability it is also clamped to the server maximum (60000 by default), and the clamped value is the budget forwarded to the connections, so a larger figure is silently reduced rather than honoured. No schema-level default is declared on purpose: this object is shared by every operation and the effective fallback is per-operation (availability uses 10000, book is considerably higher). Omit the field to take the server's fallback for the operation you are calling rather than sending one that would cut a longer operation short.

testModeboolean

When true, enables non-production / sandbox-oriented behaviour where supported for the connection.

Default value: false
debugData object

Additional debug data

property name*any

Additional debug data

QuoteRequest
{
"criteria": {
"optionRefId": "string",
"language": "en",
"additionalData": {
"paymentMode": "MERCHANT"
},
"search_id": "string"
},
"settings": {
"requestId": "req-123456789",
"connectionCodes": [
"testb-conn-1876",
"testb-conn-1877"
],
"auditTransactions": false,
"timeout": 0,
"testMode": false,
"debugData": {}
}
}