Oracle Hospitality Reservation Async API
The Reservation Asynchronous module provides capability for an external system to retrieve reservation related data using an asynchronous approach.
Oracle Hospitality Reservation Async 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 ReservationAsync. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 19 operations across 15 paths, and defines 226 schemas. It is described by OpenAPI 3.2.0, at version 26.2.0.0.
Requests are made against a single base URL, /rsv/async/v1.
19 operations
15 paths
226 schemas
4 GET4 HEAD11 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 19
Across 15 paths, the API surfaces 19 operations — 4 GET, 4 HEAD, 11 POST. Each is listed below with its method, path, parameters, and response codes.
ReservationAsync 19
The Reservation Asynchronous module provides capability for an external system to retrieve reservation related data using an asynchronous approach.
POST
/externalSystems/{extSystemCode}/hotels/{hotelId}/reservations/dailySummary
Fetch past, present and future Reservations Daily Summary.
HEAD
/externalSystems/{extSystemCode}/hotels/{hotelId}/reservations/dailySummary/{summaryId}
Check status of Reservation Daily Summary process
GET
/externalSystems/{extSystemCode}/hotels/{hotelId}/reservations/dailySummary/{summaryId}
Get results of Reservations Daily Summary.
POST
/hotels/{hotelId}/reservationDetailsMassUpdate
Updates reservation details of a given list of reservations.
POST
/hotels/{hotelId}/tracesMassUpdate
Updates reservation traces of a given list of reservations.
POST
/hotels/{hotelId}/preferencesMassUpdate
Updates reservation preferences of a given list of reservations.
POST
/hotels/{hotelId}/routingInstructionsMassUpdate
Updates reservation routing instructions of a given list of reservations.
POST
/hotels/{hotelId}/housekeepingMassUpdate
Updates reservation housekeeping options and/or schedules of a given list of reservations.
HEAD
/hotels/{hotelId}/massUpdate/{massUpdateId}
Check status of Mass Update process.
GET
/hotels/{hotelId}/massUpdate/{massUpdateId}
Get results of a Mass Update process
POST
/hotels/{hotelId}/notesMassUpdate
Updates reservation notes of a given list of reservations.
POST
/hotels/{hotelId}/transportationsMassUpdate
Updates reservation transportations of a given list of reservations.
POST
/hotels/{hotelId}/blocks/{blockId}/roominglistvalidation
Validate Rooming List Reservations
HEAD
/hotels/{hotelId}/roominglistvalidation/{requestId}
Check status of Rooming List validation process.
GET
/hotels/{hotelId}/roominglistvalidation/{requestId}
Get results of Rooming List validation process
POST
/hotels/{hotelId}/paymentInstructionsMassUpdate
Updates reservation payment instructions of a given list of reservations.
POST
/hotels/{hotelId}/blocks/{blockId}/roominglistcreation
Create Rooming List Reservations
HEAD
/hotels/{hotelId}/roominglistcreation/{requestId}
Check status of Rooming List creation process.
GET
/hotels/{hotelId}/roominglistcreation/{requestId}
Get results of Rooming List Creation process
Schemas 226
The contract defines 226 schemas that model the data the API accepts and returns. The most detailed are reservationDailySummaryType (45 properties), roomRateType (43 properties), profileMembershipType (41 properties), dailySummaryType (27 properties). Each schema is shown below with its type and property counts.
massUpdateTracesFrequencyType
string
Simple type to mention the trace date range when mass updating the reservation traces.
cardReIssueType
string
Request to re issue a new card.
packagePostingRulesType
object
5 properties
roomingListSharesType
array
Contains a set of rooming list reservations that need to be shared.
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 properties
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
configPackageUsageDetailType
object
A Config Package Usage Detail type.
4 properties
policyBasisTypeType
string
Full Amount.
massUpdateHousekeepingSchedule
object
Mass update housekeeping schedule criteria.
1 property
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
preferencesType
object
Guest Preference details for the profile.
1 property
personNameType
object
This provides name information for a person.
12 properties
colorType
string
Color configuration type. This color configuration provides a visual category of entities.
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.
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
packageCodeHeaderType
object
4 properties
commentInfoType
object
Comment related to the profile/reservation.
9 properties
roomingListShareReservationType
object
Contains the rooming list reservation that is to be shared and the information about the share type of this reservation.
4 properties
reservationIdList
array
Unique Id that references an object uniquely in the system.
foreignExchangeType
object
Foreign Exchange info.
2 properties
reservationPackageScheduleType
object
A HotelPackageSchedule type.
8 properties
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
resCashieringType
object
Cashiering Information for the reservation.
14 properties
amountDeterminationType
string
Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.
reservationCommentType
object
Reservation Comment Type.
5 properties
resPaymentCardType
object
Information on a credit card for the customer.
19 properties
pkgInventoryItemType
object
4 properties
hotelReservationType
object
The Reservation class contains the current reservation being validated.
22 properties
routingInfoType
object
A routing info object can either be of type Folio OR of type Room with its corresponding object.
5 properties
preferencesTypeType
object
Preference details for the profile.
3 properties
effectiveRateType
object
Effective rate amount per guest on specific dates.
22 properties
reservationsDailySummarySearchType
object
3 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.
41 properties
reservationPaymentMethodType
object
7 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, whild Duration provides a measure of time to…
3 properties
billingInstructionType
object
Configured Billing Instruction which represents a set of Transaction Codes.
4 properties
fixedChargesType
array
Holds fixed charge detail.
mealPlansType
array
Meal plan codes associated with the rate codes.
addressInfoType
object
Provides address information.
5 properties
transportationsMassUpdateCriteria
object
Reservation Transportations Mass Update criteria.
3 properties
reservationDetailsMassUpdateCriteria
object
Reservation Details Mass Update criteria.
7 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
traceTimeType
object
2 properties
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
reservationDailySummaryType
object
Daily summary information related to a reservation.
45 properties
childBucketsType
object
Defines children counts with Age Qualifying Group(Child Bucket) classification.
5 properties
aRAccountShortInfoType
object
Accounts Receivabales Account details type charged for batched posting.
4 properties
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
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
validateRoomingListOutcomeType
object
Response object for outcome of validate rooming list reservations with Success or Fail status and Errors related to this operation.
8 properties
roomRateType
object
43 properties
profileRoutingInstructionsType
object
The type contains routing instructions for the profile.
3 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.
7 properties
telephoneInfoType
object
Information on a telephone number for the customer.
5 properties
effectiveRatesType
array
Collection of effective rate amount per guest on specific dates.
paymentInstructionsMassUpdateCriteria
object
Payment Instructions Mass Update criteria.
8 properties
lastModifiedDateType
object
Start and End Modified Dates of Reservations after which the results are to be fetched
2 properties
resProfileTypeType
string
createRoomingListOutcomesType
array
Collection of outcome of creation of rooming list reservations.
preferenceType
object
Guest Preference details for the profile.
8 properties
tierAdministrationType
string
Do not upgrade membership. The membership may be downgraded.
codeListType
array
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
roomRateAvailReasonType
string
Indicates the Room Rate is not available due to unavailability of enough items for the rate code.
roomingList
object
Request object for creating rooming list reservations. The standard optional Opera Context element is also included.
5 properties
database_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.
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
tracesMassUpdateCriteria
object
Reservation Traces Mass Update criteria.
5 properties
identificationInfoType
object
Information on the identification of the customer.
5 properties
massUpdateHousekeepingInstructions
object
Mass update housekeeping instructions criteria.
5 properties
createRoomingListOutcomeType
object
Response object for outcome of create rooming list reservations with Success or Fail status and Errors related to this operation.
10 properties
reservationPaymentMethodsType
array
Defines reservation payment methods.
configPostingAttributesType
object
A config Package posting attributes type.
18 properties
massUpdateRoutingInstructionType
object
Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit
7 properties
packagePostingRhythmType
object
Package Posting rhythm type.
5 properties
cardProcessingType
string
authorizerInfoType
object
Authorizer Information
5 properties
commentType
object
An indication of a new paragraph for a sub-section of a formatted text message.
18 properties
functionArgumentType
object
This type provided details of a function argument and the value it holds.
5 properties
transportInfoType
object
7 properties
roomingListReservationType
object
Reservation details for a block reservation.
3 properties
massUpdateTrxInfoType
object
Transaction codes info.
1 property
packageTransactionCodeType
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.
3 properties
resDepositPoliciesType
array
A list of deposit policies attached with the reservation.
reservationProfileType
object
3 properties
packageConsumptionType
object
Package Consumption Information. Includes information on quantity of the package used, allowance consumption etc.
4 properties
articlePostItType
object
Post it information of an article.
2 properties
resDepositPolicyType
object
A deposit policy attached with the reservation.
6 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
payeeInfoType
object
Payee information.
7 properties
blockIdList
array
Unique Id that references an object uniquely in the system.
resGuestAdditionalInfoType
object
8 properties
awardVouchersType
array
This stores the Membership Awards code applied on the reservation.
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 properties
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…
massUpdateFacilityCodes
array
List of the facility codes.
benefitsType
array
Basic information about membership benefit.
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
massUpdateOutcomesType
array
Collection of outcome of mass update to reservations.
fixedChargeScheduleType
object
Holds schedule of fixed charge.
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
identificationType
object
Identification information of the customer.
10 properties
articleInfoType
object
Information regarding an article.
9 properties
resAwardsType
object
Membership Awards code applied on the reservation.
4 properties
configPackageTransactionType
object
A HotelPackageTransaction type.
5 properties
massUpdateFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
2 properties
roomStayType
object
24 properties
postingRhythmType
string
Simple type for posting Rhythm types.
policyAmountPercentType
object
Defines the percentage basis for calculating the fee amount or the amount.
5 properties
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
roomingListBlockInfoType
object
Block Information for create rooming list operation.
2 properties
profileCashieringDetailType
object
The type contains routing instructions for the profile.
6 properties
trxInfoType
object
Transaction codes info.
10 properties
emailInfoType
object
Information on an email for the customer.
5 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.
2 properties
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
numericUDFsType
array
Used to hold collection of user defined fields of Numeric Type.
validateRoomingListType
object
Response object to validate block rooming list. This object contains the datils of validated rooming list records.
3 properties
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
packageCalculationRuleType
string
Simple type for package caluculation rules.
dailySummaryType
object
Statistic information related to a specific reservation stay date.
27 properties
offsetUnitType
string
Indicates deadline offset unit type.
personNameTypeType
string
Person's name in an external system.
massUpdateSummaryType
object
Response object for mass update process summary.
3 properties
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
dateUDFsType
array
Used to hold collection of user defined fields of Date Type.
roomingListReservationsType
object
A collection of Block Rooming List Reservations.
1 property
resCompAccountingType
object
Information regarding comp accounting on the reservation.
3 properties
ownerResTypeType
string
roomingListShareType
object
Specifies a group of two or more rooming list reservations that need to be created as shared reservations.
3 properties
dateUDFType
object
Used to hold user defined field of Date Type.
3 properties
feeType
object
Applicable service charges or fees.
5 properties
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
2 properties
hotelReservationsType
object
A collection of Reservation objects and Unique IDs of Reservation.
4 properties
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
9 properties
upsellInfoType
object
Information regarding upsell for a reservation.
2 properties
massUpdateBillingInstructionType
object
Configured Billing Instruction which represents a set of Transaction Codes.
1 property
massUpdateTimeSpanType
object
Allows for a choice in description of the amount of time spanned by this type.
2 properties
routingInstructionsMassUpdateCriteria
object
A routing info object can either be of type Folio OR of type Room with its corresponding object.
4 properties
preferenceTypeType
object
Preference details for the profile.
13 properties
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
guestCountsType
object
A collection of GuestCount by age group.
4 properties
emailType
object
Information on an email for the customer.
10 properties
depositCancelRevenueType
string
The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.
reservationsDailySummaryDetails
object
Reservation Daily Summary Details.
1 property
preferencesMassUpdateCriteria
object
Reservation Preferences Mass Update criteria.
3 properties
compRoutingStatusType
string
Status which indicates that the Request of Comp Routing was declined
fixedChargeType
object
Holds fixed charge information.
8 properties
addressType
object
Provides address information.
17 properties
currentRoomInfoType
object
Room information of the reservation for the current day.
7 properties
massUpdateFacilityCode
object
Housekeeping facility code, and its quantity.
2 properties
notesMassUpdateCriteria
object
Notes Mass Update criteria.
2 properties
trxCodesInfoType
array
List of Transaction codes info.
outcomeMessageType
object
Object for update messages.
2 properties
massUpdatePayeeInfoType
object
Payee information.
2 properties
feesType
object
A collection of fees or service charges.
3 properties
rateRangeType
object
Rate Range details like maximum rate amount and minimum rate amount in each available rate category.
2 properties
resCancelPenaltyType
object
The CancelPenalty class defines the cancellation policy of the hotel facility.
9 properties
massUpdateOutcomeType
object
Response object for outcome of mass update to reservations.
8 properties
rateByAgeBucketType
object
Rate amount by age bucket.
3 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
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
5 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
configPackagePrimaryDetailsType
object
A Config Package Info type.
6 properties
massUpdateFacilityHousekeepingTask
object
Information about housekeeping facility task.
8 properties
validateRoomingListOutcomesType
array
Collection of outcome of validations of rooming list.
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
countryNameType
object
Code for a country or a nationality.
2 properties
criteria
object
Request object for fetching future reservations asynchronously.
1 property
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
housekeepingMassUpdateCriteria
object
Mass update housekeeping criteria.
3 properties
reservationPackageType
object
A ReservationPackageType class.
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
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
taxType
object
Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should…
5 properties
additionalGuestAmountType
object
2 properties
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
4 properties
pMS_ResStatusType
string
This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.
compRoutingRequestType
object
Type for the details of a Comp Routing Request
4 properties
userInfoType
object
Opera User Information
2 properties
massTransportInfoType
object
7 properties
functionArgumentsType
array
Collection of function arguments and their corresponding values.
aRAccountStatusType
object
Type for the Account Status. Status can be restricted and a message/description added to the Account.
3 properties
createRoomingListType
object
Response object to create block rooming list. This object contains the details of created rooming list records.
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
massUpdateHousekeepingTaskStayPeriod
string
Date period type the housekeeping task is to be performed.
massUpdateAddressInfoType
object
Provides address information.
3 properties
fixedChargeFrequencyType
string
Yearly.
reservationTaxTypeInfo
object
Provides information about the Tax Type.
9 properties
reservationBlockType
object
Key information about the block for a reservation.
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
resCancellationPoliciesType
array
A list of reservation cancellation policies.
characterUDFType
object
Used to hold user defined field of Character/String Type.
3 properties
policyDeadlineType
object
Cancellation deadline, absolute or relative.
4 properties
profileIdList
array
Unique Id that references an object uniquely in the system.
primaryShareTypeType
string
packageElementType
object
15 properties
childAgeType
object
Defines Child's Age.
1 property
routingInfoListType
array
A routing info object can either be of type Folio OR of type Room with its corresponding instructions.
mealPlanCodeType
object
Meal plan codes associated with the rate codes.
5 properties
visaInfoType
object
3 properties
formattedTextTextType
object
Provides text and indicates whether it is formatted or not.
2 properties
billingInstructionsType
array
Set of Billing Instruction codes.
resCancellationPolicyType
object
A cancellation policy attached with the reservation.
5 properties
externalReferenceType
object
This type contains unique information of external reference.
3 properties
links
array
profileType
object
Type provides the detailed information about the profile and its children.
5 properties
paragraphType
object
An indication of a new paragraph for a sub-section of a formatted text message.
3 properties
depositPolicyType
object
Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.
12 properties
commissionPayoutToType
string
childAgesType
array
Age of a child in years.
rateByAgeBucketsType
array
Rate amount by age bucket.
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
#ReservationAsync
Where this information came from
This is an independent, third-party profile of Oracle Hospitality Reservation Async 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.