SearchResponse
SearchResponse returns availability options along with audit metadata.
auditData object
Request audit information and downstream trace ids.
Identifier supplied by the caller to correlate the request.
transactions object[]
Downstream transactions performed during the request lifecycle.
Access identifier used for the provider call.
Raw request payload captured for auditing.
Raw response payload captured for auditing.
Identifier of the transaction within the aggregator.
Duration in milliseconds for the provider call.
Target URL of the provider call.
HTTP status code returned by the provider.
httpResponseHeaders object
HTTP headers returned by the provider.
errors object[]
Blocking errors that prevented processing or returning results.
Error type grouping to help the client react appropriately.
Possible values: [ERR_TYPE_NONE, ERR_TYPE_UNKNOWN, ERR_TYPE_CLIENT, ERR_TYPE_PROVIDER, ERR_TYPE_SERVICE]
Specific error code exposed by the aggregator.
Possible values: [ERR_CODE_NONE, ERR_CODE_UNKNOWN, ERR_CODE_ACCESS_DATA_MISSING, ERR_CODE_BAD_RESPONSE, ERR_CODE_BAD_REQUEST, ERR_CODE_MISSING_FIELDS, ERR_CODE_CONFIGURATION]
Human readable description of the error.
additionalData object
Additional key/value data associated with the error.
Access identifier that produced the error when applicable.
warnings object[]
Non-blocking warnings generated during processing.
Warning code categorising the issue.
Possible values: [WARN_CODE_NONE, WARN_MAPPING_HOTEL_MISSING, WARN_MAPPING_ROOM_MISSING, WARN_MAPPING_RATE_PLAN_MISSING, WARN_MAPPING_BOARD_CODE_MISSING]
Human readable warning description.
additionalData object
Additional key/value data associated with the warning.
Access identifier that produced the warning when available.
debugData object[]
Extra diagnostic data returned when debug mode is enabled.
Type identifier that categorises the value.
Associated value.
options object[]
Availability options aggregated from providers.
Aggregator unique identifier for the option.
Access identifier that supplied the option.
Provider hotel identifier.
Hotel name provided by the supplier.
Provider board code associated with the option.
Descriptive board name.
rateRules object[]
Commercial rules that apply to the option rate.
Type categorising the rule.
Possible values: [RATE_RULES_UNSPECIFIED, RATE_RULES_BALEARIC_RESIDENT, RATE_RULES_CANARY_RESIDENT, RATE_RULES_CUSTOM, RATE_RULES_ESSENTIAL_WORKER, RATE_RULES_HONEYMOON, RATE_RULES_LARGE_FAMILY, RATE_RULES_MOBILE, RATE_RULES_NEGOTIATED, RATE_RULES_CORPORATE, RATE_RULES_OLDER55, RATE_RULES_OLDER60, RATE_RULES_OLDER65, RATE_RULES_PACKAGE, RATE_RULES_PUBLIC_SERVANT, RATE_RULES_UNEMPLOYED, RATE_RULES_WARRANTY]
Free text description supplied by the provider.
rooms object[]
Rooms included in the option.
Identifier that links the room to the requested occupancy.
Provider room identifier.
Room name or description.
roomPrice object
Room total price including taxes or fees.
Indicates whether the price is binding or subject to change.
Recommended selling price.
Net cost injected by the provider.
ISO 4217 currency code for the price amounts.
ratePlan object
Rate plan that governs booking conditions.
Provider rate plan code.
Display name for the rate plan.
promotions object[]
Promotions applied to the room.
Promotion identifier.
Human readable promotion name.
Promotion amount or percentage as provided by the supplier.
Start date for the promotion validity window.
End date for the promotion validity window.
Deprecated: number of units allocated for this room.
price object
Total price for the stay.
Indicates whether the price is binding or subject to change.
Recommended selling price.
Net cost injected by the provider.
ISO 4217 currency code for the price amounts.
Payment type that dictates collection mechanics.
Possible values: [MERCHANT, DIRECT, CARD_BOOKING, CARD_CHECK_IN]
surcharges object[]
Optional surcharges applied to the booking.
Surcharge type identifier.
Human readable description of the surcharge.
Indicates whether the surcharge is mandatory.
Indicates whether the surcharge is included in the displayed price.
price object
Price associated with the surcharge.
Indicates whether the price is binding or subject to change.
Recommended selling price.
Net cost injected by the provider.
ISO 4217 currency code for the price amounts.
cancelPolicy object
Cancellation policy describing penalties and windows.
cancelPenalties object[]
Penalties applicable when cancelling.
Currency used for the penalty value.
Deadline timestamp after which the penalty applies.
Hours before arrival when the penalty becomes effective.
Type of penalty value.
Possible values: [IMPORT, NIGHTS, PERCENT]
Penalty value interpreted according to penaltyType.
Indicates whether the booking is refundable.
remarks object[]
Additional remarks or notes.
Type identifier that categorises the value.
Associated value.
Indicates whether the option originated from cache instead of a live call.
tracing object
Tracing details that summarise downstream provider performance.
Overall outcome of the request.
Possible values: [SEARCH_TRACING_STATUS_OK, SEARCH_TRACING_STATUS_OK_NO_RESULTS, SEARCH_TRACING_STATUS_OK_WARNINGS, SEARCH_TRACING_STATUS_WARNINGS, SEARCH_TRACING_STATUS_ERRORS, SEARCH_TRACING_STATUS_UNKNOWN, SEARCH_TRACING_STATUS_PARTIAL, SEARCH_TRACING_STATUS_PARTIAL_WITH_WARNINGS_ERRORS, SEARCH_TRACING_STATUS_WARNINGS_ERRORS]
accessSpans object[]
Per-access spans representing each provider call.
Identifier of the access that was called.
Result of the access call.
Possible values: [SEARCH_TRACING_SPAN_STATUS_OK, SEARCH_TRACING_SPAN_STATUS_OK_NO_RESULTS, SEARCH_TRACING_SPAN_STATUS_OK_WARNINGS, SEARCH_TRACING_SPAN_STATUS_WARNINGS, SEARCH_TRACING_SPAN_STATUS_ERRORS, SEARCH_TRACING_SPAN_STATUS_CACHED]
Number of hotels requested from the provider.
Number of hotels returned by the provider.
transactions object[]
Provider transactions for the access.
Identifier of the downstream transaction.
Status of the provider interaction.
Possible values: [SEARCH_TRACING_SPAN_STATUS_OK, SEARCH_TRACING_SPAN_STATUS_OK_NO_RESULTS, SEARCH_TRACING_SPAN_STATUS_OK_WARNINGS, SEARCH_TRACING_SPAN_STATUS_WARNINGS, SEARCH_TRACING_SPAN_STATUS_ERRORS, SEARCH_TRACING_SPAN_STATUS_CACHED]
Duration in milliseconds.
{
"auditData": {
"requestId": "string",
"transactions": [
{
"accessId": "string",
"request": "string",
"response": "string",
"id": "string",
"duration": 0,
"httpUrl": "string",
"httpStatusCode": 0,
"httpResponseHeaders": {}
}
]
},
"errors": [
{
"type": "ERR_TYPE_NONE",
"code": "ERR_CODE_NONE",
"description": "string",
"additionalData": {},
"accessId": "string"
}
],
"warnings": [
{
"code": "WARN_CODE_NONE",
"description": "string",
"additionalData": {},
"accessId": "string"
}
],
"debugData": [
{
"type": "string",
"value": "string"
}
],
"options": [
{
"id": "string",
"accessId": "string",
"hotelCode": "string",
"hotelName": "string",
"boardCode": "string",
"boardName": "string",
"rateRules": [
{
"type": "RATE_RULES_UNSPECIFIED",
"description": "string"
}
],
"rooms": [
{
"occupancyRefId": 0,
"code": "string",
"description": "string",
"roomPrice": {
"binding": true,
"suggested": 0,
"net": 0,
"currency": "string"
},
"ratePlan": {
"code": "string",
"name": "string"
},
"promotions": [
{
"code": "string",
"name": "string",
"amount": "string",
"effectiveDate": "2024-07-29T15:51:28.071Z",
"expireDate": "2024-07-29T15:51:28.071Z"
}
]
}
],
"price": {
"binding": true,
"suggested": 0,
"net": 0,
"currency": "string"
},
"paymentType": "MERCHANT",
"surcharges": [
{
"type": "string",
"description": "string",
"mandatory": true,
"included": true,
"price": {
"binding": true,
"suggested": 0,
"net": 0,
"currency": "string"
}
}
],
"cancelPolicy": {
"cancelPenalties": [
{
"currency": "string",
"deadline": "2024-07-29T15:51:28.071Z",
"hoursBefore": 0,
"penaltyType": "IMPORT",
"value": 0
}
],
"refundable": true
},
"remarks": [
{
"type": "string",
"value": "string"
}
],
"fromCache": true
}
],
"tracing": {
"status": "SEARCH_TRACING_STATUS_OK",
"accessSpans": [
{
"access": "string",
"status": "SEARCH_TRACING_SPAN_STATUS_OK",
"hotelsRequested": 0,
"hotelsReturned": 0,
"transactions": [
{
"id": "string",
"status": "SEARCH_TRACING_SPAN_STATUS_OK",
"duration": 0
}
]
}
]
}
}