The identity and technical contract details declared by the specification.
blockReservationStatistics
object
Response for BlockReservationStatisticsByDateAndRoomPool operation.
3 properties
blockReservationStatisticsByDateAndRoomPoolType
object
Statistics of block reservations summarized by date and room pools.
1 property
dailyStatsType
array
Statistics of one day.
dailyStatType
object
Statistics of one day.
2 properties
blockStatsType
array
Statistics of one block.
blockStatType
object
Statistics of one block.
2 properties
blockIdList
array
Unique Id that references an object uniquely in the system.
uniqueID_Type
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
3 properties
roomPoolStatsType
array
Statistics of one room pool.
roomPoolStatType
object
Statistics of one room pool.
4 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
2 required
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
registerCall
object
Request to register call. Either creates a new call or updates an existing call.
3 properties
callType
object
Holds call information.
11 properties
dateTimeSpanType
object
Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to…
2 properties
callerType
object
Holds caller information.
11 properties
reservationIdList
array
Unique Id that references an object uniquely in the system.
callStatistics
object
Response object to the request to retrieve Call Statistics.
3 properties
callStatisticsListType
array
Holds Call Statistics Information.
callStatisticsType
object
Holds Call Statistics Information.
6 properties
reservationsDetails
object
Response object to the Fetch Reservation Request operation. Based on the criteria, reservation information is returned.
4 properties
reservationInfoType
object
The Reservation class contains the current reservation being created or altered.
60 properties
externalReferencesType
array
This type contains unique information of external reference.
externalReferenceType
object
This type contains unique information of external reference.
3 properties
stayInfoType
object
Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaini…
46 properties
timeSpanType
object
Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to…
3 properties
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
reservationBlockType
object
Key information about the block for a reservation.
3 properties
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
promotionType
object
Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation. Note: For putReservation wh…
3 properties
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
28 properties
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
namePrefixType
string
Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
givenNameType
string
Given name, first name or names
surnameType
string
Family name, last name.
phoneNumberType
string
Phone number
basicEmailType
string
Email address
countryNameType
object
Used for Character Strings, length 0 to 200 - It indicates country/nationality description.
4 properties
vIPType
object
The supplier's ranking of the customer.
2 properties
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
anonymizationType
object
Provides information about guest's anonymization status.
1 property
anonymizationStatusType
string
Guest has been anonymized.
resAccompanyGuestListType
array
Collection of accompany guests
resAccompanyGuestInfoType
object
9 properties
profileIdList
array
Unique Id that references an object uniquely in the system.
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
resSharedGuestListType
array
Collection of shared guest reservations.
resSharedGuestInfoType
object
Contains information regarding the share reservation.
5 properties
profileId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
3 properties
resAttachedProfileListType
array
resAttachedProfileType
object
4 properties
resProfileTypeType
string
reservationPaymentMethodType
object
8 properties
resPaymentCardType
object
Information on a credit card for the customer.
19 properties
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
cardProcessingType
string
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 properties
emailType
object
Information on an email for the customer.
10 properties
reservationFolioWindowsType
array
Collection of reservation folio windows.
reservationFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
4 properties
payeeInfoType
object
Payee information.
3 properties
indicatorsType
array
Collection of lamp indicators.
indicatorType
object
Lamp indicator Type.
2 properties
housekeepingRoomStatusType
string
Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOf…
searchMatchesType
array
List of Generic Name-Value-Pair Parameters used for super search matches.
searchMatchType
object
Search match indicating attribute and the matching value.
2 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 properties
reservationQueueInformationType
object
Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
6 properties
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
6 properties
resCashieringType
object
Cashiering Information for the reservation.
12 properties
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
10 properties
billingPrivilegesType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
10 properties
reservationTaxTypeInfo
object
Provides information about the Tax Type.
3 properties
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
1 property
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
resCompAccountingType
object
Information regarding comp accounting on the reservation.
3 properties
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
8 properties
authorizerInfoType
object
Authorizer Information
5 properties
taxTypeType
object
Provides information about the Tax Type.
2 properties
reservationDepositType
object
Reservation Deposit Type.
7 properties
reservationAllowedActionsType
array
Allowed action.
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
resCommunicationType
object
Communication details for a reservation.
2 properties
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
telephoneType
object
Information on a telephone number for the customer.
11 properties
emailInfoType
object
Information on an email for the customer.
3 properties
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
4 properties
pMS_ResStatusType
string
This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
commissionPayoutToType
string
masterInfoType
object
2 properties
codeInfoType
object
3 properties
awardUpgrades
object
Response object for available award upgrades.
3 properties
awardUpgradeInfoType
object
8 properties
awardUpgradeSummariesType
array
Summary information related to award upgrade.
awardUpgradeSummaryType
object
9 properties
awardUpgradeDetailsType
array
Daily Details related to award upgrade.
awardUpgradeDetailType
object
3 properties
reservationAwards
object
Response of fetch awards for a reservation.
3 properties
awardsType
array
List of awards.
awardType
object
Detailed information of the awards.
32 properties
awardKindType
string
Indicates that this is electronic certificate.
reservationCertificateType
string
Certificate is incentive.
rewardCertificateType
string
Point Saver reward.
awardStatusType
string
Indicates that certificate is in use.
reservationId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
4 properties
createReservation
object
Request object to create reservations. Includes instructions for information which needs to be returned.
8 properties
hotelReservationsType
object
A collection of Reservation objects and Unique IDs of Reservation.
4 properties
hotelReservationType
object
The Reservation class contains the current reservation being created or altered.
110 properties
roomStayType
object
28 properties
currentRoomInfoType
object
Room information of the reservation for the current day.
8 properties
reservationRoomOwnershipType
string
Indicates if the assigned reservation room is an Owner/Referral or Regular room.
roomRateType
object
52 properties
totalType
object
The total amount charged for the service including additional amounts and fees.
13 properties
taxesType
object
A collection of taxes.
4 properties
taxType
object
Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should…
6 properties
amountDeterminationType
string
Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.
ratesType
object
Individual rate amount.
1 property
amountType
object
Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentage…
9 properties
discountType
object
Identifies and provides details about the discount. This allows for both percentages and flat amounts. If one field is used, the other should be zero/not speci…
5 properties
shareDistributionInstructionType
string
The type of Rate Amount Change to be done on the Sharer reservation. This can be FULL - Full Rate for each Sharer. SPLIT- Split the Rate amount between Sharer…
packageElementType
object
15 properties
reservationProfileType
object
4 properties
profileType
object
Type provides the detailed information about the profile and its children.
39 properties
customerType
object
Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
16 properties
personNameType
object
This provides name information for a person.
8 properties
personNameTypeType
string
Person's name in an external system.
identificationInfoType
object
Information on the identification of the customer.
3 properties
identificationType
object
Identification information of the customer.
10 properties
companyType
object
14 properties
imageSetType
object
Represents on image set record.
6 properties
imageStyleType
string
An enumeration of image styles.
addressInfoType
object
Provides address information.
3 properties
addressType
object
Provides address information.
18 properties
uRLInfoType
object
Web site address.
3 properties
uRLType
object
Web site address, in IETF(The Internet Engineering Task Force) specified format.
5 properties
commentInfoType
object
Comment related to the profile/reservation.
8 properties
commentType
object
An indication of a new paragraph for a sub-section of a formatted text message.
13 properties
formattedTextTextType
object
Provides text and indicates whether it is formatted or not.
2 properties
profileDeliveryMethod
object
Delivery Information type to the profile.
7 properties
profileDeliveryModuleType
string
Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..
profileMembershipType
object
Detailed information of the memberships.
40 properties
paragraphType
object
An indication of a new paragraph for a sub-section of a formatted text message.
1 property
membershipEarningPreferenceType
string
The earning preference of a membership, it depends on the type of property. eg. when the property is a airline it should be Miles, other than Points.
benefitsType
array
Basic information about membership benefit.
benefitType
object
Basic information about membership benefit.
3 properties
tierAdministrationType
string
Do not upgrade membership. The membership may be downgraded.
downgradeType
string
Do not downgrade membership when the next downgrade process runs. When the downgrade process runs, the membership will be automatically set to Grace.
cardReIssueType
string
Request to re issue a new card.
preferenceTypeType
object
Preference details for the profile.
12 properties
preferenceType
object
Guest Preference details for the profile.
8 properties
relationshipInfoType
object
Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.
6 properties
relationshipProfileType
object
12 properties
ownerType
object
Generic type for information about an owner.
11 properties
codeDescriptionType
object
This contains a generic code and description information.
2 properties
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
profileTypeType
string
The types of Profile handled by the web service.
relationshipInfoSummaryType
object
RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact p…
7 properties
relationshipProfileSummaryType
object
11 properties
relationshipAddressType
object
Provides address information for a Relationship.
5 properties
masterAccountInfoType
object
reservationHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
historyListType
object
A collection of reservation history details attached to Profiles.
4 properties
futureListType
object
A collection of reservation history details attached to Profiles.
4 properties
reservationStayHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
stayHistoryListType
object
A collection of reservation history details attached to Profiles.
4 properties
stayReservationInfoType
object
The Reservation class contains the current reservation being created or altered.
6 properties
stayFutureListType
object
A collection of reservation history details attached to Profiles.
4 properties
lastStayInfoType
object
Contains last stay related details for the profile
2 properties
profileRestrictions
object
3 properties
profileCashieringType
object
Contains cashiering related details for the profile
3 properties
profileCommissionType
object
This is the preconfigured routing instruction type.
7 properties
commissionPaymentMethods
string
Check
userDefinedFieldsType
object
A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc.
3 properties
characterUDFsType
array
Used to hold collection of user defined fields of Character/String Type.
characterUDFType
object
Used to hold user defined field of Character/String Type.
3 properties
numericUDFsType
array
Used to hold collection of user defined fields of Numeric Type.
numericUDFType
object
Used to hold user defined field of Numeric Type. It is highly recommended to use UDFN01, UDFN02,...UDFN40 (Total 40) as Numeric UDF names(commonly used on Rese…
3 properties
dateUDFsType
array
Used to hold collection of user defined fields of Date Type.
dateUDFType
object
Used to hold user defined field of Date Type.
3 properties
eCertificatesType
array
List of e-certificates for the profile.
eCertificateType
object
E-Certificates details.
10 properties
eCertificateInfoType
object
E-Certificates details.
12 properties
eCertificateScopeType
string
Indicates that OPERA E-Certificate is available for a specific list of hotels.
eCertificateConsumptionType
object
E-Certificates details.
9 properties
eCertificateConsumeSourceType
string
Indicates that OPERA E-Certificate is consumed by hotelPMS.
eCertificateStatusType
string
Indicates that OPERA E-Certificate is reserved.
eCertificateIssueSourceType
string
Indicates that OPERA E-Certificate is issued by external system.
roomOwnershipType
object
Define the search criteria for retrieving room ownership records
9 properties
guestCountsType
object
A collection of GuestCount by age group.
4 properties
childAgesType
array
Age of a child in years.
childAgeType
object
Defines Child's Age.
1 property
childBucketsType
object
Defines children counts with Age Qualifying Group(Child Bucket) classification.
5 properties
resAwardsType
object
Membership Awards code applied on the reservation.
3 properties
upsellInfoType
object
Information regarding upsell for a reservation.
2 properties
primaryShareTypeType
string
compAuthorizerInfoType
object
Authorizer Information
3 properties
resGuestType
object
A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGu…
6 properties
profileCashieringDetailType
object
The type contains routing instructions for the profile.
5 properties
profileRoutingInstructionsType
object
The type contains routing instructions for the profile.
3 properties
trxCodesInfoType
array
List of Transaction codes info.
trxInfoType
object
Transaction codes info.
6 properties
billingInstructionsType
array
Set of Billing Instruction codes.
billingInstructionType
object
Configured Billing Instruction which represents a set of Transaction Codes.
3 properties
transportInfoType
object
7 properties
visaInfoType
object
3 properties
resGuestAdditionalInfoType
object
8 properties
trackItItemType
object
Detailed information of a Track It item.
14 properties
trackItId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
trackItGroup
string
Group to which the Track It items belong.
trackItType
object
Identifies the kind of Parcel, Baggage, or Lost items or Valet-managed vehicles or services.
2 properties
trackItActionType
object
Identifies the response expected from staff or other parties relative to a Track It ticket.
2 properties
actionStatusType
string
Action status of the Track It item(Open, Closed).
applicationUserType
object
18 properties
employeeInfoType
object
9 properties
userSessionInfoType
object
11 properties
userSessionDefaultsType
object
9 properties
parametersType
array
Collection of generic Name-Value-Pair parameters.
parameterType
object
Name value pair type that will hold generic parameter information. Only use this type when the parameters being passed are too dynamic to be defined.
2 properties
attendantType
object
2 properties
trackItReservationInfoType
object
Reservation info associated with a Track It item.
9 properties
trackItLogType
object
Individual activity log related to the Track It ticket.
9 properties
reservationLocatorsType
array
Holds the Locator Information.
reservationLocatorType
object
Holds the information for a Reservation Guest Locator
6 properties
dateRangeType
object
Date Range with Start and End dates.
2 properties
attachmentsType
array
Attachment List.
attachmentType
object
Attached files.
12 properties
dateTimeStampGroupType
object
5 properties
serviceRequests
array
Service request.
serviceRequest
object
Service request.
11 properties
serviceRequestStatusType
string
activityLookUpList
array
Criteria for fetching Activity Bookings.
fetchActivityBookingsType
object
Used in the request message to describe the "filtering Criteria" when executing an activity lookup.
5 properties
activityList
array
A collection of Activity objects.
prepaidCardsType
array
Holds fixed charge detail.
prepaidCardType
object
Holds fixed charge information.
15 properties
reservationPackageType
object
A ReservationPackageType class.
13 properties
packageCodeHeaderType
object
3 properties
configPackagePrimaryDetailsType
object
A Config Package Info type.
7 properties
configPackageTransactionType
object
A HotelPackageTransaction type.
4 properties
configPostingAttributesType
object
A config Package posting attributes type.
14 properties
packagePostingRhythmType
object
Package Posting rhythm type.
5 properties
postingRhythmType
string
Simple type for posting Rhythm types.
packageCalculationRuleType
string
Simple type for package caluculation rules.
pkgInventoryItemType
object
4 properties
reservationPackageScheduleType
object
A HotelPackageSchedule type.
21 properties
packageConsumptionType
object
Package Consumption Information. Includes information on quantity of the package used, allowance consumption etc.
4 properties
productSourceType
string
Sources of Products
resInventoryItemsType
object
Defines a collection of inventory items attached to a reservation.
2 properties
resInventoryItemType
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
10 properties
itemInfoType
object
Basic information regarding an Item.
15 properties
timeWindowType
object
Defines a Time period with start time and an end time.
2 properties
resInventoryItemSourceType
object
Defines whether the item is setup due to a Rate Plan, Package or a Block.
5 properties
blockId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
membershipType
object
Detailed information of the memberships.
41 properties
reservationMembershipType
object
Detailed information of the memberships.
43 properties
reservationPaymentMethodsType
array
Defines reservation payment methods.
routingInfoListType
array
A routing info object can either be of type Folio OR of type Room with its corresponding instructions.
routingInfoType
object
A routing info object can either be of type Folio OR of type Room with its corresponding object.
5 properties
routingInstructionType
object
Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit
8 properties
compAccountingType
object
Authorizer Information
12 properties
compRoutingRequestType
object
Type for the details of a Comp Routing Request
4 properties
userInfoType
object
Opera User Information
2 properties
compRoutingStatusType
string
Status which indicates that the Request of Comp Routing was declined
reservationPoliciesType
object
A collection of reservation deposit and cancellation policies.
4 properties
resCancellationPoliciesType
array
A list of reservation cancellation policies.
resCancellationPolicyType
object
A cancellation policy attached with the reservation.
5 properties
depositCancelRevenueType
string
The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.
resCancelPenaltyType
object
The CancelPenalty class defines the cancellation policy of the hotel facility.
9 properties
policyDeadlineType
object
Cancellation deadline, absolute or relative.
4 properties
policyAmountPercentType
object
Defines the percentage basis for calculating the fee amount or the amount.
5 properties
policyBasisTypeType
string
Full Amount.
offsetUnitType
string
Indicates deadline offset unit type.
resDepositPoliciesType
array
A list of deposit policies attached with the reservation.
resDepositPolicyType
object
A deposit policy attached with the reservation.
6 properties
depositPolicyType
object
Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.
10 properties
linkedReservationsInfoType
object
Linked Reservations.
8 properties
linkedReservationInfoType
object
27 properties
linkedReservationType
string
Enumeration of the different Linked Reservation Types.
cateringResInfoType
object
Information regarding catering event and catering revenue type associated to the reservation.
2 properties
eventId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
alertsType
array
List of alerts.
alertType
object
24 properties
alertGuestInfoType
object
13 properties
vIPStatusType
object
VIP status of the customer.
2 properties
welcomeOfferType
object
2 properties
welcomeOfferOptionsType
string
None of the Welcome Offer option is selected.
hotelReservationTracesType
array
List of Reservation Traces.
hotelReservationTraceType
object
Extended Trace object to hold information for a reservation.
18 properties
traceTimeInfoType
object
4 properties
traceResolveType
object
2 properties
confirmationsType
array
List of confirmation letters.
confirmationType
object
10 properties
confRecipientInfoType
object
8 properties
profileNameType
object
This provides name information for a person.
7 properties
confDeliveryInfoTypes
array
List of confirmation letter delivery methods and their status
confDeliveryInfoType
object
4 properties
confDeliveryMethod
string
sentConfirmationStatus
string
confirmationStyle
object
7 properties
callHistoryType
array
Holds call information.
fixedChargesType
array
Holds fixed charge detail.
fixedChargeType
object
Holds fixed charge information.
8 properties
fixedChargeScheduleType
object
Holds schedule of fixed charge.
5 properties
fixedChargeFrequencyType
string
Yearly.
fixedChargeDetailType
object
Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.
7 properties
guestMessagesType
array
Holds the Message Information
guestMessageType
object
Holds the Message information for a Reservation
12 properties
messageType
object
Holds the Message Information
5 properties
typeOfMessageType
string
The type of Message for Guest Messages.
messageDeliveryType
object
Holds the Delivery Information of the Message
8 properties
messageStatusType
string
Status of the Message.
overrideInstructionsType
array
List of override actions done.
overrideInstructionType
object
Type for Overrides. Contains information for the override action performed while booking a reservation.
6 properties
eCouponsType
array
Collection of ECouponType object.
eCouponType
object
Reservation eCoupon Type Information.
9 properties
reservationTransactionDiversionsType
array
List of Transaction Diversion rules.
reservationTransactionDiversionType
object
A Transaction Diversion Rule Type
16 properties
membershipTypeLevelType
object
2 properties
transactionDiversionRuleLevelType
string
Reservation level.
thresholdDetailsType
object
Type for the threshold elements.
5 properties
entityType
string
Indicates the rule is based on Minutes associated with the charge.
scopeType
string
Minimum required and complimentary values are applicable Per Stay.
transactionDiversionRuleTypeType
string
The rule type on which the Transaction Diversion Rule is based. If a reservation has any of the following code, Transaction Diversion rule gets active for that…
transactionDiversionDailyDetailsType
array
List of daily details for Transaction Diversion rule.
transactionDiversionDailyDetailType
object
List of daily details for Transaction Diversion rule.
3 properties
ticketsType
array
Collection of TicketType objects.
ticketType
object
Reservation Ticket Type Information.
13 properties
reservationECertificatesType
array
Collection of ECertificateType object.
reservationECertificateType
object
Reservation ECertificate Type Information.
3 properties
eCertificateClassficationType
string
Enumeration of the different type of Ecertificate.
nameValueDetailType
object
Detailed information returned during name value search.
1 property
nameValuesType
array
List of name value pairs.
nameValueType
object
Contains name value pair.
6 properties
nameValueDataTypeType
string
nameValueOriginType
object
Contains origin details.
4 properties
nameValueModuleType
string
customChargeExemptionsType
array
List of Custom Charge Exemptions.
customChargeExemptionType
object
Contains custom charges exemption information.
6 properties
customChargeQuantityType
object
Contains quantity of custom charge exemptions.
3 properties
customChargeExemptionDatesType
array
Contains List of Custom Charge Exemption information for a day.
customChargeExemptionDateType
object
Contains Custom Charge Exemption information for a day.
3 properties
excludedDatesType
array
Contains list of dates which are valid for custom charge exemptions.
excludedDateType
object
Specifies all the enabled dates.
2 properties
exclusionReasonType
string
Custom Charge has already been Processed for this date within the reservation stay.
foliosShortInfoType
array
This type contains a list of generated bills for a reservation.
folioShortInfoType
object
This type contains information of generated bills.
3 properties
reservationInstructionType
string
Simple type for reservation instructions that can be used in requests for information which needs to be returned.
reservationsInstructionsType
object
Instructions for a reservation.
3 properties
linkReservationInstructionType
object
Instructions for a linked reservation.
3 properties
shareReservationInstructionType
object
5 properties
effectiveRatesType
array
Collection of effective rate amount per guest on specific dates.
effectiveRateType
object
Effective rate amount per guest on specific dates.
22 properties
rateByAgeBucketsType
array
Rate amount by age bucket.
rateByAgeBucketType
object
Rate amount by age bucket.
3 properties
shareTypeType
string
Indicates that only profile information will be retrieved from the reservation request object and the rest will be provided from the master reservation.
channelResvRQInfoType
object
Holds all the channel reservation specific information.
3 properties
channelSummaryInfoType
object
Depicts channel information such as the type and code.
1 property
bookingChannelType
object
2 properties
channelResvActionType
string
Cancel a reservation in OPERA through a channel. The cancellation of the reservation is committed in OPERA at once. There is no session reservation involved.
status
object
Response Body.
2 properties
reservationCancellationPolicyCriteria
object
Request type to create a cancellation policy for a reservation.
3 properties
reservationCancellationPolicyCriteriaType
object
A cancellation policy attached with the reservation.
7 properties
reservationConfirmationLetters
object
Response object to the request to fetch a list of reservations for which confirmation letters need to be sent.
3 properties
reservationConfLettersListType
array
Reservations information and the confirmation letters type attached with them.
reservationConfLettersType
object
Reservation information and the confirmation letters type attached with it.
2 properties
confirmationLetters
object
Request object to create a confirmation letter.
6 properties
codeType
string
Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
responseInstructionsType
string
Enumeration of the different return modes of a response.
confirmationLettersDetails
object
Response object after creating a confirmation letter.
6 properties
reservationDepositPolicyCriteria
object
Request type to create a deposit policy on a reservation.
3 properties
reservationDepositPolicyCriteriaType
object
A deposit policy attached with the reservation.
8 properties
changeDepositPolicyDetails
object
Response Body.
2 properties
linkReservationsCriteria
object
Request to link a list of reservations with another existing reservation.
6 properties
reservation
object
Return object to the request for information regarding a reservation.
5 properties
reservationChannelInfoType
object
Holds all the channel reservation specific information.
3 properties
channelResvStatusType
string
Depicts that the operation was failed.
changeReservation
object
Request method to change a reservations information.
6 properties
hotelReservationInstructionType
object
The Reservation class contains the current reservation being created or altered.
106 properties
associatedResType
object
Information regarding associated reservations to the reservation.
resStatClassificationType
object
Statistical Classification information for the reservation.
2 properties
changeInstructionType
object
Instructions for Changing a Reservation.
7 properties
facilitySchedulerOptionType
string
Facility Scheduler Option value.
changeReservationDetails
object
5 properties
channelResvRSInfoType
object
Holds all the channel reservation specific information.
5 properties
channelMarketingInfoType
array
Marketing Text like cancel policy, deposit policy etc.
marketingPolicyType
string
Indicates the channel policy type like deposit,cancel etc.
reinstateReservation
object
Overriding the validation check will log the supposed errors in the warnings log if they would fail.
12 properties
reinstateReservationDetails
object
Response Body.
2 properties
cancelReservation
object
Request object for canceling reservations.
10 properties
rateChangeInstructionType
object
Defines override rate type.
2 properties
rateChangeType
string
Simple type for rate change type.
cancellationReasonType
object
2 properties
cancelReservationType
object
The Reservation class contains the current reservation being created or altered.
56 properties
reservationInterfaceStatusType
object
Hotel Interface Type for a reservation and status of the various services
3 properties
hotelInterfaceType
object
8 properties
hotelInterfaceTypeType
string
XML Posting Interface
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
interfaceRightsStatusType
object
4 properties
reservationTurndownInfoType
object
Turndown information for a reservation
2 properties
turndownStatusType
string
Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Complet…
cancellationInstructionsType
object
3 properties
cancelReservationDetails
object
Response object for the request to cancel reservations. Response contains the reservations which were successfully canceled.
9 properties
cancellationActivityType
object
5 properties
dailyRatesType
array
Defines room rate information on a daily basis.
dailyRateType
object
The total amount charged for the service including additional amounts and fees.
13 properties
reservationRoutingCriteria
object
Request to create a routing instruction.
3 properties
resvRoutingCriteriaType
object
A routing info object can either be of type Folio OR of type Room with its corresponding object.
8 properties
routingInstructionsInfo
object
Request when changing a routing instruction.
3 properties
shareReservations
object
Response for the fetch share reservation request. This returns all sharer reservations including the request reservation.
3 properties
combineShareReservations
object
Request to combine sharer reservations. This request requires a Reservation Name Id(Joining to) and a Joining Reservation Id
4 properties
combineShareReservationsType
object
Record Type for Combining Share Reservations.
9 properties
combineShareInstructionType
object
Instructions for overriding checks during combine share operation.
7 properties
combineShareFromProfilesType
array
Type for the profile information to create a new share reservation. This is used to create sharers from profiles.
combineShareFromProfileType
object
Type for the profile information to create a new share reservation. This is used to create sharers from profiles.
8 properties
copyReservationPaymentMethodsType
object
A collection of Reservation Payment Methods.
3 properties
combineShareReservationsDetails
object
Response for the combine share reservation request. Based on the request, this will return all sharer reservations including the request reservation.
6 properties
deliveryHistoryLog
object
Response that contains fetched reservation's delivery history.
3 properties
deliveryHistoryType
object
14 properties
deliveryMethodType
string
PRINT
statusType
string
Status of the batch process.
guestMessages
object
Response object to the request to retrieve Guest Messages for a Reservation.
8 properties
resvGuestMessagesType
array
Holds the Message Information
resvGuestMessageType
object
List of Guest Messages
13 properties
resvMessageType
object
Holds the Message Information
18 properties
extendReservationLock
object
Operation for extending the lifetime of a lock on a reservation.
5 properties
extendReservationLockDetails
object
This response will indicate whether or not the extension was successful. This operation may return errors when the lock being requested to be extended no longe…
3 properties
operaRecordLock
object
This type contains information about a record lock.
8 properties
operaLockRecordType
string
preArrivalMemberReservationsDetails
object
3 properties
preArrivalMemberReservationType
object
4 properties
preConfiguredRoutingInstructions
object
This is the Response Message to the request for Pre-Configured Routing Instructions.
3 properties
preConfiguredRoutingInstrListType
array
Set of Pre-Configured Routing Instructions.
preConfiguredRoutingInstrType
object
Routing can be promotion code complimentary routing or profile routing.
8 properties
promoCodeCompRoutingType
object
Promotion Code Complimentary Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit
11 properties
fetchReservations
object
4 properties
validateRateInfo
object
Retrieve either the reservation's rate information or make a quotation for a rate information. SummaryInfo attribute specifies if the item being requested is o…
2 properties
rateInfo
object
Response will either be Summary or Detail type, but not both. See the request for the summary attribute flag.
4 properties
reservationRateSummaryType
object
13 properties
reservationRateSummaryDetailType
object
12 properties
activityLog
object
Response object for the request for the reservation user activity log.
3 properties
activityLogListType
object
7 properties
activityLogType
object
12 properties
reservationAlerts
object
Request object to create or update multiple alerts information for multiple reservations in bulk.
3 properties
reservationAlertsListType
array
Holds multiple alerts for a single reservation. Reservation will be identified by a unique identifier/ list of unique identifiers.
reservationAlertsType
object
Hold the multiple alerts for a single reservation which is identified by a unique identifier.
3 properties
cancelReservations
object
Request to submit batch cancel reservations.
3 properties
cancelReservationsType
object
Criteria for submitting batch cancel reservations.
4 properties
reservations
array
Unique identifier for a reservation.
cancelReservationsInstructionsType
object
The instructions to be applied for the reservations that are being cancelled.
4 properties
validateReservationChanges
object
Request to validate reservation changes.
5 properties
reservationValidationInstructionType
string
Instruction to validate CompRouting Instructions attached to a reservation.
upsellRateInstructionType
string
Instruction to remove the upsell and recalculate the rate based on the upsell target room type.
validateReservationChangesDetails
object
Response for validating reservation changes.
5 properties
validationsReturnType
array
validationReturnType
object
Validations type record returned after Validations are done.
5 properties
validationActionType
string
Validation Actions returned after validations are done. STOP-PROCESSING implies that the user cannot continue with the operation as some validation failed. USE…
reservationSummaryListType
array
List of Reservations.
reservationSummaryType
object
5 properties
guaranteePolicyType
object
Specifies Guarantee Code attributes.
12 properties
guaranteeRequirementsType
object
Specifies various requirement for the guarantee code.
10 properties
translationTextType80
object
Contains Multiple translated texts and language codes.
2 properties
translationsTextType
array
Language code for the translation.
paymentTypesType
array
Payment card code like AX,VI etc.
alerts
object
Response with the fetched alerts, includes global alerts, notes and undelivered guest messages.
5 properties
reservationAttachments
object
Return object to the request for information regarding reservation attachments.
3 properties
breakShareValidations
object
Request for Break Share operation validations. This request should be done prior to the actual Break Share operation request. Based on the validations returned…
4 properties
breakShareValidationsDetails
object
Response for the Break Share Validation request. This returns all validation messages for the operation.
3 properties
callHistory
object
Response that contains either the fetched call history if was successful or error(s) if not.
3 properties
cancellationHistory
object
Response object to the request to retrieve cancellation history for a reservation.
3 properties
computeCancellationPolicies
object
Operation to fetch the details for cancellation rules, applicable to a reservation. Based on the criteria the rule information can be retrieved for all cancell…
3 properties
computeCancellationPoliciesDetails
object
Response for the cancellation rules configuration request. Contains computed details for the cancellation rules requested.
3 properties
attachCertificate
object
Request to attach certificate to the Reservation.
3 properties
combineShareValidations
object
Request to validate a combine share operation. This would be done prior to the actual Combine Share operation. Based on the validations returned from this requ…
6 properties
combineShareValidationsDetails
object
Response for the Combine Share Validation request. This returns all validation messages which may be required for the combine share operation.
3 properties
copyReservation
object
Request for copying a reservation's information as a template for a new reservation.
3 properties
copyReservationType
object
4 properties
reservationDailyRateDetail
object
Request for validating Daily Rate Details modifications.
5 properties
dailyRateDetailType
object
Rate details for the different dates of a reservation.
15 properties
promotionsType
array
Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.
reservationDailyRateDetailDetails
object
Response after validating the changes for Daily Rate Details modifications.
4 properties
computeDepositPolicies
object
Operation to fetch the details for deposit rules, applicable to a reservation. Based on the criteria the rule information can be retrieved for all deposit rule…
3 properties
depositCancelConfigCriteriaType
object
Criteria for calculating the deposit/cancellation amount based on a reservation, policy code, amount or percentage.
7 properties
computeDepositPoliciesDetails
object
Response for the deposit rules configuration request. Contains computed details for the deposit rules requested.
3 properties
eCoupons
object
Response object for fetching the eCoupons attached to Reservation.
3 properties
eCouponsInfo
object
Request object for changing the existing eCoupons attached to Reservation.
5 properties
reservationLocators
object
Response object response to retrieve Guest Messages for a Reservation.
3 properties
reservationLocatorsDetailsInfo
object
Request object for creating new Notes for the hotels
5 properties
reservationLocatorsDetails
object
Response object for creating new Notes for the hotel.
3 properties
reservationLocatorsInfo
object
Request object for changing hotel Notes for hotels.
5 properties
reservationLocatorsStatus
object
Response Body.
2 properties
createGuestMessages
object
Request object for creating the Guest Messages for a Reservation.
5 properties
guestMessagesDetails
object
Response object to the request to create Guest Messages for a Reservation.
3 properties
changeResvGuestMessages
object
Request object for updating the Guest Messages for a Reservation Workspace.
4 properties
changeGuestMessages
object
Request object for updating the Guest Messages for a Reservation.
5 properties
inventoryItems
object
Return object to the request for information regarding inventory Items reserved for a reservation.
3 properties
reserveInventoryItems
object
Request object to reserve inventory Items for a reservation.
6 properties
itemHoldIDListType
array
ID of an Hold Item
reservedInventoryItemsInfo
object
Request object to change the reserved inventory Items for a reservation.
5 properties
linkedHotelReservations
object
Return object for retrieving linked reservations.
3 properties
linkedHotelReservationsType
object
A collection of Linked Reservation objects and Unique IDs of Reservation.
4 properties
linkedHotelReservationType
object
The Reservation class contains the current reservation being created or altered.
96 properties
linkedReservationsInfo
object
3 properties
reservationLock
object
Operation for requesting a lock on a reservation.
6 properties
reservationLockDetails
object
This response will indicate whether the requested lock has been granted or some other user owns the lock.
4 properties
masterAccount
object
Request for CreateMasterAccount operation.
3 properties
masterAccountType
object
Details of the posting master reservation.
13 properties
masterAccountSummary
object
Response for ChangeMasterAccount operation.
3 properties
masterAccountSummaryType
object
Minimal information of the posting master reservation that can be used to identify the reservation uniquely.
7 properties
reservationsToMerge
object
Request method to Merge reservations.
5 properties
mergeReservationsStatus
object
Response Body.
2 properties
moveReservationHotel
object
Request for moving a reservation and its valid sharers to a different hotel.
3 properties
moveReservationHotelCriteriaType
object
7 properties
moveReservationHotelDetails
object
This API will potentially remove the following information to a moved reservation: - Routing Instructions - All routing information will have to be configured…
3 properties
packages
object
Response to fetch package availability with the data, success and warnings or errors.
3 properties
reservationPackagesInfo
object
Request method to attach a package to an existing reservation.
5 properties
reservationPaymentMethods
object
Method to create a reservation's payment methods.
5 properties
reservationPolicies
object
Response that contains deposit and cancellation policies attached with the reservation.
4 properties
preCheckInReservation
object
Request to pre-register a reservation eligible for pre-registration and change arrival details.
4 properties
reservationPreCheckInDetailsType
object
Type describing the different details regarding a pre-registered reservation including ID.
3 properties
preCheckInDetailsType
object
Type describing the different details regarding a pre-registered reservation.
6 properties
reservationArrivalInfoType
object
Type describing information regarding the arrival of a reservation.
1 property
reservationPreference
object
Response for the reservation's preferences.
3 properties
reservationPreferenceInfo
object
Method to change a reservation preference on an existing reservation.
5 properties
reservationPreferenceDetails
object
Response Body.
2 properties
reverseDepositPolicy
object
Request type to reverse deposit policy of a reservation.(This is applicable only when advance deposit handling is set to '17') ReverseDepositPolicy operation w…
3 properties
reservationReversePolicyCriteriaType
object
Reverse policy information of a reservation.
3 properties
routingInstructions
object
Response object containing routing instructions for a reservation.
3 properties
changeShareRateAmount
object
Request to change the share amount for a sharer reservation. The amount change type can be Full, Entire or Split
4 properties
changeShareRateAmountType
object
Type for changing the Rate Amount of a Sharer.
3 properties
shareDistributionCriteria
object
Extended Reservation object to hold additional instructions along with the reservation. This should be used for updates on the reservation.
2 properties
shareReservationsType
array
shareReservationType
object
2 properties
changeSharingGuests
object
Request to change Sharing Reservations Guest Counts(adults or children) information.
3 properties
sharingGuestType
object
The Reservation class contains the current reservation with the guest counts(adults or children).
3 properties
overlappingStay
object
Request to check for overlapping stays of reservations.
3 properties
overlappingStayInfoListType
array
Overlapping stay information of a reservation.
overlappingStayInfoType
object
Possible overlapping stay information of a reservation.
6 properties
overlappingStayDetails
object
Response for checking overlapping stays of reservations.
3 properties
tickets
object
Common tickets request base type.
3 properties
ticketsInfo
object
Common tickets request base type.
5 properties
traces
object
Return object to the request for information regarding traces.
3 properties
transactionDiversions
object
Response to fetch the transaction diversion rules attached to a reservation.
3 properties
transactionDiversionsInfo
object
Request to modify transaction diversion rules attached to a reservation.
5 properties
transactionDiversionsDetails
object
Response Body.
2 properties
reservationsUpgradeEligibility
object
Request object containing a list of reservation name ids, hotel code and eligibility flag.
3 properties
upgradeEligibilityListType
array
List of upgrade Eligibility Types.
upgradeEligibilityType
object
Reservation name ids, hotel code and eligibility flag.
3 properties
upgradeElgibilityStatusType
string
Simple type for upgrade eligibility status.
reservationsUpgradeEligibilityDetails
object
Response Body.
2 properties
upsellReservation
object
Request to upsell a reservation.
6 properties
upsellType
object
Holds upsell information
10 properties
roomTypeInfoType
object
20 properties
roomFeaturesType
array
A recurring element that identifies the room features.
roomFeatureType
object
Room Feature Information.
4 properties
roomTypeAttributesType
object
Attributes of property room type.
6 properties
bookingChannelMappingType
object
4 properties
bedTypeInfoType
object
Information representing Bed type associated with a room type.
2 properties
translationTextType2000
object
Contains Multiple translated texts and language codes.
2 properties
amountPointsType
object
Holds monetary value expressed with a currency code / number of points
2 properties
upsellDailyRatesType
array
Reservation date and its corresponding upsell rate amount
upsellDailyRateType
object
Reservation date and its corresponding upsell rate amount
2 properties
reservationUpsellInfo
object
Response object to the that contains information for a reservation prior to upgrade.
3 properties
roomCalendar
object
3 properties
roomCalendarType
object
Room Calendar entry that holds Room and Reservation Information.
5 properties
roomCalendarInfoType
object
Holds hotel Room and Reservation Information.
9 properties
roomInfo
object
Room details
6 properties
roomScheduleType
object
Holds TimeSpan and Reservation Information.
6 properties
roomCalendarResType
object
Reservation Information for a Reservation Item in the Calendar.
21 properties
roomCalendarDisplayType
object
Display Information for the Room Calendar.
2 properties
roomMoveDetailsType
array
List of room move details
roomMoveDetailType
object
Room move history information.
8 properties
roomScheduleCategoryType
string
Enumeration of the different Room Schedule Types.
componentBlockOutDates
object
2 properties
script
object
Script for a Reservation based on its StayDetails as well as itinerary.
3 properties
fetchSellMessageConfig
object
This is the fetch response message type for fetch operation of sell messages.
3 properties
sellMessageConfigsType
object
The SellMessageConfigsType is the list of sell messages, each comprising of all the sell message attributes and other details.
4 properties
sellMessageConfigType
object
Only one of the following can hold a value: HotelCode, CROCode or ChainCode
19 properties
usedInModuleType
string
Simple type for indicating the module for which user wants to create the SellMessage. Valid module types are Look To Book Sales,Reservations,Blocks,Function Di…
sellMessageConfig
object
This is the request message type for sell message update operation.
3 properties
registerTurnaway
object
Request to register turn away reservation.
4 properties
turnawayType
object
Holds information related to prospect reservation to be turned away.
6 properties
turnawayDetailsType
object
Holds detailed information of a prospect reservation to be turned away.
9 properties
futureReservationsOrBlocksDetails
object
This is the Response Message to information regarding existence of future reservation or business blocks.
3 properties
recentlyAccessedReservations
object
Response with the fetched recently accessed reservations.
3 properties
recentlyAccessedReservationsType
array
A single recently accessed reservation.
recentlyAccessedReservationType
object
A recently used reservation record.
10 properties
checkReservationsDetails
object
Response for checking allowed actions, existence of attached records, or indicators of a reservation.
3 properties
checkReservationsType
array
Collection of reservations and the status of its allowed actions, attached records, and indicators.
checkReservationType
object
Reservation and the status of its allowed actions, attached records, and indicators.
3 properties
checkResultsType
array
Collection of status of allowed actions, attached records, and indicators of the reservation.
checkResultType
object
Status of allowed actions, attached records, and indicators of the reservation.
2 properties
checkInstructionType
string
Simple type that corresponds to check reservation instructions.
reservationPace
object
FetchReservationPace response.
3 properties
reservationPaceRSType
object
Contains reservation pace report data.
3 properties
dailyPaceStatsType
array
a collection of reservation pace statistics.
dailyPaceStatType
object
An instance or a day of a reservation pace statistic.
3 properties
reservationStatistics
object
FetchReservationStatistics response
3 properties
statisticType
object
Defines all details needed to create a statistical report.
10 properties
statisticCodeType
object
Defines the codes and corresponding categories for which the data in the other elements has been gathered.
5 properties
statisticSetType
object
An instance of a statistic, which is a set containing revenue category and number category summaries.
4 properties
revenueCategorySummaryType
object
This element has revenue amount data for its revenue category such as Room Revenue, Food and Beverage Revenue.
3 properties
numericCategorySummaryType
object
This element has count data for each count category such as number of guests, rooms occupied, etc.
2 properties
splitMultiRoomReservation
object
Request to split multi-room reservation into separate reservations.
8 properties
splitMultiRoomReservationDetails
object
Response for splitting multi-room reservation into separate reservations.
4 properties
sellMessages
object
This is the Response Message Type to the request for retrieving Sell Messages.
3 properties
sellMessagesType
object
The SellMessagesType is the list of message and attributes returned by web service.
4 properties
sellMessageType
object
The SellMessagesType defines the standard attributes that will be retrieved with the sell message.
16 properties
reservationDisplayColorInfoType
object
Information of reservation display color, determined based on OPERA parameter RESERVATIONCOLORDEFINITION
3 properties
colorType
string
Color configuration type. This color configuration provides a visual category of entities.
frontOfficeRoomStatusType
string
Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.
colorDefinitionType
string
Color definition type. This color definition type is used to determine the defintion of color
actionType
string
Action types allowed by the event api.
customChargeGuestInfoType
object
4 properties
fiscalInfoType
object
Fiscal related information for a reservation.
3 properties
payloadType
string
Fiscal Payload Type.
reservationCommissionInfoType
object
2 properties
reservationsSummaryInformationType
object
Reservations Summary.
6 properties
reservationsInformationType
object
Reservations Information.
39 properties
distinctIDType
object
Unique identifiers for both internal and external systems Eg: ReservationId, ConfirmationNumber, CancellationNumber, ExternalReferenceNumber etc
3 properties
reservationDates
object
Reservation Dates
6 properties
guestDetails
object
Guest Details
9 properties
membershipDetails
object
Membership Details
5 properties
companyDetails
object
Company Details
2 properties
groupDetails
object
Group Details
2 properties
travelAgentDetails
object
Travel Agent Details
2 properties
reservationsSummary
object
Response object to the Fetch Reservations information. Based on the criteria, reservation information is returned.
3 properties
reservationMembershipAwardType
object
This type contains information of a membership award attached to a reservation.
14 properties
createReservationType
object
Create Reservation Response Type
4 properties
lastCommittedResvType
object
5 properties
reservationKeyInfoType
object
Holds the room key information provided by the Door Lock System.
1 property
departureReservationInfoType
object
Key information about the departure reservation.
2 properties
roomOwnerStatusType
string
Enumeration of different ownership statuses of room
linkedReservationsCommonDetailsType
object
Details common to all linked reservations.
1 property
changeLinkedReservationsCommonDetails
object
Request object for updating linked reservations details.
1 property
linkedReservationsCommonDetails
object
Response object for updating linked reservations details.
3 properties
changeLinkedReservationType
object
Request object to change a linked reservation information.
2 properties
backToBackResSequenceType
object
Type object represents Back To Back Sequence Position and Total Count of Linked Back To Back Reservations ordered by consecutive Stay Dates.
2 properties
roomOccupancyType
object
Room Occupancy information.
9 properties
combineShareFromExistingReservationType
object
Details of the existing reservation to be combined as a sharer.
2 properties
scheduledRoomMoveInfoType
object
Scheduled Move information.
7 properties
scheduledRoomMoveType
object
Scheduled Move information.
5 properties
scheduledRoomMoveStatusType
string
Flag indicating scheduled room move status.
checkDistributionReservationsSummaryType
object
Reservation Statistics and the status of its allowed actions, attached records.
15 properties
checkDistributionReservationsSummary
object
Response for checking allowed actions, existence of attached records, or count of reservations.
6 properties
bookingTimeSpanType
object
The booking time span of the reservation, only applicable when time increments are being used.
2 properties
changePayeeSharerType
object
Request object to to mark or unmark the payee sharer information.
1 property
payeeSharerInfoType
object
Holds the information to mark or unmark a shared reservation as a payee sharer.
4 properties
addOnReservationPackageType
object
AddOn ReservationPackageType class.
11 properties
reservationAddOnPackagesType
object
A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges.
3 properties
addOnReservationPackagesType
object
A collection of Reservation packages.
5 properties
reservationPreConfiguredRoutingInstructionsType
object
1 property
scheduledRoomMoveResponseType
object
Scheduled Room Move information.
3 properties
scheduledRoomMoveDetails
object
Details regarding a specific scheduled room move.
2 properties
scheduledRoomMoveDetailType
object
Scheduled room move information.
2 properties
scheduleRoomMoveType
object
Type of room move scheduled either from or to information
4 properties
attachDetachType
object
This type contains attach and detach information for accompanying guest profile.
3 properties
validatePoliciesType
object
Request object to fetch deposit and cancellation policies.
10 properties
rateSearchType
object
Room Rate associated with a particular segment of the Stay.
8 properties
reservationGuaranteesPolicies
object
Response object to fetch reservation guarantees.
3 properties
flexFieldValues
object
Request object for flex fields values.
3 properties
flexFieldValueType
object
Provides the details of a flex field values
2 properties
flexFieldsResponse
object
Response object for flex fields.
9 properties
operaVersion
object
Response for Ping operation.
3 properties
offshoreRateType
object
Defines Offshore rate information.
3 properties
externalDailyRateType
object
Room rate information provided by an external CRS application on a daily basis for this reservation.
4 properties
assignBlockRateInstructionsType
string
Instructions for rate handling when assigning a block to a reservation.
changePackageQuantityType
object
Request object to update package quantity for package codes.
1 property
packageQuantityInfoType
object
Information regarding a single package quantity
3 properties
packageInfoType
object
Package information related to a reservation
11 properties
packageCategoryInfoType
object
Information about the package category
2 properties
unavailableItemInstructionType
string
separateShareReservation
object
Request to separate Share Reservation and apply rate amounts to separated and remaining share reservations from room rates provided by an external application…
3 properties
separateShareReservationType
object
Type to separate Share Reservation and apply rate amounts to separated and remaining share reservations from room rates provided by an external application.
1 property
dailyRateDistributionCriteria
object
Criteria to distribute and apply rate amounts to separated and remaining share reservations from room rates provided by an external application.
2 properties
packageCategoryReservationType
object
Information regarding each reservation being returned in the response
14 properties
packageCategoryReservations
object
Response object to the Fetch Reservations by package request operation. Based on the criteria, reservation information is returned.
4 properties
tieredDepositRule
object
Type for a tiered deposit rule policy that is configured and attached to a tiered deposit rule schedule.
6 properties
tieredCancelPenalty
object
Type for a tiered cancellation penalty that is configured and attached to a tiered cancel penalty schedule.
6 properties
reservationProtectionType
object
Reservation Protection information related to the reservation.
1 property
depositPaymentType
object
Request to post a deposit payment to a reservation.
1 property
reservationDepositPaymentCriteriaType
object
Criteria for posting a deposit payment to a reservation.
7 properties
cashieringPaymentMethodType
object
3 properties
authorizationInfoType
object
5 properties
postingIntervalType
object
Posting Interval details for the reservation including begin/end dates, amount and frequency for each posting interval cycle on the reservation. Only available…
6 properties
postingIntervalFrequency
string
Specifies the frequency at which charges are posted for the rate plan on the reservation.
traceFrequencyType
object
Defines the trace frequency settings and associated parameters for creating reservation traces. Fields are conditionally required depending on the selected tra…
5 properties
traceFrequencyPatternType
string
Defines the Trace Frequency for the created trace. Traces created with a defined trace frequency will have the trace dates automatically updated when a reserva…
certainNightsOfTheWeek
object
Supports the 'Certain Nights Of The Week' trace frequency option by indicating on which days traces should be generated.
7 properties
preArrivalReviewStatusType
string
Simple type for Pre-Arrival Review Status.
resvIdentificationInfoType
object
Information on the identification of the customer.
4 properties
reservationStatusEnum
string
searchReservationsSummaryRequest
object
20 properties
searchReservationsRequest
object
133 properties
reservationSearchType
string
reservationOrderBy
string
fetchInstructionType
string
roomReadyStatusType
string
searchHotelReservationsRequest
object
158 properties
hotelReservationSearchType
string
hotelReservationStatusType
string
hotelReservationOrderBy
string
hotelReservationFetchInstruction
string
hotelReservationAllowedAction
string
searchExternalSystemReservationsRequest
object
103 properties
1 required
externalReservationSearchType
string
externalReservationOrderBy
string
externalReservationStatusType
string
externalReservationFetchInstruction
string
searchPreConfiguredRoutingInstructionsRequest
object
19 properties
searchRateInfoRequest
object
23 properties
postDeletePreCheckInReservationRequest
object
58 properties
reservationStatusType
string
Simple type for indicating the reservation status.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oracle Hospitality publishes across the network.