Event API
Non-booking related purchases. (i.e. Mini-bar products, spa services, etc.)
Field
Validator
Note
Required
Dynamic
Secure
Type
Max64
Price
RegExMoney
Description
Max128
A reservation at a hotel for a specific date range
Field
Validator
Note
Required
Dynamic
Secure
HotelId
Max64
References HotelInfo.HotelId
Arrive
RegExDateOnly
Depart
RegExDateOnly
ConfirmationNumber
Max64
NumGuests
RegExNumeric2Max
Remark
Max1024
A combined representation of a hotel brand and booking info. Used by publishers that booked the reservation but are not the Hotel brand represented.
Field
Validator
Note
Required
Dynamic
Secure
LocationName
Max128
Example: Emerald Suites, O'Hare International Airport
Brand
Max64
Example: Emerald Suites
ConfirmationNumber
Max64
Arrive
RegExDateOnly
Depart
RegExDateOnly
AddressLine1
Max256
AddressLine2
Max256
City
Max64
Required when Coordinates not provided or Country=US
State
Max64
Required when Coordinates not provided or Country=US
PostalCode
RegExPostal
Country
RegExAlpha2
PhoneNumber
NumericExtras max: 32
Latitude
RegExLatLong
Address data or coordinates are required
Longitude
RegExLatLong
Address data or coordinates are required
Timezone
RegExTimezone
Remark
Max1024
Information about the total rooms in a reservation
Field
Validator
Note
Required
Dynamic
Secure
TotalNumberOfRooms
NumericOnly max: 3
Details related to a specific hotel reservation.
Field
Validator
Note
Required
Dynamic
Secure
RoomCode
Max64
RateCode
Max64
RoomDesc
Max256
BedConfig
Max64
CancelPolicy
Max256
GuaranteePolicy
Max256
Refundable
Boolean
NumGuests
RegExNumeric2Max
Deprecated, please provide on HotelBooking instead
Amounts related to a specific reservation cancellation.
Field
Validator
Note
Required
Dynamic
Secure
CancelReason
Max128
CancelPenalty
Boolean
CancelCharge
RegExMoney
CancelRefund
Boolean
RefundAmount
RegExMoney
Hotel check-in confirmation.
Field
Validator
Note
Required
Dynamic
Secure
LateRequest
Boolean
LateCheckInConfirm
Boolean
GuestCheckIn
Boolean
Hotel check-out confirmation.
Field
Validator
Note
Required
Dynamic
Secure
LateRequest
Boolean
LateCheckOutConfirm
Boolean
GuestCheckOut
Boolean
Information about a specific hotel.
Field
Validator
Note
Required
Dynamic
Secure
HotelId
Max64
Name
Max128
Brand
Max64
AddressLine1
Max256
AddressLine2
Max256
City
Max64
State
Max64
Required when Country=US or Latitude,Longitude is not present
PostalCode
RegExPostal
Required when Country=US or Latitude,Longitude is not present
Country
RegExAlpha2
PhoneNumber
NumericExtras max: 32
Email
RegExEmail max: 128
Latitude
RegExLatLong
Longitude
RegExLatLong
Timezone
RegExTimezone
Payment information for a specific reservation.
Field
Validator
Note
Required
Dynamic
Secure
Amount
RegExMoney
CreditCardLast4
RegExNumeric4
Check-in and check-out times for a specific hotel.
Field
Validator
Note
Required
Dynamic
Secure
HotelId
Max64
References HotelInfo.HotelId
CheckInTime
RegExTimeOnly
CheckOutTime
RegExTimeOnly
Field
Validator
Note
Required
Dynamic
Secure
PerNightRate
RegExMoney
TotalRoom
RegExMoney
Tax
RegExMoney
Total
RegExMoney
Fees
RegExMoney