Skip to main content

BookRs

Represents the response for a hotel booking operation.

Properties

NameTypeDescription
AuditDataProviderAuditContains the requests and responses exchanged with the supplier.This field is populated internally by the connector framework. Integrators do not need to handle this field manually.
AuditData/RequestArray<ProviderAuditRq>Collection of audit entries for provider requests.Each entry contains details about a specific request made to the provider.
AuditData/Request/SendAtStringThe timestamp indicating when the request was sent.
AuditData/Request/DataStringThe payload data included in the request.
AuditData/Request/UrlStringThe URL of the provider endpoint to which the request is sent.
AuditData/Request/HeadersObjectA collection of headers included in the request.
AuditData/Request/HttpMethodHttpMethodThe HTTP method used to send the request.
AuditData/Request/HttpMethod/
Method
StringNo description available.
AuditData/ResponseArray<ProviderAuditRs>Collection of audit entries for provider responses.Each entry contains details about a specific response received from the provider.
AuditData/Response/ReceivedAtStringThe timestamp indicating when the response was received.
AuditData/Response/DataStringThe payload data contained in the provider's response.
AuditData/Response/HeadersObjectA collection of headers included in the provider's response.
AuditData/Response/StatusCodeIntegerThe HTTP status code returned by the provider.
AdviseMessagesArray<AdviseMessage>The collection of advise messages associated with the booking response.
AdviseMessages/CodeAdviseMessageCodeGets the code that represents the message type.
AdviseMessages/LevelAdviseMessageLevelGets the severity level of the message (e.g., Error, Warning, or Info).
AdviseMessages/DescriptionStringGets the message description providing additional context.
AdviseMessages/CorrelationIdStringGets a unique identifier for correlating the message with specific operations.
AdviseMessages/ExternalExternalGets additional external details associated with the message.
AdviseMessages/External/CodeStringThe supplier's internal code for identifying the nature of the response or error.
AdviseMessages/External/
Message
StringA descriptive message returned by the supplier.
AdviseMessages/External/
HttpStatusCode
IntegerThe HTTP status code of the supplier's response.
BookDetailsBookDetailsThe details of the booking.
BookDetails/StatusBookStatusThe current status of the booking.
BookDetails/ReferenceReferenceA collection of locators that identify the booking.
BookDetails/Reference/
ClientLocator
StringThe booking locator provided by the client.This is typically used to match the booking in the client's internal systems.
BookDetails/Reference/
SupplierLocator
StringThe booking locator provided by the supplier.This identifier is used to reference the booking in the supplier's system.
BookDetails/Reference/
HotelLocator
StringThe booking locator specific to the hotel, provided by the supplier. (Optional)This may be required in cases where the hotel system uses its own unique identifiers.
BookDetails/HolderHolderThe personal details of the booking holder.
BookDetails/Holder/NameStringThe name of the holder.
BookDetails/Holder/SurNameStringThe surname of the holder.
BookDetails/Holder/
PersonalTitleType
PersonalTitleTypeThe personal title type of the holder.
BookDetails/Holder/ContactInfoContactInfoThe contact information of the holder.
BookDetails/Holder/ContactInfo/
Email
StringThe email address of the passenger.
BookDetails/Holder/ContactInfo/
Phone
StringThe phone number of the passenger.
BookDetails/HotelHotelDetailThe hotel details associated with the booking.
BookDetails/Hotel/BookingDateStringThe date when the booking was created.
BookDetails/Hotel/CheckInStringThe check-in date for the booking.
BookDetails/Hotel/CheckOutStringThe check-out date for the booking.
BookDetails/Hotel/
CheckInAsDateTime
StringThe check-in date as a DateTime object.
BookDetails/Hotel/
CheckOutAsDateTime
StringThe check-out date as a DateTime object.
BookDetails/Hotel/HotelCodeStringThe unique code identifying the hotel.
BookDetails/Hotel/HotelNameStringThe name of the hotel associated with the booking.
BookDetails/Hotel/BoardCodeStringThe board code for the booking.
BookDetails/Hotel/OccupanciesArray<BookOccupancy>The collection of occupancies associated with the booking.
BookDetails/Hotel/Occupancies/
OccupancyId
IntegerThe unique identifier for the occupancy.
BookDetails/Hotel/Occupancies/
Paxes
Array<BookPaxInput>The collection of passenger inputs (paxes) for the occupancy.
BookDetails/Hotel/Occupancies/
Paxes/Age
IntegerThe age of the passenger.
BookDetails/Hotel/Occupancies/
Paxes/Name
StringThe first name of the passenger.
BookDetails/Hotel/Occupancies/
Paxes/SurName
StringThe surname (last name) of the passenger.
BookDetails/Hotel/Occupancies/
Paxes/PersonalTitleType
PersonalTitleTypeThe personal title type of the passenger.
BookDetails/Hotel/RoomsArray<Room>The collection of rooms included in the booking.
BookDetails/Hotel/Rooms/
OccupancyRefId
IntegerNumeric ID linking this room to its occupancy data in the Occupancy.
BookDetails/Hotel/Rooms/CodeStringUnique code assigned to this room.
BookDetails/Hotel/Rooms/
Description
StringDescription of the room's features or characteristics.
BookDetails/Hotel/Rooms/
RoomPrice
RoomPricePricing information for the room, including total price and currency details.
BookDetails/Hotel/Rooms/
RoomPrice/Price
PriceThe total price of the room.
BookDetails/Hotel/Rooms/
RoomPrice/Price/Currency
CurrencyThe currency of the price, represented in ISO 4217 format (e.g., USD, EUR).
BookDetails/Hotel/Rooms/
RoomPrice/Price/Binding
BooleanIndicates whether the price is binding.
BookDetails/Hotel/Rooms/
RoomPrice/Price/Net
DoubleThe net price paid by the Buyer to the Seller.
BookDetails/Hotel/Rooms/
RoomPrice/Price/Gross
DoubleThe gross price, which includes the net price and the Buyer's commission.
BookDetails/Hotel/Rooms/
RoomPrice/Price/NetSpecified
BooleanIndicates whether the net price is explicitly specified.
BookDetails/Hotel/Rooms/
RoomPrice/Price/
MinimumSellingPrice
DoubleThe minimum selling price.
BookDetails/Hotel/Rooms/
RoomPrice/PriceBreakdown
Array<PriceBreakdown>Breakdown of the room price over specific periods, such as daily rates.
BookDetails/Hotel/Rooms/
RoomPrice/PriceBreakdown/Price
PriceThe price for each day of the room during the specified period.
BookDetails/Hotel/Rooms/
RoomPrice/PriceBreakdown/Price/
Currency
CurrencyThe currency of the price, represented in ISO 4217 format (e.g., USD, EUR).
BookDetails/Hotel/Rooms/
RoomPrice/PriceBreakdown/Price/
Binding
BooleanIndicates whether the price is binding.
BookDetails/Hotel/Rooms/
RoomPrice/PriceBreakdown/Price/
Net
DoubleThe net price paid by the Buyer to the Seller.
BookDetails/Hotel/Rooms/
RoomPrice/PriceBreakdown/Price/
Gross
DoubleThe gross price, which includes the net price and the Buyer's commission.
BookDetails/Hotel/Rooms/
RoomPrice/PriceBreakdown/Price/
NetSpecified
BooleanIndicates whether the net price is explicitly specified.
BookDetails/Hotel/Rooms/
RoomPrice/PriceBreakdown/Price/
MinimumSellingPrice
DoubleThe minimum selling price.
BookDetails/Hotel/Rooms/
RoomPrice/PriceBreakdown/Start
IntegerThe starting day of the pricing period (inclusive).
BookDetails/Hotel/Rooms/
RoomPrice/PriceBreakdown/End
IntegerThe ending day of the pricing period (inclusive).
BookDetails/Hotel/Rooms/
Refundable
BooleanIndicates if the room is refundable based on the cancellation policy.
BookDetails/Hotel/Rooms/
RefundableSpecified
BooleanIndicates whether the refundable status has been explicitly specified.
BookDetails/Hotel/Rooms/
LegacyRoomId
StringLegacy identifier for internal tracking. Automatically generated using OccupancyRefId and Code.
BookDetails/Hotel/Rooms/UnitsIntegerNumber of units available for this room type.
BookDetails/Hotel/Rooms/
RatePlan
RatePlanRate plan associated with this room.
BookDetails/Hotel/Rooms/
RatePlan/Code
StringThe unique code for the rate plan.
BookDetails/Hotel/Rooms/
RatePlan/Name
StringThe name of the rate plan.
BookDetails/Hotel/Rooms/
Promotions
Array<Promotion>Promotions or discounts applicable to this room.
BookDetails/Hotel/Rooms/
Promotions/Code
StringThe unique code identifying the promotion.
BookDetails/Hotel/Rooms/
Promotions/Name
StringThe name of the promotion.
BookDetails/Hotel/Rooms/
Remarks
Array<Remark>Additional remarks or notes about this room.
BookDetails/Hotel/Rooms/
Remarks/RemarkType
RemarkTypeThe type of the remark, categorized by RemarkType, specifies its nature or purpose. It may refer to the hotel as a whole, a specific room being booked, services provided by the accommodation, or general remarks not tied to any particular entity.
BookDetails/Hotel/Rooms/
Remarks/Text
StringThe text content of the remark, providing details or additional notes.This can include supplier-specific instructions, conditions, or general information.
BookDetails/Hotel/Rooms/
Surcharges
Array<Surcharge>Additional surcharges applied to this room.
BookDetails/Hotel/Rooms/
Surcharges/ChargeType
ChargeTypeSpecifies whether the surcharge is included in the room rate or must be paid separately at the property. See ChargeType for possible values.
BookDetails/Hotel/Rooms/
Surcharges/Mandatory
BooleanIndicates whether this surcharge is mandatory. Mandatory surcharges, such as government taxes, must always be paid, while optional surcharges may depend on the guest's preferences.
BookDetails/Hotel/Rooms/
Surcharges/Description
StringProvides a description of the surcharge, giving context about the type of cost it represents.Examples: "Tourist Tax", "Resort Fee", or "Additional Bed Fee".
BookDetails/Hotel/Rooms/
Surcharges/Price
PriceRepresents the price of this surcharge, including the amount and currency. See Price for details about the price structure.
BookDetails/Hotel/Rooms/
Surcharges/Price/Currency
CurrencyThe currency of the price, represented in ISO 4217 format (e.g., USD, EUR).
BookDetails/Hotel/Rooms/
Surcharges/Price/Binding
BooleanIndicates whether the price is binding.
BookDetails/Hotel/Rooms/
Surcharges/Price/Net
DoubleThe net price paid by the Buyer to the Seller.
BookDetails/Hotel/Rooms/
Surcharges/Price/Gross
DoubleThe gross price, which includes the net price and the Buyer's commission.
BookDetails/Hotel/Rooms/
Surcharges/Price/NetSpecified
BooleanIndicates whether the net price is explicitly specified.
BookDetails/Hotel/Rooms/
Surcharges/Price/
MinimumSellingPrice
DoubleThe minimum selling price.
BookDetails/Hotel/Rooms/
Surcharges/Code
StringAn optional code that uniquely identifies this surcharge for internal or external reference. This can be useful for tracking specific fees or integrating with supplier systems.
BookDetails/Hotel/Rooms/
CancelPolicy
CancelPolicyCancellation policy specific to this room.
BookDetails/Hotel/Rooms/
CancelPolicy/Refundable
BooleanIndicates whether the booking is refundable.
BookDetails/Hotel/Rooms/
CancelPolicy/CancelPenalties
Array<CancelPenalty>A collection of penalties that apply if the booking is canceled.
BookDetails/Hotel/Rooms/
CancelPolicy/CancelPenalties/
HoursBefore
IntegerIndicates the number of hours before the check-in date when the penalty becomes applicable.
BookDetails/Hotel/Rooms/
CancelPolicy/CancelPenalties/
PenaltyType
PenaltyTypeSpecifies the type of penalty enforced upon cancellation.
BookDetails/Hotel/Rooms/
CancelPolicy/CancelPenalties/
Currency
CurrencySpecifies the currency in which the penalty value is expressed.
BookDetails/Hotel/Rooms/
CancelPolicy/CancelPenalties/
Value
DoubleIndicates the value of the penalty.
BookDetails/Hotel/Rooms/
CancelPolicy/CancelPenalties/
Deadline
StringSpecifies the absolute deadline for the penalty in UTC format.
BookDetails/Hotel/Rooms/
CancelPolicy/
CancelPolicyDescription
StringProvides additional details or a textual summary of the cancellation policy.
BookDetails/Hotel/Rooms/BedsArray<Bed>List of beds available in the room, including types and configurations.
BookDetails/Hotel/Rooms/Beds/
Type
StringThe type of the bed.
BookDetails/Hotel/Rooms/Beds/
Description
StringA description of the bed.
BookDetails/Hotel/Rooms/Beds/
Count
IntegerThe number of beds of this type in the room.
BookDetails/Hotel/Rooms/Beds/
Shared
BooleanIndicates whether the bed is shared.
BookDetails/Hotel/Rooms/
Amenities
Array<Amenity>Amenities included with this room, such as Wi-Fi or parking.
BookDetails/Hotel/Rooms/
Amenities/Code
StringA unique code that identifies the amenity.
BookDetails/Hotel/Rooms/
Amenities/Type
AmenityTypeThe type of the amenity, defined by AmenityType.
BookDetails/Hotel/Rooms/
Amenities/Value
StringThe value associated with the amenity.
BookDetails/Hotel/Rooms/
Amenities/Texts
StringAdditional textual information or description for the amenity.
BookDetails/Hotel/Rooms/
UnitsSpecified
BooleanIndicates whether the number of units has been explicitly specified.
BookDetails/Hotel/Rooms/
Features
Array<Feature>Features or custom attributes of the room, used for specific integrations.
BookDetails/Hotel/Rooms/
Features/Code
StringThe unique code identifying the feature of the room.
BookDetails/PricePriceThe total price of the booking.
BookDetails/Price/CurrencyCurrencyThe currency of the price, represented in ISO 4217 format (e.g., USD, EUR).
BookDetails/Price/BindingBooleanIndicates whether the price is binding.
BookDetails/Price/NetDoubleThe net price paid by the Buyer to the Seller.
BookDetails/Price/GrossDoubleThe gross price, which includes the net price and the Buyer's commission.
BookDetails/Price/NetSpecifiedBooleanIndicates whether the net price is explicitly specified.
BookDetails/Price/
MinimumSellingPrice
DoubleThe minimum selling price.
BookDetails/CancelPolicyCancelPolicyThe cancellation policy associated with the booking.
BookDetails/CancelPolicy/
Refundable
BooleanIndicates whether the booking is refundable.
BookDetails/CancelPolicy/
CancelPenalties
Array<CancelPenalty>A collection of penalties that apply if the booking is canceled.
BookDetails/CancelPolicy/
CancelPenalties/HoursBefore
IntegerIndicates the number of hours before the check-in date when the penalty becomes applicable.
BookDetails/CancelPolicy/
CancelPenalties/PenaltyType
PenaltyTypeSpecifies the type of penalty enforced upon cancellation.
BookDetails/CancelPolicy/
CancelPenalties/Currency
CurrencySpecifies the currency in which the penalty value is expressed.
BookDetails/CancelPolicy/
CancelPenalties/Value
DoubleIndicates the value of the penalty.
BookDetails/CancelPolicy/
CancelPenalties/Deadline
StringSpecifies the absolute deadline for the penalty in UTC format.
BookDetails/CancelPolicy/
CancelPolicyDescription
StringProvides additional details or a textual summary of the cancellation policy.
BookDetails/RemarksArray<Remark>Additional remarks or notes related to the booking.
BookDetails/Remarks/RemarkTypeRemarkTypeThe type of the remark, categorized by RemarkType, specifies its nature or purpose. It may refer to the hotel as a whole, a specific room being booked, services provided by the accommodation, or general remarks not tied to any particular entity.
BookDetails/Remarks/TextStringThe text content of the remark, providing details or additional notes.This can include supplier-specific instructions, conditions, or general information.
BookDetails/
BillingSupplierCode
StringThe code of the agency responsible for the booking.
BookDetails/PayableStringInformation about the entity responsible for payment of the booking.
BookDetails/AddOnsObjectAdditional metadata provided by the supplier for internal use.
AddOnsObjectA dictionary containing supplier information for the option.