Skip to main content

CheckBookings By Dates

Overview​

The CheckBookings By Dates operation allows clients to retrieve the status of bookings that fall within a specified date range. It provides a way to list multiple bookings based on criteria such as check-in dates or booking creation dates. This operation is optional but can significantly enhance the functionality of a Connector by providing bulk booking insights.

  • Booking Retrieval by Date: Enables clients to fetch booking details for a given range of dates.
  • Data Insights: Useful for operational analysis or customer service purposes, such as managing upcoming check-ins or tracking recent bookings.
  • Supplier Compatibility: Adapts to suppliers that support range-based booking queries.

When to Use:

  • Operational Monitoring: To track all bookings for a specific date range, such as upcoming arrivals.
  • Bulk Booking Insights: To retrieve booking data for analysis or reporting purposes.
  • Supplier-Specific Use Cases: When suppliers provide additional insights or booking details for specific date ranges.

Date Range Options:

  • Check-in Date: Fetch bookings based on the guest's check-in date.
  • Booking Date: Fetch bookings based on when the reservation was created in the supplier's system.

Note: This operation is not mandatory but is highly recommended for suppliers supporting this functionality, as it provides comprehensive booking management capabilities.

Common Scenarios:

  • Upcoming Arrivals: Retrieve all bookings with check-ins scheduled for the upcoming week.
  • Booking Analytics: Generate reports for all bookings made during a promotional period.
  • Error Handling:
    • BookingNotFound: No bookings found for the specified date range.
    • SupplierError: Indicates an issue with the supplier's API, such as unavailability or invalid date formats.

Request​

Overview​

The Request Object includes date range criteria and any supplier-specific fields.

Sample​

var checkBookingsByDateRq = new CheckBookingsByDateRq
{
    Input = new CheckBookingsByDateInput
    {
        CheckIn = "2024-05-12",
        CheckOut = "2024-05-14",
        DateType = "Arrival",
        Language = "ES",
        Currency = "EUR"
    },
    Settings = new Settings
    {
        Supplier = "HOTELTEST",
        Platform = "HOTELTEST",
        Client = "TravelAgency123",
        Access = new Access
        {
            Code = 1001,
            User = "agency_user",
            Password = "secure_password",
            ApiKey = "API_KEY_123456789",
            Urls = new Urls
            {
                Book = "https://api.hotelsupplier.com/book",
                Search = "https://api.hotelsupplier.com/search",
                Quote = "https://api.hotelsupplier.com/quote",
                Generic = "https://api.hotelsupplier.com/generic"
            },
            Parameters = new Dictionary<string, string>
            {
                { "someParameter1", "50" },
                { "someParameter2", "true" },
                { "someParameter3", "5000" },
                { "someParameter4", "SupplierX" }
            }
        },
        BusinessRules = new BusinessRules
        {
            OptionsQuota = 170,
            BusinessRuleType = "CheaperAmount"
        },
        Timeout = "00:00:10",
        TimeoutAsTimeSpan = TimeSpan.Parse("00:00:10"),
        IncludeProviderTransactions = true
    }
};

Details​

