Oracle Hospitality Availability API
The Availability APIs allow you to manage a properties room-rate availability, which is configured for a channel. This also includes operations to manage restrictions and hurdles.
Oracle Hospitality Availability 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 Availability. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 34 operations across 29 paths, and defines 402 schemas. It is described by OpenAPI 3.2.0, at version 26.2.0.0.
Requests are made against 3 base URLs: /chl/v1, /par/v1, /rtp/v1.
34 operations
29 paths
402 schemas
2 DELETE22 GET6 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 34
Across 29 paths, the API surfaces 34 operations — 2 DELETE, 22 GET, 6 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Availability 34
The Availability APIs allow you to manage a properties room-rate availability, which is configured for a channel. This also includes operations to manage restrictions and hurdles.
GET
/availability/summarydeprecated
Gets the regional rate parity
GET
/hotels/{hotelId}/channels/{channelCode}/rooms/{roomTypeCode}/inventorySnapshotdeprecated
Gets hotel room's restrictions and channel availability
GET
/hotels/{hotelId}/generalAvailabilitySimulatordeprecated
Gets the General Availability
GET
/hotels/{hotelId}/inventorySnapshotdeprecated
Gets hotel's rooms and restrictions channel availability
GET
/hotels/{hotelId}/rateParitydeprecated
Gets channel's rate configuration
GET
/availabilitydeprecated
Get Hotel Availability
POST
/availability/searches
Get Hotel Availability
GET
/hotels
Search hotels for the sales process
GET
/hotels/{hotelId}/analyzeRateAvailabilitydeprecated
Analyze Rate Availability
POST
/hotels/{hotelId}/analyzeRateAvailability/searches
Analyze Rate Availability
GET
/hotels/{hotelId}/availabilitydeprecated
Get Hotel Availability
GET
/hotels/{hotelId}/availability/alternatedeprecated
Get Alternate Availability
POST
/hotels/{hotelId}/availability/alternate/searches
Get Alternate Availability
POST
/hotels/{hotelId}/availability/searches
Get Hotel Availability
GET
/hotels/{hotelId}/availableUpsells
Get for Available Up-sells
GET
/hotels/{hotelId}/guarantees
Get Reservation Guarantee
GET
/hotels/{hotelId}/hurdles
Get Hurdle Rates
POST
/hotels/{hotelId}/hurdles
Create Hurdle Rates
PUT
/hotels/{hotelId}/hurdles
Change Hurdle Rates
DELETE
/hotels/{hotelId}/hurdles
Delete Hurdle Rates
GET
/hotels/{hotelId}/rates
Get the Rate Plan Information
GET
/hotels/{hotelId}/rates/{ratePlanCode}
Get Rate Plan Information
GET
/hotels/{hotelId}/restrictions
Get the Restrictions
POST
/hotels/{hotelId}/restrictions
Create a Restriction
PUT
/hotels/{hotelId}/restrictions
Clear all Restrictions
DELETE
/hotels/{hotelId}/restrictions/{restrictionId}
Delete a Restriction
GET
/hotels/{hotelId}/restrictionsHistory
Get the Restriction history
PUT
/hotels/{hotelId}/validateGuarantees
Get Reservation Guarantee
GET
/hurdles
Get multiple property Hurdle Rates
GET
/services/availability/status
Get the Availability Service version
PUT
/upsert/hotels/{hotelId}/hurdles
Create/Change Hurdle Rates
GET
/hotels/{hotelId}/rates/coupons/{couponCode}
Validate a coupon code
GET
/hotels/{hotelId}/rates/promotions/{promotionCode}
Validate a promotion code
GET
/hotels/{hotelId}/rates/promotionsCoupons
Validate promotion and coupon code
Schemas 402
The contract defines 402 schemas that model the data the API accepts and returns. The most detailed are searchHotelAvailabilityCRORequest (57 properties), profileType (53 properties), searchHotelAvailabilityRequest (52 properties), reservationInfoType (51 properties). Each schema is shown below with its type and property counts.
translationsTextType
array
Language code for the translation.
availableRoomType
object
Room Type and Room Rate combination.
6 properties
channelInventoryType
object
Inventory statistics and restrictions. This can have no code (House level), BookingChannelCode, or ChannelRoomType to represent the different levels.
3 properties
generalAvailSimulatorType
object
Room Type and Room Rate combination.
9 properties
hotelMappingType
object
4 properties
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
enhancedDescriptionType
object
This type holds enhanced room/rate description.
6 properties
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
sellOrderType
string
Channel Sell By which may be RATEROOM, RATE or ROOM.
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
2 required
regionalRateParityType
object
Information on Room Rate Parity among Channels/Property
6 properties
additionalDetailType
object
3 properties
channelInventorySnapshotType
object
The evaluated channel inventory snapshot statistics based on the search criteria given.
2 properties
rateParity
object
Response object to fetch Rate Parity.
3 properties
additionalAmountListType
array
availableRatePlanType
object
Room Type and Room Rate combination.
6 properties
translationTextType2000
object
Contains Multiple translated texts and language codes.
2 properties
bookingChannelMappingType
object
4 properties
translationTextType50
object
Contains Multiple translated texts and language codes.
2 properties
regionalRateParity
object
Response object to fetch regional rate parity.
3 properties
channelInventorySnapshotInventoriesType
object
Collection of inventory statistics and restrictions for a hotel in relation to booking channels.
2 properties
hotelChannelInfoType
object
3 properties
channelInventorySnapshot
object
Response object containing the room availability and restrictions for a hotel in relation to booking channels.
3 properties
channelSnapshotType
object
Inventory statistic and restriction information for a given date.
7 properties
rateParityType
object
Information on Room Rate Parity among Channels/Property
6 properties
generalAvailabilitySimulator
object
Response object to simulate general availability.
3 properties
restrictionInfoStatusType
object
The RestrictionStatusType is used to indicate the type of restriction applied. An enumerated restriction type is defined in the attribute group.
14 properties
regionalParityGroupType
object
Channels and Property Group wise Rates for Room Type and Rate Plan combination.
5 properties
additionalAmountType
object
3 properties
regionalParityRateType
object
Rate on specific arrival date.
7 properties
parityRateType
object
Minimum and Maximum Rate on specific arrival date.
18 properties
restrictionStatusesType
string
restrictionsInfoType
array
Provides the basic Restriction type details, specifically used in snapshot operations for efficiency.
parametersType
array
Collection of generic Name-Value-Pair parameters.
warningsType
array
Used in conjunction with the Success element to define a business error.
parityRoomRateType
object
Rate for Room Type and Rate Plan combination.
5 properties
parityGroupType
object
Channels and Property Group wise Rates for Room Type and Rate Plan combination.
5 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
links
array
additionalDetailListType
array
restrictionInfoType
object
1 property
bookingChannelInfoType
object
5 properties
channelInventorySnapshotMasterInfoType
object
Details about the booking channels and room types contained in the channel inventory snapshot.
2 properties
reservationQueueInformationType
object
Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
6 properties
cardReIssueType
string
Request to re issue a new card.
resAccompanyGuestInfoType
object
5 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…
36 properties
configPackageUsageDetailType
object
A Config Package Usage Detail type.
4 properties
policyBasisTypeType
string
Full Amount.
salesInfoType
object
Provides sales information about the profiles of type company, travel agent, source and contact.
13 properties
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
profileSubscriptionListType
array
Details of the OPERA Profile subscription to external system
pkgInventoryItemType
object
4 properties
negotiatedType
object
This holds a list of NegotiatedInfoType.
3 properties
characterUDFsType
array
Used to hold collection of user defined fields of Character/String Type.
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
imageStyleType
string
An enumeration of image styles.
addressInfoType
object
Provides address information.
3 properties
restrictionsByDateRangeType
object
Restriction by date range for the requested Hotel.
10 properties
restrictionSetType
object
Indicates Restriction set applicable for the date range.
14 properties
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
roomTypeYieldableType
string
Simple type for Yieldable or Non Yieldable
eCertificateInfoType
object
E-Certificates details.
14 properties
customerType
object
Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
26 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…
hotelAvailability
object
Response object to search hotel availability based on request segment.
3 properties
profileSubscriptionType
object
Contains details of the profile subscription. The subscription represents the link between the OPERA profile and the external profile within a particular exter…
9 properties
rateChangeTypeType
string
Indicates the rate amount returned is first night or highest rate.
hotelNotesType
array
List of Notes of the hotel.
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
cardProcessingType
string
reservationHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
alternateHotelType
object
28 properties
hotelContactRolesType
array
Lists of HotelContactRoles of the hotel.
clearAllRestrictions
object
Request object for clearing all restrictions based on date.
4 properties
restaurantCategoryType
string
Simple type for Hotel Restaurant.
packageConsumptionType
object
Package Consumption Information. Includes information on quantity of the package used, allowance consumption etc.
4 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
housekeepingTaskCodeType
object
Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.
7 properties
resAccompanyGuestListType
array
Collection of accompany guests
resSharedGuestListType
array
Collection of shared guest reservations.
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.
facilityTaskType
object
Information regarding facility task on a reservation.
3 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.
4 properties
hotelEventSpaceSummariesType
array
List of summary info of hotel event space
postingRhythmType
string
Simple type for posting Rhythm types.
surnameType
string
Family name, last name.
ownerType
object
Generic type for information about an owner.
11 properties
validateReservationGuarantees
object
Request object to fetch reservation guarantees.
2 properties
alternateAvailability
object
Response object for fetch alternate availability operation
3 properties
searchMatchType
object
Search match indicating attribute and the matching value.
2 properties
availableUpsells
object
Response for fetching available up-sells.
3 properties
hotelAmenityType
object
4 properties
relativePositionType
object
Defines the position of an entity in relation to another entity (e.g. from an airport to a hotel, the relationship is dependent on use).
3 properties
profileDeliveryMethod
object
Delivery Information type to the profile.
7 properties
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
primaryCodesType
array
List of codes with primary flag
commissionPaymentMethods
string
Check
addressType
object
Provides address information.
19 properties
totalType
object
The total amount charged for the service including additional amounts and fees.
10 properties
taxesType
object
A collection of taxes.
3 properties
stayFutureListType
object
A collection of reservation history details attached to Profiles.
4 properties
countryNameType
object
Code for a country or a nationality.
2 properties
hurdleRates
object
Response object for fetching Hurdle rates.
8 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
upsellDailyRatesType
array
Reservation date and its corresponding upsell rate amount
relationshipAddressType
object
Provides address information for a Relationship.
5 properties
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
additionalGuestAmountType
object
2 properties
meetingRoomsType
array
List of meeting rooms of the hotel.
upsellType
object
Holds upsell information
10 properties
aRAccountStatusType
object
Type for the Account Status. Status can be restricted and a message/description added to the Account.
3 properties
benefitType
object
Basic information about membership benefit.
3 properties
billingPrivilegesType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
13 properties
alternateAvailDatesType
array
List of alternate dates.
reservationTaxTypeInfo
object
Provides information about the Tax Type.
9 properties
channelAvailRSInfoType
object
Channel specific information to be returned in availability response.
2 properties
privacyInfoType
object
Defines Privacy related information for the profile.
14 properties
mealPlanCodeType
object
Meal plan codes associated with the rate codes.
5 properties
formattedTextTextType
object
Provides text and indicates whether it is formatted or not.
2 properties
operaVersion
object
Response for Ping operation.
3 properties
profileCashieringType
object
Contains cashiering related details for the profile
14 properties
relationshipInfoType
object
Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.
8 properties
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 properties
depositCancelRevenueType
string
The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.
cancelPenaltyType
object
The CancelPenalty class defines the cancellation policy of the hotel facility.
8 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…
guaranteePoliciesType
array
Guarantee Code information with cancellation penalty and deposit policy information.
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
roomStaySearchType
object
3 properties
webUserHistoryType
object
Creation date time, Creator Id, last modification date time and last Modifier Id.
8 properties
hotelEventSpacesType
object
The Detail and Summary info of event space about the hotel
3 properties
negotiatedInfoType
object
This provides information for a profile negotiated rate.
6 properties
reservationInfoType
object
The Reservation class contains the current reservation being created or altered.
51 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.
foreignExchangeType
object
Foreign Exchange info.
2 properties
reservationPackageScheduleType
object
A HotelPackageSchedule type.
8 properties
eCertificateType
object
E-Certificates details.
23 properties
resCashieringType
object
Cashiering Information for the reservation.
14 properties
meetingRoomType
object
Information about the meeting rooms of the hotel.
3 properties
hotelSummaryInfoType
object
32 properties
reservationDepositType
object
Reservation Deposit Type.
7 properties
profileMembershipType
object
Detailed information of the memberships.
41 properties
reservationPaymentMethodType
object
7 properties
mealPlansType
array
Meal plan codes associated with the rate codes.
hotelCorporateInformationsType
object
Corporate information details of the property
6 properties
restrictionsHistory
object
Response object for searching restrictions history.
3 properties
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
searchHotelAvailabilityRequest
object
52 properties
upsellsType
object
List of upsell information
2 properties
hurdleRateType
object
Unique identifier for hurdle rate.
16 properties
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
currencyExchangeRateType
object
Currency code configuration.
5 properties
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 properties
identificationInfoType
object
Information on the identification of the customer.
3 properties
reservationProfileTypeEnum
string
status
object
Response Body.
2 properties
profileRestrictions
object
3 properties
fetchRestrictionsHistoryRSType
object
Response object to fetch restriction search filtered by search criteria.
1 property
sellMessagesType
object
The SellMessagesType is the list of message and attributes returned by web service.
4 properties
promotionType
object
Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.
3 properties
primaryCodeType
object
Primary flag with code and description.
2 properties
restrictionControlType
object
The RestrictionControlType is used to indicate the applicability of the restriction.
6 properties
channelSummaryInfoType
object
Depicts channel information such as the type and code.
3 properties
configPackageTransactionType
object
A HotelPackageTransaction type.
5 properties
managedByOptions
string
Describes of the Configuration is Managed by Enterprise or Property.
alternateAvailDateType
object
Type containing information about an alternate date.
3 properties
relationshipInfoSummaryType
object
RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact p…
7 properties
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
resAttachedProfileListType
array
eCertificateConsumptionType
object
E-Certificates details.
13 properties
resGuestExternalInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
2 properties
relationshipProfileSummaryType
object
11 properties
ownerResTypeType
string
givenNameType
string
Given name, first name or names
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
3 properties
companyInfoType
object
Company Information of the Profile.
3 properties
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
9 properties
restrictionStatusType
object
The RestrictionStatusType is used to indicate the type of restriction applied. An enumerated restriction type is defined in the attribute group.
9 properties
imageSetType
object
Represents on image set record.
11 properties
ownerProfileTypeEnum
string
facilityCodeType
object
Facility Housekeeping Code, its description and quantity.
3 properties
eCertificateUsageCriteriaType
object
E-Certificates details.
8 properties
alienInfoType
object
immigration/visa information of a foreign person.
3 properties
currentRoomInfoType
object
Room information of the reservation for the current day.
7 properties
availabilityRatePlanInfo
object
Response object for fetching rate plans.
3 properties
rateRangeType
object
Rate Range details like maximum rate amount and minimum rate amount in each available rate category.
2 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…
10 properties
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
5 properties
hotelRateRangeType
object
The rate rage information of the hotel.
5 properties
eCertificateIssueSourceType
string
Indicates that OPERA E-Certificate is issued by external system.
restrictionsByDateRange
object
Response object for fetching restrictions based on date range.
3 properties
interfaceRightsStatusType
object
4 properties
stayReservationInfoType
object
The Reservation class contains the current reservation being created or altered.
6 properties
mailingActionsType
object
Defines mailing action list for the profile.
5 properties
searchAlternateAvailabilityRequest
object
26 properties
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
30 properties
reservationFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
4 properties
ratePlanCommissionType
object
3 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,…
6 properties
searchAnalyzeRateAvailabilityRequest
object
20 properties
profileStatusType
string
masterRestrictionStatusesType
string
rateAnalysisCodeType
string
resGuaranteeSearchType
object
Contains Search criteria to get applicable Reservation Guarantee Codes.
12 properties
reservationInterfaceStatusType
object
Hotel Interface Type for a reservation and status of the various services
3 properties
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.
hotelAttractionType
object
Information about the attractions near the hotel.
11 properties
currencyExchangeRatesType
array
Exchange Rate information for a currency code.
lastStayInfoType
object
Contains last stay related details for the profile
4 properties
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
profileSharedLevelType
string
Simple types for Shared level.
hotelRestaurantType
object
Information about the Restaurants in the hotel.
11 properties
reservationFolioWindowsType
array
Collection of reservation folio windows.
packageCodeHeaderType
object
4 properties
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
createRestrictionType
object
21 properties
commentInfoType
object
Comment related to the profile/reservation.
8 properties
reservationIdList
array
Unique Id that references an object uniquely in the system.
hotelContactRoleType
string
The contact's role in the hotel. Possible values are Lead, General, and Contract.
upsellDailyRateType
object
Reservation date and its corresponding upsell rate amount
2 properties
directBillingType
object
This is the preconfigured routing instruction type.
2 properties
eCertificateStatusType
string
Indicates that OPERA E-Certificate is reserved.
eCertificateScopeType
string
Indicates that OPERA E-Certificate is available for a specific list of hotels.
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
hurdleRatesEditType
array
Details for hurdle rate to be modified.
gdsNegotiatedInfoType
object
This provides information for a channel negotiated rate.
5 properties
eCertificateGenerationType
object
E-Certificates details.
3 properties
amountPointsType
object
Holds monetary value expressed with a currency code / number of points
2 properties
eCertificatesType
array
List of e-certificates for the profile.
keywordType
object
3 properties
childBucketsType
object
Defines children counts with Age Qualifying Group(Child Bucket) classification.
5 properties
changeHurdleRates
object
Request object for changing existing Hurdle Rates.
3 properties
profileTaxInfoType
object
Profile information related to tax.
7 properties
aRAccountShortInfoType
object
Accounts Receivabales Account details type charged for batched posting.
4 properties
roomRateType
object
45 properties
reservationTurndownInfoType
object
Turndown information for a reservation
2 properties
createRestriction
object
Request object for creating a new restriction.
3 properties
roomTypeMasterInfoType
object
The RoomType element is used to contain all the room type information for a single room type.
2 properties
resProfileTypeType
string
availResponseMasterInfoType
object
Availability master info type
2 properties
codeListType
array
futureListType
object
A collection of reservation history details attached to Profiles.
4 properties
sellMessageType
object
The SellMessagesType defines the standard attributes that will be retrieved with the sell message.
16 properties
hotelSetupStylesType
array
List of event space setup style codes.
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
commentType
object
An indication of a new paragraph for a sub-section of a formatted text message.
19 properties
functionArgumentType
object
This type provided details of a function argument and the value it holds.
8 properties
translationTextType80
object
Contains Multiple translated texts and language codes.
2 properties
hotelContactsType
array
Lists of contacts of the hotel.
availResponseSegmentType
object
15 properties
nameTypeType
string
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
payeeInfoType
object
Payee information.
7 properties
blockIdList
array
Unique Id that references an object uniquely in the system.
stringLength20
string
Used for Character Strings, length 0 to 20.
hotelContactType
object
Contact identification details.
8 properties
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
guaranteeRequirementsType
object
Specifies various requirement for the guarantee code.
7 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
alternateHotelsType
array
historyListType
object
A collection of reservation history details attached to Profiles.
4 properties
roomFeaturesType
array
A recurring element that identifies the room features.
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…
hotelAttractionsType
array
roomStayType
object
24 properties
webUserAccountsType
array
Web User Accounts List.
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
emailInfoType
object
Information on an email for the customer.
3 properties
ratesType
object
Individual rate amount.
2 properties
facilityCodesType
array
List of the facility codes.
searchHotelAvailabilityCRORequest
object
57 properties
personNameTypeType
string
Person's name in an external system.
dateUDFsType
array
Used to hold collection of user defined fields of Date Type.
resCompAccountingType
object
Information regarding comp accounting on the reservation.
3 properties
feeType
object
Applicable service charges or fees.
5 properties
dateUDFType
object
Used to hold user defined field of Date Type.
3 properties
uRLInfoType
object
Web site address.
3 properties
awardId
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
resAttachedProfileType
object
3 properties
paymentTypesType
array
Payment card code like AX,VI etc.
keywordDetailType
object
1 property
taxTypeType
object
Provides information about the Tax Type.
8 properties
feesType
object
A collection of fees or service charges.
3 properties
fetchRestrictionsByDateRangeRSType
object
Response object for searching restrictions by date range.
1 property
eCertificateIssueType
string
Indicates that guest purchased OPERA E-Certificate.
configPackagePrimaryDetailsType
object
A Config Package Info type.
6 properties
webUserAccountType
object
Web User Account of the guest.
11 properties
roomFeatureType
object
Room Feature Information.
4 properties
reservationPackageType
object
A ReservationPackageType class.
13 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.
hotelEventSpaceSummaryType
object
The summary info of hotel event space
4 properties
profileTypeType
string
The types of Profile handled by the web service.
restrictionsHistoryType
object
Restriction history for the requested Hotel.
13 properties
restrictionSetHistoryType
object
Indicates Restriction set applicable for the date range.
18 properties
profileIdList
array
Unique Id that references an object uniquely in the system.
primaryShareTypeType
string
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
availabilityStatusType
string
Status when there are not enough sell control items available.
packagePostingRulesType
object
5 properties
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 properties
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
namePrefixType
string
Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
personNameType
object
This provides name information for a person.
12 properties
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.
hotelInfoType
object
Contains the basic configuration information about a Hotel.
21 properties
hotelRestaurantsType
array
rateRoomDetailsType
object
3 properties
resPaymentCardType
object
Information on a credit card for the customer.
17 properties
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
7 properties
indicatorsType
array
Collection of lamp indicators.
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.
12 properties
changeHurdleRatesDetails
object
Response Body.
2 properties
resGuaranteeFetchInstructionsType
object
1 property
hurdleRateEditType
object
Unique identifier for hurdle rate.
8 properties
preferenceType
object
Guest Preference details for the profile.
7 properties
tierAdministrationType
string
Do not upgrade membership. The membership may be downgraded.
roomRateAvailReasonType
string
Indicates the Room Rate is not available due to unavailability of enough items for the rate code.
guaranteeType
object
Specifies Guarantee Code attributes.
9 properties
createHurdleRates
object
Request object for creating new Hurdle Rates.
3 properties
reservationGuaranteesPolicies
object
Response object to fetch reservation guarantees.
3 properties
configPostingAttributesType
object
A config Package posting attributes type.
18 properties
resCommunicationType
object
Communication details for a reservation.
2 properties
hurdleRatesType
array
Details for hurdle rate.
packageTransactionCodeType
object
3 properties
hotelRateRangesType
array
Lists of rate ranges of the hotel.
reservationProfileType
object
3 properties
basicEmailType
string
Email address
awardVouchersType
array
This stores the Membership Awards code applied on the reservation.
membershipSearchType
object
Identifies criteria for searching frequent customer reward program.
4 properties
hotelEventSpaceDetailType
object
The detail info of hotel event space
4 properties
guaranteePolicyType
object
Specifies Guarantee Code attributes.
13 properties
profileCommissionType
object
This is the preconfigured routing instruction type.
7 properties
identificationType
object
Identification information of the customer.
10 properties
relationshipProfileType
object
13 properties
policyAmountPercentType
object
Defines the percentage basis for calculating the fee amount or the amount.
5 properties
masterAccountInfoType
object
2 properties
numericUDFsType
array
Used to hold collection of user defined fields of Numeric Type.
hotelEventSpaceDetailsType
array
List of detail info of hotel event space
bookingChannelType
object
3 properties
packageCalculationRuleType
string
Simple type for package caluculation rules.
offsetUnitType
string
Indicates deadline offset unit type.
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
phoneNumberType
string
Phone number
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
eCertificateConsumeSourceType
string
Indicates that OPERA E-Certificate is consumed by hotelPMS.
upsellInfoType
object
Information regarding upsell for a reservation.
2 properties
roomTypeAttributesType
object
Attributes of property room type.
3 properties
availRatePlanInfoType
object
The rate plan element is used to contain all the rate information for a single Rate Plan
2 properties
iATAInfoType
object
IATA Information of the profile.
3 properties
preferenceTypeType
object
Preference details for the profile.
13 properties
guestCountsType
object
A collection of GuestCount by age group.
4 properties
emailType
object
Information on an email for the customer.
11 properties
rateAnalysisType
object
Analysis type which would be returned by the Analysis procedure.
3 properties
uRLType
object
Web site address, in IETF(The Internet Engineering Task Force) specified format.
5 properties
companyType
object
20 properties
changeRelationsType
object
Detailed information regarding the changes made to relationships for the profile.
5 properties
stayHistoryListType
object
A collection of reservation history details attached to Profiles.
4 properties
ratePlanChannelInfoType
object
3 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.
ratePostingIntervalEnum
string
eventSpaceMaxOccupanciesType
array
List of event space max occupancy.
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…
5 properties
rateAnalysisDetails
object
Response to the fetch Rate Availability Analysis.
3 properties
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
3 properties
functionArgumentsType
array
Collection of function arguments and their corresponding values.
searchHotelsDetails
object
Response object to search hotel availability.
3 properties
reservationBlockType
object
Key information about the block for a reservation.
3 properties
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
packageElementType
object
15 properties
childAgeType
object
Defines Child's Age.
1 property
roomTypeInfoType
object
18 properties
gdsNegotiatedType
object
This holds a list of GdsNegotiatedInfoType.
4 properties
profileAccessType
object
4 properties
profileType
object
Type provides the detailed information about the profile and its children.
53 properties
paragraphType
object
An indication of a new paragraph for a sub-section of a formatted text message.
3 properties
anonymizationType
object
Provides information about guest's anonymization status.
2 properties
hotelInterfaceTypeType
string
XML Posting Interface
couponInfoType
object
Information about the coupon.
3 properties
promotionCouponValidationDetails
object
Response for validating a coupon.
3 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
#Availability
Where this information came from
This is an independent, third-party profile of Oracle Hospitality Availability 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.