Oracle Hospitality Reservation API
Reservation API
Oracle Hospitality Reservation API is one of 154 APIs that Oracle Hospitality publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Reservation. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 179 operations across 116 paths, and defines 808 schemas. It is described by OpenAPI 3.2.0, at version 26.2.0.0.
Requests are made against 2 base URLs: /distribution/v1, /rsv/v1.
179 operations
116 paths
808 schemas
29 DELETE53 GET47 POST50 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 179
Across 116 paths, the API surfaces 179 operations — 29 DELETE, 53 GET, 47 POST, 50 PUT. Each is listed below with its method, path, parameters, and response codes.
Reservation 179
Reservation API
POST
/hotels/{hotelId}/reservations
Create Reservation
GET
/hotels/{hotelId}/reservationsdeprecated
Get Reservations for a hotel
GET
/hotels/{hotelId}/reservations/{reservationId}
Get reservation.
PUT
/hotels/{hotelId}/reservations/{reservationId}
Update Reservation
DELETE
/hotels/{hotelId}/reservations/{reservationId}
Delete a Reservation by resort
POST
/hotels/{hotelId}/reservations/{reservationId}/cancellations
Cancel Reservation
PUT
/hotels/{hotelId}/reservations/{reservationId}/cancellations
Reinstate a Reservation
POST
/calls
Register Call
GET
/calls/statistics
Get call statistics
GET
/externalSystems/{extSystemCode}/reservationsdeprecated
Get Reservations for a hotel
POST
/externalSystems/{extSystemCode}/reservations/searches
Get Reservations for a hotel from an external system
GET
/hotels/{hotelId}/awardUpgrades
Get Award Upgrades
GET
/hotels/{hotelId}/awards
Fetch Awards
POST
/hotels/{hotelId}/blocks/{blockId}/reservations
Create Reservation for a Block
PUT
/hotels/{hotelId}/cancellationPolicies
Change a Cancellation policy
GET
/hotels/{hotelId}/confirmationLetters
Fetch Confirmation Letters
POST
/hotels/{hotelId}/confirmationLetters
Create the confirmation letters
PUT
/hotels/{hotelId}/depositPolicies
Change deposit policy
POST
/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/linkedReservations/{reservationExternalId}
Link Reservations
DELETE
/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/linkedReservations/{reservationExternalId}
Remove Reservation Links
GET
/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/{reservationExternalId}
Get Reservation by external ID
PUT
/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/{reservationExternalId}
Update Reservation by ID
PUT
/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/{reservationExternalId}/addOnReservationPackagesByExtId
Update Add On (Sell Separate) packages on a reservation
PUT
/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/{reservationExternalId}/cancellations
Reinstate a Reservation
POST
/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/{reservationExternalId}/cancellations
Cancel Reservation by ID
POST
/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/{reservationExternalId}/routingInstructions
Create routing instructions
PUT
/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/{reservationExternalId}/routingInstructions
Change routing instructions
PUT
/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/{reservationExternalId}/separatedShare
Separate Share Reservation with the given external reservation id and apply rate amounts to separated and remaining share reservations from room rates provided by an external application on a daily b…
GET
/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/{reservationExternalId}/shares
Get share Reservations
POST
/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/{reservationExternalId}/shares
Combine Share Reservations
DELETE
/hotels/{hotelId}/externalSystems/{externalSystemCode}/reservations/{reservationExternalId}/shares
Separate share Reservations
GET
/hotels/{hotelId}/fetchExternalSystemDeliveryHistory
Get External system delivery history
GET
/hotels/{hotelId}/guestMessages
Get guest messages
DELETE
/hotels/{hotelId}/locks/{lockHandle}
Release Reservation Lock
PUT
/hotels/{hotelId}/locks/{lockHandle}
Extend Reservation Lock
GET
/hotels/{hotelId}/preArrivalMembersReservations
Get preArrival Member Reservations
GET
/hotels/{hotelId}/preConfiguredRoutingInstructionsdeprecated
Get pre-Configured Routing Instructions
POST
/hotels/{hotelId}/preConfiguredRoutingInstructions/searches
Get pre-Configured Routing Instructions
GET
/hotels/{hotelId}/profiles/{profileIdtoShare}/sharedeprecated
Get Reservations to share
PUT
/hotels/{hotelId}/rateInfoValidation
Validate rate information
GET
/hotels/{hotelId}/reservations/activityLog
Fetch Reservation Activity Log
POST
/hotels/{hotelId}/reservations/alerts
Create Bulk Reservation Alerts
POST
/hotels/{hotelId}/reservations/cancellations
Cancel Reservations
POST
/hotels/{hotelId}/reservations/linkedReservations/{reservationId}
Link Reservations
DELETE
/hotels/{hotelId}/reservations/linkedReservations/{reservationId}
Remove Reservation Links
PUT
/hotels/{hotelId}/reservations/linkedReservations/{reservationId}
Update Linked Reservations Common Details.
GET
/hotels/{hotelId}/reservations/packageCategoryReservations
Get Reservations by pacakge and consumption date
PUT
/hotels/{hotelId}/reservations/policies
Get Deposit and Cancellation Policies that are applicable to the specified criteria.
GET
/hotels/{hotelId}/reservations/rateInfodeprecated
Get rate information
POST
/hotels/{hotelId}/reservations/rateInfo/searches
Get rate information
POST
/hotels/{hotelId}/reservations/reservationCancellations
Cancel reservations
POST
/hotels/{hotelId}/reservations/searches
Get Reservations for a hotel
GET
/hotels/{hotelId}/reservations/statistics
Get Reservation DistributionReservationsSummary
GET
/hotels/{hotelId}/reservations/summarydeprecated
Get brief summary for Reservations
POST
/hotels/{hotelId}/reservations/summary/searches
Search brief summary for Reservations
PUT
/hotels/{hotelId}/reservations/validations
Validate Reservation Before Creating or Applying Changes
GET
/hotels/{hotelId}/reservations/{reservationIdtoShare}/share
Get Reservations to share by Reservation id
PUT
/hotels/{hotelId}/reservations/{reservationId}/addOnReservationPackages
Update Add On (Sell Separate) packages on a reservation.
GET
/hotels/{hotelId}/reservations/{reservationId}/alerts
Fetch Alert Notices
GET
/hotels/{hotelId}/reservations/{reservationId}/attachments
Get Reservation attachments
DELETE
/hotels/{hotelId}/reservations/{reservationId}/attachments/{attachmentId}
Delete Reservation attachments
PUT
/hotels/{hotelId}/reservations/{reservationId}/breakshares/action/validate
Validate before breaking a share Reservation
GET
/hotels/{hotelId}/reservations/{reservationId}/calls
Get the Reservation Call History
GET
/hotels/{hotelId}/reservations/{reservationId}/cancellationHistory
Get cancellation history
POST
/hotels/{hotelId}/reservations/{reservationId}/cancellationPolicies
Create a Cancellation policy
PUT
/hotels/{hotelId}/reservations/{reservationId}/cancellationPolicies
Compute the cancellation policies
DELETE
/hotels/{hotelId}/reservations/{reservationId}/cancellationPolicies
Delete a Cancellation policy
POST
/hotels/{hotelId}/reservations/{reservationId}/certificates
Attach Certificate
DELETE
/hotels/{hotelId}/reservations/{reservationId}/certificates
Detach Certificate
PUT
/hotels/{hotelId}/reservations/{reservationId}/combineshares/action/validate
Combine Share Validations
PUT
/hotels/{hotelId}/reservations/{reservationId}/consumedPackageQuantity
Update consumed package quantity for package codes.
POST
/hotels/{hotelId}/reservations/{reservationId}/copy
Copy a Reservation
PUT
/hotels/{hotelId}/reservations/{reservationId}/dailyRates/action/validatedeprecated
Validate daily rate details change
POST
/hotels/{hotelId}/reservations/{reservationId}/depositPolicies
Create deposit policy
PUT
/hotels/{hotelId}/reservations/{reservationId}/depositPolicies
Computes the deposit policies
DELETE
/hotels/{hotelId}/reservations/{reservationId}/depositPolicies
Delete deposit policy
GET
/hotels/{hotelId}/reservations/{reservationId}/eCoupons
Get Reservation Ecoupons
POST
/hotels/{hotelId}/reservations/{reservationId}/eCoupons
Create Reservation ECoupon
PUT
/hotels/{hotelId}/reservations/{reservationId}/eCoupons
Change Reservation Ecoupon
DELETE
/hotels/{hotelId}/reservations/{reservationId}/eCoupons
Delete Reservation ECoupons
DELETE
/hotels/{hotelId}/reservations/{reservationId}/flexFieldCode/{flexFieldCode}
Operation to delete a flex field.
GET
/hotels/{hotelId}/reservations/{reservationId}/flexFieldValues
Operation to fetch flex field values.
POST
/hotels/{hotelId}/reservations/{reservationId}/flexFieldValues
Operation to create a flex field with value for a module.
PUT
/hotels/{hotelId}/reservations/{reservationId}/flexFieldValues
Operation to update flex field value.
GET
/hotels/{hotelId}/reservations/{reservationId}/guestLocators
Fetch Reservation Guest Locator
POST
/hotels/{hotelId}/reservations/{reservationId}/guestLocators
Create Reservation Guest Locator
PUT
/hotels/{hotelId}/reservations/{reservationId}/guestLocators/{locatorId}
Change Reservation Guest Locators
DELETE
/hotels/{hotelId}/reservations/{reservationId}/guestLocators/{locatorId}
Remove Reservation Locators
POST
/hotels/{hotelId}/reservations/{reservationId}/guestMessages
Create guest messages
PUT
/hotels/{hotelId}/reservations/{reservationId}/guestMessages
Change Reservation Guest Messages
PUT
/hotels/{hotelId}/reservations/{reservationId}/guestMessages/{guestMessageId}
Change guest Message
DELETE
/hotels/{hotelId}/reservations/{reservationId}/guestMessages/{guestMessageId}
Delete guest messages
PUT
/hotels/{hotelId}/reservations/{reservationId}/header/action/validate
Validate Reservation header change
GET
/hotels/{hotelId}/reservations/{reservationId}/inventoryItems
Get Reserved Inventory Items
POST
/hotels/{hotelId}/reservations/{reservationId}/inventoryItems
Reserve Reservation inventory items
PUT
/hotels/{hotelId}/reservations/{reservationId}/inventoryItems
Change reserved Inventory Items
DELETE
/hotels/{hotelId}/reservations/{reservationId}/inventoryItems
Delete Reserved Inventory Items
GET
/hotels/{hotelId}/reservations/{reservationId}/linked
Get linked Reservations
PUT
/hotels/{hotelId}/reservations/{reservationId}/linked
Update Linked Reservation by ID
GET
/hotels/{hotelId}/reservations/{reservationId}/linkedSummary
Get Reservation summary for linked Reservation
PUT
/hotels/{hotelId}/reservations/{reservationId}/locks
Acquire Reservation Lock
POST
/hotels/{hotelId}/reservations/{reservationId}/locks/break
Break Reservation lock
POST
/hotels/{hotelId}/reservations/{reservationId}/masterAccount
Create a Master Account
PUT
/hotels/{hotelId}/reservations/{reservationId}/masterAccount
Change a Master Account
DELETE
/hotels/{hotelId}/reservations/{reservationId}/masterAccount
Cancel Master Account
PUT
/hotels/{hotelId}/reservations/{reservationId}/mergeReservations
Merge multiple Reservations
PUT
/hotels/{hotelId}/reservations/{reservationId}/move
Move the Reservation
GET
/hotels/{hotelId}/reservations/{reservationId}/packages
Get Package
POST
/hotels/{hotelId}/reservations/{reservationId}/packages
Add a package to a Reservation
PUT
/hotels/{hotelId}/reservations/{reservationId}/packages
Update a package on a Reservation
DELETE
/hotels/{hotelId}/reservations/{reservationId}/packages
Delete a package from a Reservation
PUT
/hotels/{hotelId}/reservations/{reservationId}/payeeSharer
Update Payee Sharer Information by ID.
POST
/hotels/{hotelId}/reservations/{reservationId}/paymentMethods
Create a payment method
GET
/hotels/{hotelId}/reservations/{reservationId}/paymentMethods
Get a payment method
DELETE
/hotels/{hotelId}/reservations/{reservationId}/paymentMethods
Delete a payment method
PUT
/hotels/{hotelId}/reservations/{reservationId}/paymentMethods
Change a payment method
GET
/hotels/{hotelId}/reservations/{reservationId}/policies
Get Reservation Policies
POST
/hotels/{hotelId}/reservations/{reservationId}/preCheckIn
Pre-Checkin a Reservation
DELETE
/hotels/{hotelId}/reservations/{reservationId}/preCheckIndeprecated
Revert a PreCheckIn Reservation
POST
/hotels/{hotelId}/reservations/{reservationId}/preCheckIn/deletions
Revert a PreCheckIn Reservation
GET
/hotels/{hotelId}/reservations/{reservationId}/preferences
Get Reservation Preferences
POST
/hotels/{hotelId}/reservations/{reservationId}/preferences
Add a preference to a Reservation
PUT
/hotels/{hotelId}/reservations/{reservationId}/preferences/{preferenceCode}
Change a Reservation Preference
DELETE
/hotels/{hotelId}/reservations/{reservationId}/preferences/{preferenceCode}
Delete a Reservation Preference
POST
/hotels/{hotelId}/reservations/{reservationId}/reverseDepositPolicy/{policyId}deprecated
Reverse a deposit policy
GET
/hotels/{hotelId}/reservations/{reservationId}/routingInstructions
Get routing instructions
POST
/hotels/{hotelId}/reservations/{reservationId}/routingInstructions
Create routing instructions for a reservation
DELETE
/hotels/{hotelId}/reservations/{reservationId}/routingInstructionsdeprecated
Delete routing instructions
PUT
/hotels/{hotelId}/reservations/{reservationId}/routingInstructions
Change routing instructions
PUT
/hotels/{hotelId}/reservations/{reservationId}/scheduledRoomMoves/{scheduledMoveDate}
Update Scheduled Room Move Details based on reservationID and move date
PUT
/hotels/{hotelId}/reservations/{reservationId}/separatedShare
Separate Share Reservation and apply rate amounts to separated and remaining share reservations from room rates provided by an external application on a daily basis.
PUT
/hotels/{hotelId}/reservations/{reservationId}/shareRateAmount
Change Share Rate Amount
PUT
/hotels/{hotelId}/reservations/{reservationId}/sharedGuestCount
Change Sharing Guests
GET
/hotels/{hotelId}/reservations/{reservationId}/shares
Get share Reservations
POST
/hotels/{hotelId}/reservations/{reservationId}/shares
Combine Share Reservations
DELETE
/hotels/{hotelId}/reservations/{reservationId}/shares
Separate share Reservations
PUT
/hotels/{hotelId}/reservations/{reservationId}/stay/action/validate
Check overlapping stay
GET
/hotels/{hotelId}/reservations/{reservationId}/tickets
Get tickets
POST
/hotels/{hotelId}/reservations/{reservationId}/tickets
Create tickets
PUT
/hotels/{hotelId}/reservations/{reservationId}/tickets
Change tickets
DELETE
/hotels/{hotelId}/reservations/{reservationId}/tickets
Delete tickets
GET
/hotels/{hotelId}/reservations/{reservationId}/tickets/inquiry
Inquiry for Reservation tickets
POST
/hotels/{hotelId}/reservations/{reservationId}/tickets/issue
Issue Reservation tickets
DELETE
/hotels/{hotelId}/reservations/{reservationId}/tickets/refund
Refund Reservation tickets
GET
/hotels/{hotelId}/reservations/{reservationId}/tickets/reprint
Reprints Reservation tickets
GET
/hotels/{hotelId}/reservations/{reservationId}/traces
Get traces for a Reservation
GET
/hotels/{hotelId}/reservations/{reservationId}/transactionDiversions
Get Transaction Diversions
POST
/hotels/{hotelId}/reservations/{reservationId}/transactionDiversions
Create Transaction Diversions
PUT
/hotels/{hotelId}/reservations/{reservationId}/transactionDiversions
Change Transaction Diversions
DELETE
/hotels/{hotelId}/reservations/{reservationId}/transactionDiversions
Delete Transaction Diversions
PUT
/hotels/{hotelId}/reservations/{reservationId}/upgradeEligibleReservations
Set Upgrade Eligibility for Reservations
POST
/hotels/{hotelId}/reservations/{reservationId}/upsell
Upsell a Reservation
GET
/hotels/{hotelId}/reservations/{reservationId}/upsell
Get available Upsell offers
DELETE
/hotels/{hotelId}/reservations/{reservationId}/upsell
Delete a Reservation Upsell
GET
/hotels/{hotelId}/roomCalendar
Get the room calendar
GET
/hotels/{hotelId}/rooms/{roomId}/traces
Get traces for a Room
GET
/hotels/{hotelId}/script
Get a script
GET
/hotels/{hotelId}/sellMessages/config
Get sell messages
POST
/hotels/{hotelId}/sellMessages/config
Create sell message
PUT
/hotels/{hotelId}/sellMessages/config
Change sell message
DELETE
/hotels/{hotelId}/sellMessages/config
Delete sell message
PUT
/hotels/{hotelId}/stay/action/validate
Check overlapping stay
POST
/hotels/{hotelId}/turnaways
Register Turnaway
GET
/profiles/{profileId}/reservations
Get Future Reservations on a profile
GET
/recentlyAccessedReservations
Get recently accessed Reservations
GET
/reservationsdeprecated
Get Reservations for a hotel
GET
/reservations/indicators
Get Reservation indicators
POST
/reservations/linkedReservations/{reservationId}
Link Reservations By Chain
DELETE
/reservations/linkedReservations/{reservationId}
Remove Reservation Links By Chain
POST
/reservations/searches
Search Reservations for a hotel
DELETE
/reservations/{reservationId}deprecated
Delete a Reservation
PUT
/reservations/{reservationId}/split
Split multi room Reservation
GET
/sellMessages
Get sell messages
GET
/sellMessages/config
Get sell messages by chain
POST
/sellMessages/config
Create sell message by chain
PUT
/sellMessages/config
Change sell message by chain
DELETE
/sellMessages/config
Delete sell message by chain
GET
/services/reservations/status
Ping
POST
/turnaways
Register Hub Turnaway
Schemas 808
The contract defines 808 schemas that model the data the API accepts and returns. The most detailed are searchHotelReservationsRequest (158 properties), searchReservationsRequest (133 properties), hotelReservationType_2 (110 properties), hotelReservationType (108 properties). Each schema is shown below with its type and property counts.
reservationQueueInformationType
object
Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
6 properties
prepaidCardsType
array
Holds fixed charge detail.
channelModifyResvRQInfoType
object
Holds all the channel reservation specific information.
3 properties
cardReIssueType
string
Request to re issue a new card.
resAccompanyGuestInfoType
object
6 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…
44 properties
entityType
string
Indicates the rule is based on Minutes associated with the charge.
reservationECertificatesType
array
Collection of ECertificateType object.
policyBasisTypeType
string
Full Amount.
lastCommittedResvType
object
5 properties
colorType
string
Color configuration type. This color configuration provides a visual category of entities.
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
dailyRatesType
array
Defines room rate information on a daily basis.
pkgInventoryItemType
object
4 properties
characterUDFsType
array
Used to hold collection of user defined fields of Character/String Type.
alertType
object
21 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
indicatorType
object
Lamp indicator Type.
2 properties
fixedChargesType
array
Holds fixed charge detail.
imageStyleType
string
An enumeration of image styles.
addressInfoType
object
Provides address information.
3 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
transactionDiversionDailyDetailType
object
List of daily details for Transaction Diversion rule.
3 properties
packageCategoryInfoType
object
Information about the package category
2 properties
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
eCertificateInfoType
object
E-Certificates details.
12 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
customerType
object
Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
16 properties
callType
object
Holds call information.
11 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…
excludedDateType
object
Specifies all the enabled dates.
2 properties
attachDetachType
object
This type contains attach and detach information for accompanying guest profile.
3 properties
profileDeliveryModuleType
string
Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..
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
hotelInterfaceType
object
8 properties
reservationPaymentMethodsType
array
Defines reservation payment methods.
cardProcessingType
string
reservationHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
packageConsumptionType
object
Package Consumption Information. Includes information on quantity of the package used, allowance consumption etc.
4 properties
prepaidCardType
object
Holds fixed charge information.
15 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
resAccompanyGuestListType
array
Collection of accompany guests
resSharedGuestListType
array
Collection of shared guest reservations.
departureReservationInfoType
object
Key information about the departure reservation.
2 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…
benefitsType
array
Basic information about membership benefit.
userSessionInfoType
object
11 properties
channelResvRSInfoType
object
Holds all the channel reservation specific information.
5 properties
reservationPoliciesType
object
A collection of reservation deposit and cancellation policies.
4 properties
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.
codeDescriptionType
object
This contains a generic code and description information.
2 properties
productSourceType
string
Sources of Products
resAwardsType
object
Membership Awards code applied on the reservation.
3 properties
postingRhythmType
string
Simple type for posting Rhythm types.
createReservationResponse
object
Response object to create reservations.
4 properties
surnameType
string
Family name, last name.
ownerType
object
Generic type for information about an owner.
11 properties
authorizationInfoType
object
5 properties
reservationECertificateType
object
Reservation ECertificate Type Information.
3 properties
confDeliveryMethod
string
fetchReservationDetails
object
5 properties
searchMatchType
object
Search match indicating attribute and the matching value.
2 properties
fiscalInfoType
object
Fiscal related information for a reservation.
3 properties
attendantType
object
2 properties
hotelReservationsType
object
A collection of Reservation objects and Unique IDs of Reservation.
4 properties
profileDeliveryMethod
object
Delivery Information type to the profile.
7 properties
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
packageInfoType
object
Package information related to a reservation
10 properties
commissionPaymentMethods
string
Check
cancelReservationDetails
object
Response object for the request to cancel reservations. Response contains the reservations which were successfully canceled.
9 properties
compRoutingStatusType
string
Status which indicates that the Request of Comp Routing was declined
confirmationsType
array
List of confirmation letters.
addressType
object
Provides address information.
18 properties
shareReservationInstructionType
object
5 properties
folioShortInfoType
object
This type contains information of generated bills.
3 properties
nameValueDetailType
object
Detailed information returned during name value search.
1 property
serviceRequests
array
Service request.
totalType
object
The total amount charged for the service including additional amounts and fees.
13 properties
taxesType
object
A collection of taxes.
4 properties
rateByAgeBucketType
object
Rate amount by age bucket.
3 properties
overrideInstructionsType
array
List of override actions done.
sentConfirmationStatus
string
stayFutureListType
object
A collection of reservation history details attached to Profiles.
4 properties
countryNameType
object
Used for Character Strings, length 0 to 200 - It indicates country/nationality description.
4 properties
dailyRateType
object
The total amount charged for the service including additional amounts and fees.
13 properties
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
relationshipAddressType
object
Provides address information for a Relationship.
5 properties
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
messageDeliveryType
object
Holds the Delivery Information of the Message
8 properties
dateRangeType
object
Date Range with Start and End dates.
2 properties
serviceRequestStatusType
string
benefitType
object
Basic information about membership benefit.
3 properties
billingPrivilegesType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
10 properties
compAccountingType
object
Authorizer Information
12 properties
reservationTaxTypeInfo
object
Provides information about the Tax Type.
3 properties
trackItLogType
object
Individual activity log related to the Track It ticket.
9 properties
formattedTextTextType
object
Provides text and indicates whether it is formatted or not.
2 properties
resCancellationPolicyType
object
A cancellation policy attached with the reservation.
5 properties
profileCashieringType
object
Contains cashiering related details for the profile
3 properties
relationshipInfoType
object
Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.
6 properties
depositCancelRevenueType
string
The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 properties
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…
bookingTimeSpanType
object
The booking time span of the reservation, only applicable when time increments are being used.
2 properties
cancelReservationType
object
The Reservation class contains the current reservation being created or altered.
56 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…
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
nameValueType
object
Contains name value pair.
6 properties
alertAreaType
string
reservationInfoType
object
The Reservation class contains the current reservation being created or altered.
59 properties
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.
fetchActivityBookingsType
object
Used in the request message to describe the "filtering Criteria" when executing an activity lookup.
5 properties
reservationTransactionDiversionsType
array
List of Transaction Diversion rules.
reservationPackageScheduleType
object
A HotelPackageSchedule type.
16 properties
resCashieringType
object
Cashiering Information for the reservation.
12 properties
eCertificateType
object
E-Certificates details.
10 properties
reservationDepositType
object
Reservation Deposit Type.
7 properties
hotelReservationType
object
The Reservation class contains the current reservation being created or altered.
108 properties
routingInstructionType
object
Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit
8 properties
profileMembershipType
object
Detailed information of the memberships.
40 properties
reservationPaymentMethodType
object
8 properties
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
colorDefinitionType
string
Color definition type. This color definition type is used to determine the defintion of color
cancellationReasonType
object
Specifies the reason for the cancellation.
2 properties
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
reservationKeyInfoType
object
Holds the room key information provided by the Door Lock System.
1 property
effectiveRatesType
array
Collection of effective rate amount per guest on specific dates.
dateTimeStampGroupType
object
5 properties
trackItActionType
object
Identifies the response expected from staff or other parties relative to a Track It ticket.
2 properties
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 properties
cashierId
number
The Cashier ID of the Cashier who is currently processing the transaction(s).
awardType
object
Detailed information of the awards.
32 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
depositPaymentCriteriaType
object
Criteria for posting a deposit payment to a reservation.
7 properties
nameValueOriginType
object
Contains origin details.
4 properties
identificationInfoType
object
Information on the identification of the customer.
3 properties
profileRestrictions
object
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
offshoreRateType
object
Defines Offshore rate information.
3 properties
fixedChargeScheduleType
object
Holds schedule of fixed charge.
5 properties
customChargeQuantityType
object
Contains quantity of custom charge exemptions.
3 properties
channelSummaryInfoType
object
Depicts channel information such as the type and code.
1 property
configPackageTransactionType
object
A HotelPackageTransaction type.
4 properties
linkedReservationType
string
Enumeration of the different Linked Reservation Types.
trxInfoType
object
Transaction codes info.
6 properties
relationshipInfoSummaryType
object
RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact p…
7 properties
callHistoryType
array
Holds call information.
resAttachedProfileListType
array
eCertificateConsumptionType
object
E-Certificates details.
9 properties
relationshipProfileSummaryType
object
11 properties
awardsType
array
List of awards.
rateChangeInstructionType
object
Defines override rate type.
2 properties
givenNameType
string
Given name, first name or names
reservationMembershipAwardType
object
This type contains information of a membership award attached to a reservation.
14 properties
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
4 properties
eCouponType
object
Reservation eCoupon Type Information.
9 properties
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
9 properties
imageSetType
object
Represents on image set record.
6 properties
customChargeExemptionDateType
object
Contains Custom Charge Exemption information for a day.
3 properties
linkedReservationsInfoType
object
Linked Reservations.
8 properties
facilitySchedulerOptionType
string
Facility Scheduler Option value.
parametersType
array
Collection of generic Name-Value-Pair parameters.
exclusionReasonType
string
Custom Charge has already been Processed for this date within the reservation stay.
messageType
object
Holds the Message Information
5 properties
ExceptionDetail
object
Object that contains error details for a REST call.
7 properties
3 required
currentRoomInfoType
object
Room information of the reservation for the current day.
8 properties
eCouponsType
array
Collection of ECouponType object.
typeOfMessageType
string
The type of Message for Guest Messages.
compAuthorizerInfoType
object
Authorizer Information
3 properties
confirmationStyle
object
7 properties
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
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
1 property
eCertificateIssueSourceType
string
Indicates that OPERA Cloud E-Certificate is issued by external system.
guestMessageType
object
Holds the Message information for a Reservation
12 properties
compRoutingRequestType
object
Type for the details of a Comp Routing Request
4 properties
excludedDatesType
array
Contains list of dates which are valid for custom charge exemptions.
interfaceRightsStatusType
object
4 properties
profileNameType
object
This provides name information for a person.
7 properties
traceTimeInfoType
object
4 properties
stayReservationInfoType
object
The Reservation class contains the current reservation being created or altered.
6 properties
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
27 properties
reservationFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
4 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
channelCancelResvActionType
string
Specifies the reservation action initiated by the Channel. ChannelResvActions : 'Create', 'Book', 'Modify', 'CommittOverrideEdits' and 'Hold' are deprecated an…
hotelReservationTracesType
array
List of Reservation Traces.
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
profileStatusType
string
visaInfoType
object
3 properties
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
reservationInterfaceStatusType
object
Hotel Interface Type for a reservation and status of the various services
3 properties
billingInstructionsType
array
Set of Billing Instruction codes.
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
depositPolicyType
object
Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.
10 properties
commissionPayoutToType
string
childAgesType
array
Age of a child in years.
scheduledRoomMoveResponseType
object
Scheduled Room Move information.
3 properties
ticketType
object
Reservation Ticket Type Information.
13 properties
rateByAgeBucketsType
array
Rate amount by age bucket.
changeInstructionType
object
Instructions for Changing a Reservation.
7 properties
lastStayInfoType
object
Contains last stay related details for the profile
2 properties
rewardCertificateType
string
Point Saver reward.
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
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
reservationFolioWindowsType
array
Collection of reservation folio windows.
externalDailyRateType
object
Room rate information provided by an external CRS application on a daily basis for this reservation.
4 properties
activityList
array
A collection of Activity objects.
packageCodeHeaderType
object
3 properties
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
commentInfoType
object
Comment related to the profile/reservation.
8 properties
nameValuesType
array
List of name value pairs.
reservationIdList
array
Unique Id that references an object uniquely in the system.
routingInfoType
object
A routing info object can either be of type Folio OR of type Room with its corresponding object.
5 properties
eCertificateStatusType
string
Indicates that OPERA Cloud E-Certificate is reserved.
alertsType
array
List of alerts.
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
eCertificateScopeType
string
Indicates that OPERA Cloud E-Certificate is available for a specific list of hotels.
actionStatusType
string
Action status of the Track It item(Open, Closed).
thresholdDetailsType
object
Type for the threshold elements.
5 properties
billingInstructionType
object
Configured Billing Instruction which represents a set of Transaction Codes.
3 properties
resInventoryItemSourceType
object
Defines whether the item is setup due to a Rate Plan, Package or a Block.
5 properties
eCertificatesType
array
List of e-certificates for the profile.
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.
childBucketsType
object
Defines children counts with Age Qualifying Group(Child Bucket) classification.
5 properties
rateChangeType
string
Simple type for rate change type.
reservationTransactionDiversionType
object
A Transaction Diversion Rule Type
16 properties
resInventoryItemsType
object
Defines a collection of inventory items attached to a reservation.
2 properties
profileRoutingInstructionsType
object
The type contains routing instructions for the profile.
3 properties
roomRateType
object
47 properties
vIPStatusType
object
VIP status of the customer.
2 properties
reservationTurndownInfoType
object
Turndown information for a reservation
2 properties
reservationRateSummaryType
object
13 properties
foliosShortInfoType
array
This type contains a list of generated bills for a reservation.
channelCreateResvRQInfoType
object
Holds all the channel reservation specific information.
3 properties
resProfileTypeType
string
codeListType
array
futureListType
object
A collection of reservation history details attached to Profiles.
4 properties
customChargeExemptionsType
array
List of Custom Charge Exemptions.
customChargeExemptionType
object
Contains custom charges exemption information.
6 properties
trackItGroup
string
Group to which the Track It items belong.
activityLookUpList
array
Criteria for fetching Activity Bookings.
channelMarketingInfoType
array
Marketing Text like cancel policy, deposit policy etc.
reservationStayHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
packagePostingRhythmType
object
Package Posting rhythm type.
5 properties
associatedResType
object
Information regarding associated reservations to the reservation.
commentType
object
An indication of a new paragraph for a sub-section of a formatted text message.
13 properties
scheduledRoomMoveType
object
Scheduled Move information.
4 properties
nameTypeType
string
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
resDepositPolicyType
object
A deposit policy attached with the reservation.
6 properties
payeeInfoType
object
Payee information.
3 properties
blockIdList
array
Unique Id that references an object uniquely in the system.
resGuestAdditionalInfoType
object
8 properties
nameValueDataTypeType
string
userSessionDefaultsType
object
9 properties
hotelReservationTraceType
object
Extended Trace object to hold information for a reservation.
16 properties
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
linkedReservationInfoType
object
27 properties
membershipType
object
Detailed information of the memberships.
41 properties
attachmentType
object
Attached files.
12 properties
historyListType
object
A collection of reservation history details attached to Profiles.
4 properties
callerType
object
Holds caller information.
11 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
welcomeOfferType
object
2 properties
cashieringPaymentMethodType
object
3 properties
roomStayType
object
26 properties
roomOccupancyType
object
Room Occupancy information.
8 properties
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
assignBlockRateInstructionsType
string
Instructions for rate handling when assigning a block to a reservation.
profileCashieringDetailType
object
The type contains routing instructions for the profile.
5 properties
cancelReservation
object
Request object for canceling reservations.
9 properties
trackItLogListType
array
trackItReservationInfoType
object
Reservation info associated with a Track It item.
9 properties
emailInfoType
object
Information on an email for the customer.
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
ratesType
object
Individual rate amount.
1 property
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
cateringResInfoType
object
Information regarding catering event and catering revenue type associated to the reservation.
2 properties
personNameTypeType
string
Person's name in an external system.
welcomeOfferOptionsType
string
None of the Welcome Offer option is selected.
dateUDFsType
array
Used to hold collection of user defined fields of Date Type.
resCompAccountingType
object
Information regarding comp accounting on the reservation.
3 properties
cancellationActivityType
object
5 properties
dateUDFType
object
Used to hold user defined field of Date Type.
3 properties
uRLInfoType
object
Web site address.
3 properties
guestMessagesType
array
Holds the Message Information
createReservation
object
Request object to create reservations. Includes instructions for information which needs to be returned.
8 properties
resAttachedProfileType
object
4 properties
transactionDiversionDailyDetailsType
array
List of daily details for Transaction Diversion rule.
reservationLocatorType
object
Holds the information for a Reservation Guest Locator
6 properties
taxTypeType
object
Provides information about the Tax Type.
2 properties
linkReservationInstructionType
object
Instructions for a linked reservation.
3 properties
configPackagePrimaryDetailsType
object
A Config Package Info type.
7 properties
externalReferencesType
array
This type contains unique information of external reference.
fixedChargeDetailType
object
Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.
7 properties
reservationPackageType
object
A ReservationPackageType class.
13 properties
cancellationInstructionsType
object
3 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.
marketingPolicyType
string
Indicates the channel policy type like deposit,cancel etc.
employeeInfoType
object
9 properties
profileTypeType
string
The types of Profile handled by the web service.
profileIdList
array
Unique Id that references an object uniquely in the system.
primaryShareTypeType
string
routingInfoListType
array
A routing info object can either be of type Folio OR of type Room with its corresponding instructions.
reservationsInstructionsType
object
Instructions for a reservation.
3 properties
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
links
array
trackItType
object
Identifies the kind of Parcel, Baggage, or Lost items or Valet-managed vehicles or services.
2 properties
awardStatusType
string
Indicates that certificate is in use.
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 properties
eCertificateClassficationType
string
Enumeration of the different type of Ecertificate.
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
customChargeGuestInfoType
object
4 properties
namePrefixType
string
Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
personNameType
object
This provides name information for a person.
8 properties
scopeType
string
Minimum required and complimentary values are applicable Per Stay.
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
amountDeterminationType
string
Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.
resPaymentCardType
object
Information on a credit card for the customer.
19 properties
effectiveRateType
object
Effective rate amount per guest on specific dates.
22 properties
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
6 properties
indicatorsType
array
Collection of lamp indicators.
trackItItemType
object
Detailed information of a Track It item.
14 properties
changeReservation
object
Request method to change a reservations information.
6 properties
timeWindowType
object
Defines a Time period with start time and an end time.
2 properties
roomOwnershipType
object
Define the search criteria for retrieving room ownership records
9 properties
messageStatusType
string
Status of the Message.
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,…
2 properties
telephoneType
object
Information on a telephone number for the customer.
11 properties
transactionDiversionRuleLevelType
string
Reservation level.
channelCancelResvRQInfoType
object
Holds all the channel reservation specific information.
3 properties
reservationRateSummaryDetailType
object
10 properties
hotelReservationInstructionType
object
The Reservation class contains the current reservation being created or altered.
102 properties
nameValueModuleType
string
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.
confDeliveryInfoTypes
array
List of confirmation letter delivery methods and their status
scheduledRoomMoveInfoType
object
Scheduled Move information.
7 properties
preferenceType
object
Guest Preference details for the profile.
8 properties
tierAdministrationType
string
Do not upgrade membership. The membership may be downgraded.
reservationCommissionInfoType
object
2 properties
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
alertGuestInfoType
object
13 properties
configPostingAttributesType
object
A config Package posting attributes type.
14 properties
channelResvStatusType
string
Depicts that the operation was failed.
traceResolveType
object
2 properties
authorizerInfoType
object
Authorizer Information
5 properties
resCommunicationType
object
Communication details for a reservation.
2 properties
channelCreateResvActionType
string
Specifies the reservation action initiated by the Channel. ChannelResvActions : 'Create', 'Book', 'Modify', 'CommittOverrideEdits' and 'Hold' are deprecated an…
masterInfoType
object
2 properties
transportInfoType
object
7 properties
resDepositPoliciesType
array
A list of deposit policies attached with the reservation.
reservationProfileType
object
4 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
reservationMembershipType
object
Detailed information of the memberships.
43 properties
overrideInstructionType
object
Type for Overrides. Contains information for the override action performed while booking a reservation.
6 properties
applicationUserType
object
18 properties
itemInfoType
object
Basic information regarding an Item.
15 properties
basicEmailType
string
Email address
profileCommissionType
object
This is the preconfigured routing instruction type.
7 properties
serviceRequest
object
Service request.
11 properties
identificationType
object
Identification information of the customer.
10 properties
relationshipProfileType
object
12 properties
policyAmountPercentType
object
Defines the percentage basis for calculating the fee amount or the amount.
5 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
channelModifyResvActionType
string
Specifies the reservation action initiated by the Channel. ChannelResvActions : 'Create', 'Book', 'Modify', 'CommittOverrideEdits' and 'Hold' are deprecated an…
masterAccountInfoType
object
numericUDFsType
array
Used to hold collection of user defined fields of Numeric Type.
bookingChannelType
object
2 properties
packageCalculationRuleType
string
Simple type for package caluculation rules.
offsetUnitType
string
Indicates deadline offset unit type.
masterType
string
reservationInstructionType
string
Simple type for reservation instructions that can be used in requests for information which needs to be returned.
resGuaranteeType
object
Reservation Guarantee Details.
3 properties
phoneNumberType
string
Phone number
membershipTypeLevelType
object
2 properties
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
eCertificateConsumeSourceType
string
Indicates that OPERA Cloud E-Certificate is consumed by hotelPMS.
changeReservationDetails
object
5 properties
confRecipientInfoType
object
7 properties
upsellInfoType
object
Information regarding upsell for a reservation.
2 properties
reservationCertificateType
string
Certificate is incentive.
awardKindType
string
Indicates that this is electronic certificate.
preferenceTypeType
object
Preference details for the profile.
12 properties
attachmentsType
array
Attachment List.
guestCountsType
object
A collection of GuestCount by age group.
4 properties
emailType
object
Information on an email for the customer.
10 properties
ticketsType
array
Collection of TicketType objects.
fixedChargeType
object
Holds fixed charge information.
8 properties
confDeliveryInfoType
object
4 properties
uRLType
object
Web site address, in IETF(The Internet Engineering Task Force) specified format.
5 properties
customChargeExemptionDatesType
array
Contains List of Custom Charge Exemption information for a day.
codeInfoType
object
3 properties
companyType
object
14 properties
resStatClassificationType
object
Statistical Classification information for the reservation.
2 properties
trxCodesInfoType
array
List of Transaction codes info.
stayHistoryListType
object
A collection of reservation history details attached to Profiles.
4 properties
resCancelPenaltyType
object
The CancelPenalty class defines the cancellation policy of the hotel facility.
9 properties
reservationAllowedActionsType
array
Allowed action.
vIPType
object
The supplier's ranking of the customer.
2 properties
searchMatchesType
array
List of Generic Name-Value-Pair Parameters used for super search matches.
reservationDisplayColorInfoType
object
Information of reservation display color, determined based on OPERA Cloud parameter RESERVATIONCOLORDEFINITION
3 properties
languageType
string
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
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
8 properties
scheduledRoomMoveStatusType
string
Flag indicating scheduled room move status.
userInfoType
object
Opera User Information
2 properties
trackItItemsType
array
requestActionType
string
confirmationType
object
10 properties
reservationPreConfiguredRoutingInstructionsType
object
1 property
reservationBlockType
object
Key information about the block for a reservation.
3 properties
fixedChargeFrequencyType
string
Yearly.
resCancellationPoliciesType
array
A list of reservation cancellation policies.
anonymizationStatusType
string
Guest has been anonymized.
characterUDFType
object
Used to hold user defined field of Character/String Type.
3 properties
policyDeadlineType
object
Cancellation deadline, absolute or relative.
4 properties
childAgeType
object
Defines Child's Age.
1 property
packageElementType
object
15 properties
payloadType
string
Fiscal Payload Type.
externalReferenceType
object
This type contains unique information of external reference.
3 properties
profileType
object
Type provides the detailed information about the profile and its children.
39 properties
paragraphType
object
An indication of a new paragraph for a sub-section of a formatted text message.
1 property
anonymizationType
object
Provides information about guest's anonymization status.
1 property
hotelInterfaceTypeType
string
XML Posting Interface
reservationLocatorsType
array
Holds the Locator Information.
reservationRoomOwnershipType
string
Indicates if the assigned reservation room is an Owner/Referral or Regular room.
resAccompanyGuestInfoType_2
object
9 properties
stayInfoType_2
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
reservationDailyRateDetail
object
Request for validating Daily Rate Details modifications.
5 properties
searchReservationsSummaryRequest
object
20 properties
registerTurnaway
object
Request to register turn away reservation.
4 properties
reservationSearchType
string
itemHoldIDListType
array
ID of an Hold Item
reservationsSummary
object
Response object to the Fetch Reservations information. Based on the criteria, reservation information is returned.
3 properties
lastCommittedResvType_2
object
5 properties
bedTypeInfoType
object
Information representing Bed type associated with a room type.
2 properties
extendReservationLock
object
Operation for extending the lifetime of a lock on a reservation.
5 properties
upgradeElgibilityStatusType
string
Simple type for upgrade eligibility status.
sellMessages
object
This is the Response Message Type to the request for retrieving Sell Messages.
3 properties
script
object
Script for a Reservation based on its StayDetails as well as itinerary.
3 properties
colorType_2
string
Color configuration type. This color configuration provides a visual category of entities.
bookingChannelMappingType
object
4 properties
hotelReservationOrderBy
string
alertType_2
object
24 properties
transactionDiversionsDetails
object
Response Body.
2 properties
reservationLocatorsDetails
object
Response object for creating new Notes for the hotel.
3 properties
reservationAddOnPackagesType
object
A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges.
3 properties
upgradeEligibilityListType
array
List of upgrade Eligibility Types.
masterAccountSummaryType
object
Minimal information of the posting master reservation that can be used to identify the reservation uniquely.
7 properties
linkedHotelReservationsType
object
A collection of Linked Reservation objects and Unique IDs of Reservation.
4 properties
linkReservationsCriteria
object
Request to link a list of reservations with another existing reservation.
6 properties
rateInfo
object
Response will either be Summary or Detail type, but not both. See the request for the summary attribute flag.
4 properties
reservationLocatorsStatus
object
Response Body.
2 properties
attachDetachType_2
object
This type contains attach and detach information for accompanying guest profile.
3 properties
fetchReservations
object
4 properties
scheduledRoomMoveDetailType
object
Scheduled room move information.
2 properties
turnawayDetailsType
object
Holds detailed information of a prospect reservation to be turned away.
9 properties
prepaidCardType_2
object
Holds fixed charge information.
15 properties
checkReservationsType
array
Collection of reservations and the status of its allowed actions, attached records, and indicators.
reservationProtectionType
object
Reservation Protection information related to the reservation.
1 property
departureReservationInfoType_2
object
Key information about the departure reservation.
2 properties
reservationConfLettersType
object
Reservation information and the confirmation letters type attached with it.
2 properties
copyReservation
object
Request for copying a reservation's information as a template for a new reservation.
3 properties
packageQuantityInfoType
object
Information regarding a single package quantity
3 properties
searchHotelReservationsRequest
object
158 properties
travelAgentDetails
object
Travel Agent Details
2 properties
recentlyAccessedReservationType
object
A recently used reservation record.
10 properties
checkReservationType
object
Reservation and the status of its allowed actions, attached records, and indicators.
3 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
2 required
reserveInventoryItems
object
Request object to reserve inventory Items for a reservation.
6 properties
awardUpgradeDetailType
object
3 properties
flexFieldsResponse
object
Response object for flex fields.
9 properties
changeDepositPolicyDetails
object
Response Body.
2 properties
changeSharingGuests
object
Request to change Sharing Reservations Guest Counts(adults or children) information.
3 properties
fiscalInfoType_2
object
Fiscal related information for a reservation.
3 properties
profileDeliveryMethod_2
object
Delivery Information type to the profile.
7 properties
sharingGuestType
object
The Reservation class contains the current reservation with the guest counts(adults or children).
3 properties
packageInfoType_2
object
Package information related to a reservation
11 properties
reservationLocatorsInfo
object
Request object for changing hotel Notes for hotels.
5 properties
reservations
array
Unique identifier for a reservation.
postingIntervalFrequency
string
Specifies the frequency at which charges are posted for the rate plan on the reservation.
addressType_2
object
Provides address information.
18 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
callStatisticsType
object
Holds Call Statistics Information.
6 properties
reservationLocatorsDetailsInfo
object
Request object for creating new Notes for the hotels
5 properties
searchPreConfiguredRoutingInstructionsRequest
object
19 properties
reservationOrderBy
string
awardUpgradeSummaryType
object
9 properties
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
upsellDailyRatesType
array
Reservation date and its corresponding upsell rate amount
resExpectedTimesType_2
object
Holds the Arrival and Departure Time Information
2 properties
messageDeliveryType_2
object
Holds the Delivery Information of the Message
8 properties
validationReturnType
object
Validations type record returned after Validations are done.
5 properties
upsellType
object
Holds upsell information
10 properties
roomInfo
object
Room details
6 properties
roomCalendar
object
3 properties
distinctIDType
object
Unique identifiers for both internal and external systems Eg: ReservationId, ConfirmationNumber, CancellationNumber, ExternalReferenceNumber etc
3 properties
roomCalendarResType
object
Reservation Information for a Reservation Item in the Calendar.
21 properties
unavailableItemInstructionType
string
trackItLogType_2
object
Individual activity log related to the Track It ticket.
9 properties
resvMessageType
object
Holds the Message Information
18 properties
createGuestMessages
object
Request object for creating the Guest Messages for a Reservation.
5 properties
copyReservationPaymentMethodsType
object
A collection of Reservation Payment Methods.
3 properties
transactionDiversions
object
Response to fetch the transaction diversion rules attached to a reservation.
3 properties
groupDetails
object
Group Details
2 properties
operaVersion
object
Response for Ping operation.
3 properties
confirmationLettersDetails
object
Response object after creating a confirmation letter.
6 properties
companyDetails
object
Company Details
2 properties
bookingTimeSpanType_2
object
The booking time span of the reservation, only applicable when time increments are being used.
2 properties
cancelReservationType_2
object
The Reservation class contains the current reservation being created or altered.
56 properties
externalReservationFetchInstruction
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
reservationInfoType_2
object
The Reservation class contains the current reservation being created or altered.
60 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
preConfiguredRoutingInstrType
object
Routing can be promotion code complimentary routing or profile routing.
8 properties
fetchActivityBookingsType_2
object
Used in the request message to describe the "filtering Criteria" when executing an activity lookup.
5 properties
dailyRateDetailType
object
Rate details for the different dates of a reservation.
15 properties
reservationPackageScheduleType_2
object
A HotelPackageSchedule type.
21 properties
hotelReservationType_2
object
The Reservation class contains the current reservation being created or altered.
110 properties
guestMessages
object
Response object to the request to retrieve Guest Messages for a Reservation.
8 properties
profileMembershipType_2
object
Detailed information of the memberships.
40 properties
depositPaymentType
object
Request to post a deposit payment to a reservation.
1 property
checkInstructionType
string
Simple type that corresponds to check reservation instructions.
shareReservations
object
Response for the fetch share reservation request. This returns all sharer reservations including the request reservation.
3 properties
roomScheduleType
object
Holds TimeSpan and Reservation Information.
6 properties
masterAccount
object
Request for CreateMasterAccount operation.
3 properties
colorDefinitionType_2
string
Color definition type. This color definition type is used to determine the defintion of color
cancellationReasonType_2
object
2 properties
dateTimeStampGroupType_2
object
5 properties
sortOrder
string
awardUpgradeInfoType
object
8 properties
reservationValidationInstructionType
string
Instruction to validate CompRouting Instructions attached to a reservation.
masterAccountSummary
object
Response for ChangeMasterAccount operation.
3 properties
recentlyAccessedReservationsType
array
A single recently accessed reservation.
activityLogListType
object
7 properties
splitMultiRoomReservation
object
Request to split multi-room reservation into separate reservations.
8 properties
awardType_2
object
Detailed information of the awards.
32 properties
changeLinkedReservationType
object
Request object to change a linked reservation information.
2 properties
linkedReservationsCommonDetails
object
Response object for updating linked reservations details.
3 properties
changeResvGuestMessages
object
Request object for updating the Guest Messages for a Reservation Workspace.
4 properties
tickets
object
Common tickets request base type.
3 properties
status
object
Response Body.
2 properties
confirmationLetters
object
Request object to create a confirmation letter.
6 properties
sellMessagesType
object
The SellMessagesType is the list of message and attributes returned by web service.
4 properties
deliveryHistoryLog
object
Response that contains fetched reservation's delivery history.
3 properties
validationsReturnType
array
futureReservationsOrBlocksDetails
object
This is the Response Message to information regarding existence of future reservation or business blocks.
3 properties
registerCall
object
Request to register call. Either creates a new call or updates an existing call.
3 properties
packageCategoryReservations
object
Response object to the Fetch Reservations by package request operation. Based on the criteria, reservation information is returned.
4 properties
hotelReservationStatusType
string
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
flexFieldValues
object
Request object for flex fields values.
3 properties
reservationMembershipAwardType_2
object
This type contains information of a membership award attached to a reservation.
14 properties
advanceCheckInType_2
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
4 properties
resRevenueBalanceType_2
object
Revenue and Balance Amount summary for the reservation.
10 properties
roomCalendarDisplayType
object
Display Information for the Room Calendar.
2 properties
combineShareFromProfileType
object
Type for the profile information to create a new share reservation. This is used to create sharers from profiles.
8 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…
linkedReservationsInfo
object
3 properties
messageType_2
object
Holds the Message Information
5 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
callStatistics
object
Response object to the request to retrieve Call Statistics.
3 properties
reservationCancellationPolicyCriteriaType
object
A cancellation policy attached with the reservation.
7 properties
currentRoomInfoType_2
object
Room information of the reservation for the current day.
8 properties
reservationAlerts
object
Request object to create or update multiple alerts information for multiple reservations in bulk.
3 properties
overlappingStayInfoType
object
Possible overlapping stay information of a reservation.
6 properties
deliveryMethodType
string
PRINT
hotelReservationFetchInstruction
string
checkReservationsDetails
object
Response for checking allowed actions, existence of attached records, or indicators of a reservation.
3 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
eCertificateIssueSourceType_2
string
Indicates that OPERA E-Certificate is issued by external system.
certainNightsOfTheWeek
object
Supports the 'Certain Nights Of The Week' trace frequency option by indicating on which days traces should be generated.
7 properties
linkedHotelReservations
object
Return object for retrieving linked reservations.
3 properties
preArrivalReviewStatusType
string
Simple type for Pre-Arrival Review Status.
reservationAlertsListType
array
Holds multiple alerts for a single reservation. Reservation will be identified by a unique identifier/ list of unique identifiers.
guestMessageType_2
object
Holds the Message information for a Reservation
12 properties
componentBlockOutDates
object
2 properties
statusType
string
Status of the batch process.
traceTimeInfoType_2
object
4 properties
callStatisticsListType
array
Holds Call Statistics Information.
resGuestInfoType_2
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
28 properties
changeShareRateAmountType
object
Type for changing the Rate Amount of a Sharer.
3 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…
roomOwnerStatusType
string
Enumeration of different ownership statuses of room
reservationDates
object
Reservation Dates
6 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
depositCancelConfigCriteriaType
object
Criteria for calculating the deposit/cancellation amount based on a reservation, policy code, amount or percentage.
7 properties
searchReservationsRequest
object
133 properties
postDeletePreCheckInReservationRequest
object
58 properties
reservationDepositPaymentCriteriaType
object
Criteria for posting a deposit payment to a reservation.
7 properties
scheduledRoomMoveResponseType_2
object
Scheduled Room Move information.
3 properties
mergeReservationsStatus
object
Response Body.
2 properties
reservationPreference
object
Response for the reservation's preferences.
3 properties
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
activityLog
object
Response object for the request for the reservation user activity log.
3 properties
payeeSharerInfoType
object
Holds the information to mark or unmark a shared reservation as a payee sharer.
4 properties
routingInstructions
object
Response object containing routing instructions for a reservation.
3 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
activityList_2
array
A collection of Activity objects.
commentInfoType_2
object
Comment related to the profile/reservation.
8 properties
reservationConfLettersListType
array
Reservations information and the confirmation letters type attached with them.
reservationPreferenceDetails
object
Response Body.
2 properties
reservationCancellationPolicyCriteria
object
Request type to create a cancellation policy for a reservation.
3 properties
upsellDailyRateType
object
Reservation date and its corresponding upsell rate amount
2 properties
eCertificateStatusType_2
string
Indicates that OPERA E-Certificate is reserved.
combineShareInstructionType
object
Instructions for overriding checks during combine share operation.
7 properties
eCertificateScopeType_2
string
Indicates that OPERA E-Certificate is available for a specific list of hotels.
queueTextInfoType_2
object
Information regarding the message sent to guest.
2 properties
recentlyAccessedReservations
object
Response with the fetched recently accessed reservations.
3 properties
amountPointsType
object
Holds monetary value expressed with a currency code / number of points
2 properties
validatePoliciesType
object
Request object to fetch deposit and cancellation policies.
10 properties
reservationStatusType
string
Simple type for indicating the reservation status.
roomRateType_2
object
52 properties
linkedReservationsCommonDetailsType
object
Details common to all linked reservations.
1 property
moveReservationHotelCriteriaType
object
7 properties
roomMoveDetailType
object
Room move history information.
8 properties
reservationLock
object
Operation for requesting a lock on a reservation.
6 properties
reservationDepositPolicyCriteriaType
object
A deposit policy attached with the reservation.
8 properties
discrepancyEnum
string
reservationLocators
object
Response object response to retrieve Guest Messages for a Reservation.
3 properties
sellMessageType
object
The SellMessagesType defines the standard attributes that will be retrieved with the sell message.
16 properties
eCouponsInfo
object
Request object for changing the existing eCoupons attached to Reservation.
5 properties
promotionsType
array
Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.
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
commentType_2
object
An indication of a new paragraph for a sub-section of a formatted text message.
13 properties
translationTextType80
object
Contains Multiple translated texts and language codes.
2 properties
awardUpgrades
object
Response object for available award upgrades.
3 properties
guestMessagesDetails
object
Response object to the request to create Guest Messages for a Reservation.
3 properties
scheduledRoomMoveType_2
object
Scheduled Move information.
5 properties
resvIdentificationInfoType
object
Information on the identification of the customer.
4 properties
roomMoveDetailsType
array
List of room move details
reservationPreferenceInfo
object
Method to change a reservation preference on an existing reservation.
5 properties
reservationsUpgradeEligibilityDetails
object
Response Body.
2 properties
reservationArrivalInfoType
object
Type describing information regarding the arrival of a reservation.
1 property
sellMessageConfig
object
This is the request message type for sell message update operation.
3 properties
hotelReservationTraceType_2
object
Extended Trace object to hold information for a reservation.
18 properties
guaranteeRequirementsType
object
Specifies various requirement for the guarantee code.
10 properties
linkedReservationInfoType_2
object
27 properties
membershipType_2
object
Detailed information of the memberships.
41 properties
callHistory
object
Response that contains either the fetched call history if was successful or error(s) if not.
3 properties
overlappingStayDetails
object
Response for checking overlapping stays of reservations.
3 properties
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
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…
searchRateInfoRequest
object
23 properties
roomStayType_2
object
28 properties
overlappingStayInfoListType
array
Overlapping stay information of a reservation.
roomFeaturesType
array
A recurring element that identifies the room features.
roomOccupancyType_2
object
Room Occupancy information.
9 properties
cancelReservation_2
object
Request object for canceling reservations.
10 properties
masterAccountType
object
Details of the posting master reservation.
13 properties
trackItReservationInfoType_2
object
Reservation info associated with a Track It item.
9 properties
resGuestType_2
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
tieredCancelPenalty
object
Type for a tiered cancellation penalty that is configured and attached to a tiered cancel penalty schedule.
6 properties
upgradeEligibilityType
object
Reservation name ids, hotel code and eligibility flag.
3 properties
externalReservationStatusType
string
sortOrderEnum
string
reservationConfirmationLetters
object
Response object to the request to fetch a list of reservations for which confirmation letters need to be sent.
3 properties
reservationRoutingCriteria
object
Request to create a routing instruction.
3 properties
translationTextType2000
object
Contains Multiple translated texts and language codes.
2 properties
checkDistributionReservationsSummaryType
object
Reservation Statistics and the status of its allowed actions, attached records.
15 properties
traces
object
Return object to the request for information regarding traces.
3 properties
createReservation_2
object
Request object to create reservations. Includes instructions for information which needs to be returned.
8 properties
reinstateReservation
object
Overriding the validation check will log the supposed errors in the warnings log if they would fail.
12 properties
resAttachedProfileType_2
object
4 properties
reservationUpsellInfo
object
Response object to the that contains information for a reservation prior to upgrade.
3 properties
paymentTypesType
array
Payment card code like AX,VI etc.
preArrivalMemberReservationsDetails
object
3 properties
combineShareReservationsType
object
Record Type for Combining Share Reservations.
9 properties
transactionDiversionsInfo
object
Request to modify transaction diversion rules attached to a reservation.
5 properties
reservationLocatorType_2
object
Holds the information for a Reservation Guest Locator
6 properties
reservationsUpgradeEligibility
object
Request object containing a list of reservation name ids, hotel code and eligibility flag.
3 properties
reservationsToMerge
object
Request method to Merge reservations.
5 properties
fetchSellMessageConfig
object
This is the fetch response message type for fetch operation of sell messages.
3 properties
shareReservationsType
array
validateReservationChanges
object
Request to validate reservation changes.
5 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
translationsTextType
array
Language code for the translation.
roomFeatureType
object
Room Feature Information.
4 properties
preCheckInDetailsType
object
Type describing the different details regarding a pre-registered reservation.
6 properties
sellMessageConfigsType
object
The SellMessageConfigsType is the list of sell messages, each comprising of all the sell message attributes and other details.
4 properties
reservationSummaryListType
array
List of Reservations.
resvGuestMessageType
object
List of Guest Messages
13 properties
reservationPackagesInfo
object
Request method to attach a package to an existing reservation.
5 properties
routingInstructionsInfo
object
Request when changing a routing instruction.
3 properties
roomScheduleCategoryType
string
Enumeration of the different Room Schedule Types.
shareDistributionCriteria
object
Extended Reservation object to hold additional instructions along with the reservation. This should be used for updates on the reservation.
2 properties
tieredDepositRule
object
Type for a tiered deposit rule policy that is configured and attached to a tiered deposit rule schedule.
6 properties
reservationsInstructionsType_2
object
Instructions for a reservation.
3 properties
reservationAllowedActionType_2
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
checkResultsType
array
Collection of status of allowed actions, attached records, and indicators of the reservation.
roomCalendarInfoType
object
Holds hotel Room and Reservation Information.
9 properties
reservationsInformationType
object
Reservations Information.
39 properties
resSharedGuestInfoType_2
object
Contains information regarding the share reservation.
5 properties
hotelReservationAllowedAction
string
createReservationType
object
Create Reservation Response Type
4 properties
moveReservationHotel
object
Request for moving a reservation and its valid sharers to a different hotel.
3 properties
cancellationHistory
object
Response object to the request to retrieve cancellation history for a reservation.
3 properties
reservationAlertsType
object
Hold the multiple alerts for a single reservation which is identified by a unique identifier.
3 properties
preConfiguredRoutingInstrListType
array
Set of Pre-Configured Routing Instructions.
reservationStatusEnum
string
cancelReservationsInstructionsType
object
The instructions to be applied for the reservations that are being cancelled.
4 properties
reservationSummaryType
object
5 properties
reservationPreCheckInDetailsType
object
Type describing the different details regarding a pre-registered reservation including ID.
3 properties
changeReservation_2
object
Request method to change a reservations information.
6 properties
upsellRateInstructionType
string
Instruction to remove the upsell and recalculate the rate based on the upsell target room type.
splitMultiRoomReservationDetails
object
Response for splitting multi-room reservation into separate reservations.
4 properties
reservationReversePolicyCriteriaType
object
Reverse policy information of a reservation.
3 properties
periodicFolioEnum
string
reservationChannelInfoType
object
Holds all the channel reservation specific information.
3 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
preCheckInReservation
object
Request to pre-register a reservation eligible for pre-registration and change arrival details.
4 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
inventoryItems
object
Return object to the request for information regarding inventory Items reserved for a reservation.
3 properties
telephoneType_2
object
Information on a telephone number for the customer.
11 properties
uniqueID_Type_2
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
packageCategoryReservationType
object
Information regarding each reservation being returned in the response
14 properties
reservationRateSummaryDetailType_2
object
12 properties
copyReservationType
object
4 properties
hotelReservationInstructionType_2
object
The Reservation class contains the current reservation being created or altered.
106 properties
sellMessageConfigType
object
Only one of the following can hold a value: HotelCode, CROCode or ChainCode
19 properties
checkDistributionReservationsSummary
object
Response for checking allowed actions, existence of attached records, or count of reservations.
6 properties
reservation
object
Return object to the request for information regarding a reservation.
5 properties
scheduledRoomMoveInfoType_2
object
Scheduled Move information.
7 properties
combineShareFromExistingReservationType
object
Details of the existing reservation to be combined as a sharer.
2 properties
reservationLockDetails
object
This response will indicate whether the requested lock has been granted or some other user owns the lock.
4 properties
resvGuestMessagesType
array
Holds the Message Information
shareReservationType
object
2 properties
hotelReservationSearchType
string
reservationGuaranteesPolicies
object
Response object to fetch reservation guarantees.
3 properties
promoCodeCompRoutingType
object
Promotion Code Complimentary Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit
11 properties
computeCancellationPoliciesDetails
object
Response for the cancellation rules configuration request. Contains computed details for the cancellation rules requested.
3 properties
turnawayType
object
Holds information related to prospect reservation to be turned away.
6 properties
changeGuestMessages
object
Request object for updating the Guest Messages for a Reservation.
5 properties
transportInfoType_2
object
7 properties
cancelReservations
object
Request to submit batch cancel reservations.
3 properties
reinstateReservationDetails
object
Response Body.
2 properties
responseInstructionsType
string
Enumeration of the different return modes of a response.
reservationsDetails
object
Response object to the Fetch Reservation Request operation. Based on the criteria, reservation information is returned.
4 properties
preArrivalMemberReservationType
object
4 properties
dateTimeSpanType_2
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
reservationMembershipType_2
object
Detailed information of the memberships.
43 properties
channelResvRQInfoType
object
Holds all the channel reservation specific information.
3 properties
preConfiguredRoutingInstructions
object
This is the Response Message to the request for Pre-Configured Routing Instructions.
3 properties
externalReservationOrderBy
string
cancelReservationsType
object
Criteria for submitting batch cancel reservations.
4 properties
upsellReservation
object
Request to upsell a reservation.
6 properties
scheduledRoomMoveDetails
object
Details regarding a specific scheduled room move.
2 properties
operaLockRecordType
string
awardUpgradeSummariesType
array
Summary information related to award upgrade.
guestDetails
object
Guest Details
9 properties
guaranteePolicyType
object
Specifies Guarantee Code attributes.
12 properties
externalReservationSearchType
string
operaRecordLock
object
This type contains information about a record lock.
8 properties
reservationPaymentMethods
object
Method to create a reservation's payment methods.
5 properties
checkResultType
object
Status of allowed actions, attached records, and indicators of the reservation.
2 properties
searchExternalSystemReservationsRequest
object
103 properties
1 required
changePackageQuantityType
object
Request object to update package quantity for package codes.
1 property
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.
ticketsInfo
object
Common tickets request base type.
5 properties
awardUpgradeDetailsType
array
Daily Details related to award upgrade.
addOnReservationPackageType
object
AddOn ReservationPackageType class.
11 properties
bookingChannelType_2
object
2 properties
reservationAttachments
object
Return object to the request for information regarding reservation attachments.
3 properties
reservationDailyRateDetailDetails
object
Response after validating the changes for Daily Rate Details modifications.
4 properties
activityLogType
object
12 properties
reservationInstructionType_2
string
Simple type for reservation instructions that can be used in requests for information which needs to be returned.
resGuaranteeType_2
object
Validations type record returned after Validations are done.
3 properties
scheduleRoomMoveType
object
Type of room move scheduled either from or to information
4 properties
eCoupons
object
Response object for fetching the eCoupons attached to 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
eCertificateConsumeSourceType_2
string
Indicates that OPERA E-Certificate is consumed by hotelPMS.
overlappingStay
object
Request to check for overlapping stays of reservations.
3 properties
reservationPolicies
object
Response that contains deposit and cancellation policies attached with the reservation.
4 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
fetchInstructionType
string
attachCertificate
object
Request to attach certificate to the Reservation.
3 properties
confRecipientInfoType_2
object
8 properties
roomTypeAttributesType
object
Attributes of property room type.
6 properties
rateSearchType
object
Room Rate associated with a particular segment of the Stay.
8 properties
reservationAwards
object
Response of fetch awards for a reservation.
3 properties
preferenceTypeType_2
object
Preference details for the profile.
12 properties
membershipDetails
object
Membership Details
5 properties
emailType_2
object
Information on an email for the customer.
10 properties
packages
object
Response to fetch package availability with the data, success and warnings or errors.
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
reservedInventoryItemsInfo
object
Request object to change the reserved inventory Items for a reservation.
5 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.
confDeliveryInfoType_2
object
4 properties
addOnReservationPackagesType
object
A collection of Reservation packages.
5 properties
resvRoutingCriteriaType
object
A routing info object can either be of type Folio OR of type Room with its corresponding object.
8 properties
combineShareFromProfilesType
array
Type for the profile information to create a new share reservation. This is used to create sharers from profiles.
reservationsSummaryInformationType
object
Reservations Summary.
6 properties
breakShareValidationsDetails
object
Response for the Break Share Validation request. This returns all validation messages for the operation.
3 properties
reservationDisplayColorInfoType_2
object
Information of reservation display color, determined based on OPERA parameter RESERVATIONCOLORDEFINITION
3 properties
reservationDepositPolicyCriteria
object
Request type to create a deposit policy on a reservation.
3 properties
deliveryHistoryType
object
14 properties
changeLinkedReservationsCommonDetails
object
Request object for updating linked reservations details.
1 property
changePayeeSharerType
object
Request object to to mark or unmark the payee sharer information.
1 property
alerts
object
Response with the fetched alerts, includes global alerts, notes and undelivered guest messages.
5 properties
roomCalendarType
object
Room Calendar entry that holds Room and Reservation Information.
5 properties
policyDeadlineType_2
object
Cancellation deadline, absolute or relative.
4 properties
linkedHotelReservationType
object
The Reservation class contains the current reservation being created or altered.
96 properties
roomTypeInfoType
object
20 properties
computeDepositPoliciesDetails
object
Response for the deposit rules configuration request. Contains computed details for the deposit rules requested.
3 properties
flexFieldValueType
object
Provides the details of a flex field values
2 properties
profileType_2
object
Type provides the detailed information about the profile and its children.
39 properties
roomReadyStatusType
string
validateReservationChangesDetails
object
Response for validating reservation changes.
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle Hospitality 12
Other APIs Oracle Hospitality publishes across the network.
OPERA Cloud RnA Activities GraphQL API
OPERA Cloud RnA ARAccountsReceivable GraphQL API
OPERA Cloud RnA ARAgingReport GraphQL API
OPERA Cloud RnA ARLedger GraphQL API
OPERA Cloud RnA BookingReservationExtended GraphQL API
OPERA Cloud RnA BookingsBlockProductionChanges GraphQL API
OPERA Cloud RnA BookingsBlockStatusChanges GraphQL API
OPERA Cloud RnA BookingsBlock GraphQL API
OPERA Cloud RnA BookingsReservation GraphQL API
OPERA Cloud RnA CateringEventForecast GraphQL API
OPERA Cloud RnA CateringEventPostings GraphQL API
OPERA Cloud RnA CateringEventStatusChanges GraphQL API
#Reservation
Where this information came from
This is an independent, third-party profile of Oracle Hospitality Reservation API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.