NameRelationTypeDescription
Settings1SettingsContains the settings required for the check bookings request.
Settings/Supplier1StringIdentifies the supplier associated with the hotel operation. This is a unique code generated by Travelgate within its system to represent the supplier.
Settings/Platform1StringRepresents the platform on which the hotel operation is performed.Platforms are collections of suppliers, and the platform code is generated by Travelgate to define the operational context.
Settings/Client1StringRepresents the client performing the hotel operation.This is a unique client code assigned by Travelgate to identify the client within its system.
Settings/Access1AccessContains access information required for the operation, including API credentials, endpoints, and other connection details specific to the supplier's integration.
Settings/Access/Code1IntegerThe unique code identifying the access configuration.
Settings/Access/User0 . . 1StringThe username used for authentication with the supplier.
Settings/Access/Password0 . . 1StringThe password used for authentication with the supplier.
Settings/Access/ApiKey0 . . 1StringThe API key used for authentication or authorization.
Settings/Access/Urls1UrlsThe URLs associated with the access configuration.
Settings/Access/Urls/Book0 . . 1StringThe URL used for booking operations.
Settings/Access/Urls/Search0 . . 1StringThe URL used for Search operations.
Settings/Access/Urls/Quote0 . . 1StringThe URL used for Quote operations.
Settings/Access/Urls/Generic0 . . 1StringA generic URL for additional operations.
Settings/Access/Parameters0 . . 1AccessParametersAdditional parameters related to the connection.
Settings/BusinessRules0 . . 1BusinessRulesSpecifies the business rules to be applied during the operation. These rules define operational constraints and behavior, such as quota limits or prioritization criteria.
Settings/BusinessRules/
OptionsQuota		0 . . 1IntegerThe maximum number of options returned for each board in the Search query.
Settings/BusinessRules/
BusinessRuleType		0 . . 1BusinessRulesTypeThe business rule type that determines how Search results are prioritized or filtered.
Settings/Timeout1StringDefines the timeout period for the operation as a string value.This indicates the maximum amount of time to wait for a supplier's response before timing out.The value must be provided in timestamp format (e.g., "00:00:10" for 10 seconds).
Settings/TimeoutAsTimeSpan0 . . 1StringConverts the timeout value from the string representation (Timeout) into a TimeSpan for use in time-based operations.
Settings/
IncludeProviderTransactions		1BooleanIndicates whether detailed traces of provider transactions should be included in the operation's response.If enabled, the ProviderAudit field in responses will contain the transaction logs (e.g., requests and responses exchanged with the supplier).
Input1CheckBookingsByDateInputContains the details for checking bookings within a specific date range.
Input/CheckIn1StringThe check-in date for the booking check, specified as a string.
Input/CheckOut1StringThe check-out date for the booking check, specified as a string.
Input/CheckInAsDateTime0 . . 1StringThe check-in date parsed as a DateTime object, expressed in UTC 0
Input/CheckOutAsDateTime0 . . 1StringThe check-out date parsed as a DateTime object, expressed in UTC 0
Input/DateType1DateRangeTypeSpecifies the type of date range to use for the booking check.
Input/Language0 . . 1StringThe language code to be used for the booking check.
Input/Currency0 . . 1CurrencyThe currency to be used for the booking check.

Response​

The Response Object provides a list of bookings within the specified date range, including their status, locators, and optional details.

Overview​

  • Booking Status: Indicates whether bookings are active, canceled, or unknown.
  • Locators: Provides client and supplier locators for each booking.
  • Optional Data:
    • Guest details.
    • Room information.
    • Payment or cancellation status, depending on the supplier's capabilities.

Sample​

var checkBookingsByDateRs = new CheckBookingsByDateRs
{
    AuditData = new AuditData
    {
        Request = new List<Request>
        {
            new Request
            {
                Data = "<x>SupplierRequest</x>",
                Headers = new Dictionary<string, string>
                {
                    { "Accept", "application/x-protobuf" },
                    { "Accept-Encoding", "gzip,deflate," }
                },
                HttpMethod = new HttpMethod { Method = "POST" },
                SendAt = DateTime.Parse("2025-03-16T08:21:49Z"),
                Url = "http://travelgate.com"
            }
        },
        Response = new List<Response>
        {
            new Response
            {
                Data = "<x>SupplierResponse</x>",
                Headers = new Dictionary<string, string>
                {
                    { "Content-Encoding", "gzip," }
                },
                HttpMethod = new HttpMethod { Method = "POST" },
                ReceivedAt = DateTime.Parse("2025-03-16T08:21:49Z"),
                StatusCode = 200
            }
        }
    },
    AdviseMessages = new List<AdviseMessage>
    {
        new AdviseMessage
        {
            Code = "SupplierError",
            Level = "Error",
            Description = "Supplier error, check external for more details",
            External = new External
            {
                Code = "Code123",
                Message = "Supplier internal error",
                HttpStatusCode = 200
            }
        }
    },
    Bookings = new List<Booking>
    {
        new Booking
        {
            Status = "Ok",
            Reference = new Reference
            {
                ClientLocator = "ClientReference12345",
                SupplierLocator = "SupplierLocator389b10ca-893b-4e7b-adf6-b067a1b1d9b3",
                HotelLocator = "HotelLocator208c2b6f-1cdf-4204-9ebe-f147808218d9"
            },
            Holder = new Holder
            {
                Name = "John",
                SurName = "Smith",
                PersonalTitleType = "MR",
                ContactInfo = new ContactInfo
                {
                    Email = "someemail@travelgate.com",
                    Phone = "66666666"
                }
            },
            Hotel = new Hotel
            {
                BookingDate = DateTime.Parse("2024-05-10"),
                CheckIn = DateTime.Parse("2024-05-12"),
                CheckOut = DateTime.Parse("2024-05-14"),
                HotelCode = "12345",
                HotelName = "Hotel Travelgate",
                BoardCode = "RO",
                Occupancies = new List<Occupancy>
                {
                    new Occupancy
                    {
                        OccupancyId = 1,
                        Paxes = new List<Pax>
                        {
                            new Pax { Age = 30 },
                            new Pax { Age = 30 }
                        }
                    }
                },
                Rooms = new List<Room>
                {
                    new Room
                    {
                        OccupancyRefId = 1,
                        Code = "DBL",
                        Description = "Double standard",
                        RoomPrice = new RoomPrice
                        {
                            Price = new Price
                            {
                                Currency = "EUR",
                                Binding = true,
                                Net = 100,
                                Gross = 100,
                                NetSpecified = true,
                                MinimumSellingPrice = 100
                            },
                            PriceBreakdown = new List<PriceBreakdown>
                            {
                                new PriceBreakdown
                                {
                                    Price = new Price
                                    {
                                        Currency = "EUR",
                                        Binding = true,
                                        Net = 50,
                                        Gross = 50,
                                        NetSpecified = true,
                                        MinimumSellingPrice = 50
                                    },
                                    Start = 0,
                                    End = 1
                                },
                                new PriceBreakdown
                                {
                                    Price = new Price
                                    {
                                        Currency = "EUR",
                                        Binding = true,
                                        Net = 50,
                                        Gross = 50,
                                        NetSpecified = true,
                                        MinimumSellingPrice = 50
                                    },
                                    Start = 1,
                                    End = 2
                                }
                            }
                        },
                        Refundable = true,
                        RefundableSpecified = false
                    }
                }
            },
            Price = new Price
            {
                Currency = "EUR",
                Binding = true,
                Net = 100,
                Gross = 100,
                NetSpecified = true,
                MinimumSellingPrice = 100
            },
            CancelPolicy = new CancelPolicy
            {
                RoomCancelPolicyDescriptions = new List<RoomCancelPolicyDescription>
                {
                    new RoomCancelPolicyDescription
                    {
                        OccupancyRefId = 1,
                        Description = "Cancellations within 48 hours before check-in incur a 50% charge."
                    }
                },
                Refundable = false,
                CancelPenalties = new List<CancelPenalty>
                {
                    new CancelPenalty
                    {
                        HoursBefore = 48,
                        PenaltyType = "Percentage",
                        Currency = "EUR",
                        Value = 50,
                        Deadline = DateTime.Parse("2025-05-30T23:59:59Z")
                    }
                },
                CancelPolicyDescription = "50% charge if canceled within 48 hours before check-in."
            },
            Remarks = new List<Remark>
            {
                new Remark
                {
                    RemarkType = "General",
                    Text = "CheckIn at 10:00 AM"
                }
            }
        }
    },
    Parameters = new List<Parameter>
    {
        new Parameter
        {
            Key = 190,
            Value = "Value81f30d88-28a1-46fc-bd49-f15e9e3448c0",
            ParameterType = "Supplier",
            Immutable = false,
            RoomId = 32
        }
    },
    AddOns = new Dictionary<string, string>
    {
        { "keybd54429a-d5b4-40e4-9bbc-351520de3f96", "valuee436526f-b82e-4286-8351-dc345688bc6c" }
    }
};

Details​

NameRelationTypeDescription
AuditData1ProviderAuditProvides detailed audit data for the supplier transactions, including request and response logs.
AuditData/Request0 . . NArray<ProviderAuditRq>Collection of audit entries for provider requests.Each entry contains details about a specific request made to the provider.
AuditData/Request/SendAt1StringThe timestamp indicating when the request was sent. Date on UTC Standard (ISO 8601 UTC 2025-05-21T08:48:53.9744052+00:00)
AuditData/Request/Data1StringThe payload data included in the request.
AuditData/Request/Url1StringThe URL of the provider endpoint to which the request is sent.
AuditData/Request/Headers1ObjectA collection of headers included in the request.
AuditData/Request/HttpMethod1HttpMethodThe HTTP method used to send the request.
AuditData/Request/HttpMethod/
Method		1StringNo description available.
AuditData/Response0 . . NArray<ProviderAuditRs>Collection of audit entries for provider responses.Each entry contains details about a specific response received from the provider.
AuditData/Response/ReceivedAt1StringThe timestamp indicating when the response was received. Date on UTC Standard (ISO 8601 UTC 2025-05-21T08:48:53.9744052+00:00)
AuditData/Response/Data1StringThe payload data contained in the provider's response.
AuditData/Response/Headers1ObjectA collection of headers included in the provider's response.
AuditData/Response/StatusCode1IntegerThe HTTP status code returned by the provider.
AdviseMessages0 . . NArray<AdviseMessage>A collection of advice messages generated during the booking check operation.
AdviseMessages/Code1AdviseMessageCodeGets the code that represents the message type.
AdviseMessages/Level1AdviseMessageLevelGets the severity level of the message (e.g., Error, Warning, or Info).
AdviseMessages/Description1StringGets the message description providing additional context.
AdviseMessages/CorrelationId0 . . 1StringGets a unique identifier for correlating the message with specific operations.
AdviseMessages/External0 . . 1ExternalGets additional external details associated with the message.
AdviseMessages/External/Code1StringThe supplier's internal code for identifying the nature of the response or error.
AdviseMessages/External/
Message		1StringA descriptive message returned by the supplier.
AdviseMessages/External/
HttpStatusCode		1IntegerThe HTTP status code of the supplier's response.
Bookings0 . . NArray<BookDetails>A list of detailed booking information retrieved during the operation.
Bookings/Status1BookStatusThe current status of the booking.
Bookings/Reference0 . . 1ReferenceA collection of locators that identify the booking.
Bookings/Reference/
ClientLocator		0 . . 1StringThe booking locator provided by the client.This is typically used to match the booking in the client's internal systems.
Bookings/Reference/
SupplierLocator		0 . . 1StringThe booking locator provided by the supplier.This identifier is used to reference the booking in the supplier's system.
Bookings/Reference/
HotelLocator		0 . . 1StringThe 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.
Bookings/Holder0 . . 1HolderThe personal details of the booking holder.
Bookings/Holder/Name1StringThe name of the holder.
Bookings/Holder/SurName1StringThe surname of the holder.
Bookings/Holder/
PersonalTitleType		1PersonalTitleTypeThe personal title type of the holder.
Bookings/Holder/ContactInfo0 . . 1ContactInfoThe contact information of the holder.
Bookings/Holder/ContactInfo/
Email		1StringThe email address of the passenger.
Bookings/Holder/ContactInfo/
Phone		0 . . 1StringThe phone number of the passenger.
Bookings/Hotel0 . . 1HotelDetailThe hotel details associated with the booking.
Bookings/Hotel/BookingDate0 . . 1StringThe date when the booking was created.
Bookings/Hotel/CheckIn0 . . 1StringThe check-in date for the booking.
Bookings/Hotel/CheckOut0 . . 1StringThe check-out date for the booking.
Bookings/Hotel/
CheckInAsDateTime		0 . . 1StringThe check-in date parsed as a DateTime object, expressed in UTC 0
Bookings/Hotel/
CheckOutAsDateTime		0 . . 1StringThe check-out date parsed as a DateTime object, expressed in UTC 0
Bookings/Hotel/HotelCode0 . . 1StringThe unique code identifying the hotel.
Bookings/Hotel/HotelName0 . . 1StringThe name of the hotel associated with the booking.
Bookings/Hotel/BoardCode0 . . 1StringThe board code for the booking.
Bookings/Hotel/Occupancies0 . . NArray<BookOccupancy>The collection of occupancies associated with the booking.
Bookings/Hotel/Occupancies/
OccupancyId		1IntegerThe unique identifier for the occupancy.
Bookings/Hotel/Occupancies/
Paxes		1 . . NArray<BookPaxInput>The collection of passenger inputs (paxes) for the occupancy.
Bookings/Hotel/Occupancies/
Paxes/Age		1IntegerThe age of the passenger.
Bookings/Hotel/Occupancies/
Paxes/Name		1StringThe first name of the passenger.
Bookings/Hotel/Occupancies/
Paxes/SurName		1StringThe surname (last name) of the passenger.
Bookings/Hotel/Occupancies/
Paxes/PersonalTitleType		1PersonalTitleTypeThe personal title type of the passenger.
Bookings/Hotel/Rooms0 . . NArray<Room>The collection of rooms included in the booking.
Bookings/Hotel/Rooms/
OccupancyRefId		1IntegerNumeric ID linking this room to its occupancy data in the Occupancy.
Bookings/Hotel/Rooms/Code1StringUnique code assigned to this room.
Bookings/Hotel/Rooms/
Description		0 . . 1StringDescription of the room's features or characteristics.
Bookings/Hotel/Rooms/RoomPrice1RoomPricePricing information for the room, including total price and currency details.
Bookings/Hotel/Rooms/RoomPrice/
Price		1PriceThe total price of the room.
Bookings/Hotel/Rooms/RoomPrice/
Price/Currency		1CurrencyThe currency of the price, represented in ISO 4217 format (e.g., USD, EUR).
Bookings/Hotel/Rooms/RoomPrice/
Price/Binding		1BooleanIndicates whether the price is binding.
Bookings/Hotel/Rooms/RoomPrice/
Price/Net		1DoubleThe net price paid by the Buyer to the Seller.
Bookings/Hotel/Rooms/RoomPrice/
Price/Gross		1DoubleThe gross price, which includes the net price and the Buyer's commission.
Bookings/Hotel/Rooms/RoomPrice/
Price/NetSpecified		1BooleanIndicates whether the net price is explicitly specified.
Bookings/Hotel/Rooms/RoomPrice/
Price/MinimumSellingPrice		1DoubleThe minimum selling price.
Bookings/Hotel/Rooms/RoomPrice/
PriceBreakdown		0 . . NArray<PriceBreakdown>Breakdown of the room price over specific periods, such as daily rates.
Bookings/Hotel/Rooms/RoomPrice/
PriceBreakdown/Price		1PriceThe price for each day of the room during the specified period.
Bookings/Hotel/Rooms/RoomPrice/
PriceBreakdown/Price/Currency		1CurrencyThe currency of the price, represented in ISO 4217 format (e.g., USD, EUR).
Bookings/Hotel/Rooms/RoomPrice/
PriceBreakdown/Price/Binding		1BooleanIndicates whether the price is binding.
Bookings/Hotel/Rooms/RoomPrice/
PriceBreakdown/Price/Net		1DoubleThe net price paid by the Buyer to the Seller.
Bookings/Hotel/Rooms/RoomPrice/
PriceBreakdown/Price/Gross		1DoubleThe gross price, which includes the net price and the Buyer's commission.
Bookings/Hotel/Rooms/RoomPrice/
PriceBreakdown/Price/
NetSpecified		1BooleanIndicates whether the net price is explicitly specified.
Bookings/Hotel/Rooms/RoomPrice/
PriceBreakdown/Price/
MinimumSellingPrice		1DoubleThe minimum selling price.
Bookings/Hotel/Rooms/RoomPrice/
PriceBreakdown/Start		1IntegerThe starting day of the pricing period (inclusive).
Bookings/Hotel/Rooms/RoomPrice/
PriceBreakdown/End		1IntegerThe ending day of the pricing period (inclusive).
Bookings/Hotel/Rooms/
Refundable		1BooleanIndicates if the room is refundable based on the cancellation policy.
Bookings/Hotel/Rooms/
RefundableSpecified		1BooleanIndicates whether the refundable status has been explicitly specified.
Bookings/Hotel/Rooms/
LegacyRoomId		1StringLegacy identifier for internal tracking. Automatically generated using OccupancyRefId and Code.
Bookings/Hotel/Rooms/Units0 . . 1IntegerNumber of units available for this room type.
Bookings/Hotel/Rooms/RatePlan0 . . 1RatePlanRate plan associated with this room.
Bookings/Hotel/Rooms/RatePlan/
Code		1StringThe unique code for the rate plan.
Bookings/Hotel/Rooms/RatePlan/
Name		0 . . 1StringThe name of the rate plan.
Bookings/Hotel/Rooms/
Promotions		0 . . NArray<Promotion>Promotions or discounts applicable to this room.
Bookings/Hotel/Rooms/
Promotions/Code		1StringThe unique code identifying the promotion.
Bookings/Hotel/Rooms/
Promotions/Name		0 . . 1StringThe name of the promotion.
Bookings/Hotel/Rooms/Remarks0 . . NArray<Remark>Additional remarks or notes about this room.
Bookings/Hotel/Rooms/Remarks/
RemarkType		1RemarkTypeThe 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.
Bookings/Hotel/Rooms/Remarks/
Text		1StringThe text content of the remark, providing details or additional notes.This can include supplier-specific instructions, conditions, or general information.
Bookings/Hotel/Rooms/
Surcharges		0 . . NArray<Surcharge>Additional surcharges applied to this room.
Bookings/Hotel/Rooms/
Surcharges/ChargeType		1ChargeTypeSpecifies whether the surcharge is included in the room rate or must be paid separately at the property. See ChargeType for possible values.
Bookings/Hotel/Rooms/
Surcharges/Mandatory		1BooleanIndicates 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.
Bookings/Hotel/Rooms/
Surcharges/Description		1StringProvides a description of the surcharge, giving context about the type of cost it represents.Examples: "Tourist Tax", "Resort Fee", or "Additional Bed Fee".
Bookings/Hotel/Rooms/
Surcharges/Price		1PriceRepresents the price of this surcharge, including the amount and currency. See Price for details about the price structure.
Bookings/Hotel/Rooms/
Surcharges/Price/Currency		1CurrencyThe currency of the price, represented in ISO 4217 format (e.g., USD, EUR).
Bookings/Hotel/Rooms/
Surcharges/Price/Binding		1BooleanIndicates whether the price is binding.
Bookings/Hotel/Rooms/
Surcharges/Price/Net		1DoubleThe net price paid by the Buyer to the Seller.
Bookings/Hotel/Rooms/
Surcharges/Price/Gross		1DoubleThe gross price, which includes the net price and the Buyer's commission.
Bookings/Hotel/Rooms/
Surcharges/Price/NetSpecified		1BooleanIndicates whether the net price is explicitly specified.
Bookings/Hotel/Rooms/
Surcharges/Price/
MinimumSellingPrice		1DoubleThe minimum selling price.
Bookings/Hotel/Rooms/
Surcharges/Code		0 . . 1StringAn 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.
Bookings/Hotel/Rooms/
CancelPolicy		0 . . 1CancelPolicyCancellation policy specific to this room.
Bookings/Hotel/Rooms/
CancelPolicy/Refundable		1BooleanIndicates whether the booking is refundable.
Bookings/Hotel/Rooms/
CancelPolicy/CancelPenalties		0 . . NArray<CancelPenalty>A collection of penalties that apply if the booking is canceled.
Bookings/Hotel/Rooms/
CancelPolicy/CancelPenalties/
HoursBefore		0 . . 1Integer[Deprecated] This field is deprecated. Use Deadline instead. Indicates the number of hours before the check-in date when the penalty becomes applicable.
Bookings/Hotel/Rooms/
CancelPolicy/CancelPenalties/
PenaltyType		1PenaltyTypeSpecifies the type of penalty enforced upon cancellation.
Bookings/Hotel/Rooms/
CancelPolicy/CancelPenalties/
Currency		1CurrencySpecifies the currency in which the penalty value is expressed.
Bookings/Hotel/Rooms/
CancelPolicy/CancelPenalties/
Value		1DoubleIndicates the value of the penalty.
Bookings/Hotel/Rooms/
CancelPolicy/CancelPenalties/
Deadline		1StringDate on UTC Standard TimeZone in which this cancellation policy applies (ISO 8601 UTC 2025-11-01T05:00:00Z)
Bookings/Hotel/Rooms/
CancelPolicy/
CancelPolicyDescription		0 . . 1StringProvides additional details or a textual summary of the cancellation policy.
Bookings/Hotel/Rooms/Beds0 . . 1Array<Bed>List of beds available in the room, including types and configurations.
Bookings/Hotel/Rooms/Beds/Type0 . . 1StringThe type of the bed.
Bookings/Hotel/Rooms/Beds/
Description		0 . . 1StringA description of the bed.
Bookings/Hotel/Rooms/Beds/
Count		0 . . 1IntegerThe number of beds of this type in the room.
Bookings/Hotel/Rooms/Beds/
Shared		0 . . 1BooleanIndicates whether the bed is shared.
Bookings/Hotel/Rooms/Amenities0 . . NArray<Amenity>Amenities included with this room, such as Wi-Fi or parking.
Bookings/Hotel/Rooms/Amenities/
Code		1StringA unique code that identifies the amenity.
Bookings/Hotel/Rooms/Amenities/
Type		1AmenityTypeThe type of the amenity, defined by AmenityType.
Bookings/Hotel/Rooms/Amenities/
Value		1StringThe value associated with the amenity.
Bookings/Hotel/Rooms/Amenities/
Texts		0 . . 1StringAdditional textual information or description for the amenity.
Bookings/Hotel/Rooms/
UnitsSpecified		1BooleanIndicates whether the number of units has been explicitly specified.
Bookings/Hotel/Rooms/Features0 . . NArray<Feature>Features or custom attributes of the room, used for specific integrations.
Bookings/Hotel/Rooms/Features/
Code		1StringThe unique code identifying the feature of the room.
Bookings/Price0 . . 1PriceThe total price of the booking.
Bookings/Price/Currency1CurrencyThe currency of the price, represented in ISO 4217 format (e.g., USD, EUR).
Bookings/Price/Binding1BooleanIndicates whether the price is binding.
Bookings/Price/Net1DoubleThe net price paid by the Buyer to the Seller.
Bookings/Price/Gross1DoubleThe gross price, which includes the net price and the Buyer's commission.
Bookings/Price/NetSpecified1BooleanIndicates whether the net price is explicitly specified.
Bookings/Price/
MinimumSellingPrice		1DoubleThe minimum selling price.
Bookings/CancelPolicy0 . . 1CancelPolicyThe cancellation policy associated with the booking.
Bookings/CancelPolicy/
Refundable		1BooleanIndicates whether the booking is refundable.
Bookings/CancelPolicy/
CancelPenalties		0 . . NArray<CancelPenalty>A collection of penalties that apply if the booking is canceled.
Bookings/CancelPolicy/
CancelPenalties/HoursBefore		0 . . 1Integer[Deprecated] This field is deprecated. Use Deadline instead. Indicates the number of hours before the check-in date when the penalty becomes applicable.
Bookings/CancelPolicy/
CancelPenalties/PenaltyType		1PenaltyTypeSpecifies the type of penalty enforced upon cancellation.
Bookings/CancelPolicy/
CancelPenalties/Currency		1CurrencySpecifies the currency in which the penalty value is expressed.
Bookings/CancelPolicy/
CancelPenalties/Value		1DoubleIndicates the value of the penalty.
Bookings/CancelPolicy/
CancelPenalties/Deadline		1StringDate on UTC Standard TimeZone in which this cancellation policy applies (ISO 8601 UTC 2025-11-01T05:00:00Z)
Bookings/CancelPolicy/
CancelPolicyDescription		0 . . 1StringProvides additional details or a textual summary of the cancellation policy.
Bookings/Remarks0 . . NArray<Remark>Additional remarks or notes related to the booking.
Bookings/Remarks/RemarkType1RemarkTypeThe 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.
Bookings/Remarks/Text1StringThe text content of the remark, providing details or additional notes.This can include supplier-specific instructions, conditions, or general information.
Bookings/BillingSupplierCode0 . . 1StringThe code of the agency responsible for the booking.
Bookings/Payable0 . . 1StringInformation about the entity responsible for payment of the booking.
Bookings/AddOns0 . . 1ObjectAdditional metadata provided by the supplier for internal use.
Parameters0 . . NArray<Parameter>A collection of parameters used to transfer data across different operations.
Parameters/Key1IntegerIdentifies the parameter with a numeric key.
Parameters/Value1StringDefines the value associated with the parameter.
Parameters/ParameterType1ParameterTypeSpecifies the type of the parameter (ParameterType), whether it is internal or supplier-related.
Parameters/Immutable1BooleanIndicates whether the parameter remains constant throughout operations (e.g., from Search to Quote and Book). In second searches or quotes, an immutable parameter is used to identify and match the same option.
Parameters/RoomId1IntegerAssociates the parameter with a specific room, identified by its ID.
AddOns0 . . 1ObjectAdditional metadata provided by the supplier for internal use.