Oracle Hospitality Reservation Config API
The Reservation Configuration module offers capability of creating, managing, and retrieving of Reservation configuration.
Oracle Hospitality Reservation Config 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 ReservationConfig. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 79 operations across 43 paths, and defines 149 schemas. It is described by OpenAPI 3.2.0, at version 26.2.0.0.
Requests are made against a single base URL, /rsv/config/v1.
79 operations
43 paths
149 schemas
12 DELETE21 GET14 POST32 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 79
Across 43 paths, the API surfaces 79 operations — 12 DELETE, 21 GET, 14 POST, 32 PUT. Each is listed below with its method, path, parameters, and response codes.
ReservationConfig 79
The Reservation Configuration module offers capability of creating, managing, and retrieving of Reservation configuration.
GET
/alertCodes
Get Alert Code Templates
PUT
/alertCodes
Change Alert Code Template
DELETE
/alertCodes
Delete Alert Code Template
POST
/alertCodes
Create Alert Code Template
PUT
/autoAttachElements
Delete Auto Attach Elements
GET
/ecoupons
Get eCoupon Codes
PUT
/globalAlerts
Delete a Global Alert Code
GET
/globalAlerts
Get Global Alerts
PUT
/globalAlerts/copy
Copy Global Alerts
GET
/guestMessages
Get Guest Message Templates
PUT
/guestMessages
Change Guest Message Templates
DELETE
/guestMessages
Delete an existing guest message template
POST
/guestMessages
Create a new guest message template
GET
/hotels/{hotelId}/alertCodes
Get Alert Codes
PUT
/hotels/{hotelId}/alertCodes
Change Alert Codes
DELETE
/hotels/{hotelId}/alertCodes
Delete an Alert Code
POST
/hotels/{hotelId}/alertCodes
Create a new alert code
GET
/hotels/{hotelId}/autoAttachElements
Get Auto Attach Elements
PUT
/hotels/{hotelId}/autoAttachElements
Update Auto Attach Elements
POST
/hotels/{hotelId}/autoAttachElements
Create Auto Attach Elements
PUT
/hotels/{hotelId}/autoAttachElements/copy
Copy Auto Attach Elements
GET
/hotels/{hotelId}/colors
Get Reservation Colors
PUT
/hotels/{hotelId}/colors/{code}
Change Reservation Colors
DELETE
/hotels/{hotelId}/ecouponCodes/{ecouponCode}
Delete an eCoupon Code
PUT
/hotels/{hotelId}/ecoupons
Change an eCoupon Code
POST
/hotels/{hotelId}/ecoupons
Create an eCoupon Code
PUT
/hotels/{hotelId}/ecoupons/copy
Copy eCoupon Codes
PUT
/hotels/{hotelId}/globalAlerts
Change Global Alerts
POST
/hotels/{hotelId}/globalAlerts
Create Global Alerts
GET
/hotels/{hotelId}/guestMessages
Get Guest Messages
PUT
/hotels/{hotelId}/guestMessages
Change a Guest messages
POST
/hotels/{hotelId}/guestMessages
Create Guest Messages
DELETE
/hotels/{hotelId}/guestMessages/{messageCode}
Delete a Guest messages
GET
/hotels/{hotelId}/locatorCodes
Get existing property Locator Codes
PUT
/hotels/{hotelId}/locatorCodes
Change the existing Locator Code
POST
/hotels/{hotelId}/locatorCodes
Create a new Locator Code
DELETE
/hotels/{hotelId}/locatorCodes/{locatorCode}
Delete a Locator Code
GET
/hotels/{hotelId}/membershipLevels/ratings
Get Membership Level Ratings
PUT
/hotels/{hotelId}/membershipTypes/{membershipType}/membershipLevels/{membershipLevel}/ratings
Change Membership Level Ratings
GET
/hotels/{hotelId}/ratePlans/ratings
Get Rate Plan Ratings
PUT
/hotels/{hotelId}/ratePlans/ratings
Change Rate Plan Ratings
GET
/hotels/{hotelId}/reservationProtectionCondition
Get Reservation Protection Condition
POST
/hotels/{hotelId}/reservationProtectionCondition
Create Reservation Protection Condition
PUT
/hotels/{hotelId}/reservationProtectionCondition
Change Reservation Protection Condition
DELETE
/hotels/{hotelId}/reservationProtectionCondition
Delete Reservation Protection Condition
GET
/hotels/{hotelId}/roomFeatures/ratings
Get Room Feature Ratings
PUT
/hotels/{hotelId}/roomFeatures/ratings
Change Room Feature Ratings
GET
/hotels/{hotelId}/roomSpecials/ratings
Get Room Special Ratings
PUT
/hotels/{hotelId}/roomSpecials/ratings
Change Room Special Ratings
GET
/hotels/{hotelId}/rooms/ratings
Get Room Ratings
PUT
/hotels/{hotelId}/rooms/{roomId}/ratings
Change Room Ratings
PUT
/hotels/{hotelId}/traceTexts/copy
Copy trace text
GET
/hotels/{hotelId}/turnawayCodes
Get Turnaway codes
PUT
/hotels/{hotelId}/turnawayCodes
Change TurnAway Codes
POST
/hotels/{hotelId}/turnawayCodes
Create Turn Away Codes
DELETE
/hotels/{hotelId}/turnawayCodes/{code}
Delete an existing turnaway code
GET
/hotels/{hotelId}/upsellRules
Get upsell rules
PUT
/hotels/{hotelId}/upsellRules
Modify Upsell Rule
POST
/hotels/{hotelId}/upsellRules
Create Upsell Rules
PUT
/hotels/{hotelId}/upsellRules/action/validate
Test upsell rules
PUT
/hotels/{hotelId}/upsellRules/copy
Copy upsell rules
DELETE
/hotels/{hotelId}/upsellRules/{ruleCode}
Delete an Upsell Rule
GET
/services/reservations/status
ping
GET
/templates/locatorCodes
Get template Locator Codes
PUT
/templates/locatorCodes
Change a Locator Code
DELETE
/templates/locatorCodes
Delete a Locator Code
POST
/templates/locatorCodes
Create a template Locator Code
GET
/traceTexts
Get trace texts
PUT
/traceTexts
Change trace text
POST
/traceTexts
Create new trace texts
DELETE
/traceTexts
Delete trace text
GET
/turnawayCodes
Get Template TurnAway Codes
PUT
/turnawayCodes
Change a Turnaway code template
POST
/turnawayCodes
Create Template TurnAway Codes
DELETE
/turnawayCodes/{turnawayCode}
Delete a Turnaway code template
PUT
/upsert/hotels/{hotelId}/autoAttachElements
Create/Update Auto Attach Elements
PUT
/upsert/hotels/{hotelId}/ecoupons
Create/Change an eCoupon Code
PUT
/upsert/hotels/{hotelId}/globalAlerts
Create/Change Global Alerts
PUT
/upsert/hotels/{hotelId}/upsellRules
Create/Modify Upsell Rule
Schemas 149
The contract defines 149 schemas that model the data the API accepts and returns. The most detailed are configUpsellRuleType (24 properties), configTestUpsellRuleSearchType (14 properties), resvAutoAttchBasedOn (11 properties), globalAlertType (11 properties). Each schema is shown below with its type and property counts.
copyGlobalAlertType
object
Copy Global Alerts criteria from one property to another property
2 properties
traceTextsToBeCreated
object
Request object for creating new trace texts.
3 properties
locatorCodesTemplate
object
Request object for modifying an existing locator code template.
3 properties
roomFeatureRatingsInfoType
array
Collection of rooms features and their ratings.
roomRatingInfoType
object
Rating details for a room.
5 properties
scriptLocationsType
object
Collection of locations where a Script is to be used.
3 properties
traceTextsCopy
object
Request object for copying trace texts.
3 properties
colorType
string
Color configuration type. This color configuration provides a visual category of entities.
roomFeatureRatingsInfo
object
Response object for fetching the room features and their rating details.
8 properties
alertTemplates
object
Request object for modifying the existing alert code templates.
3 properties
guestMessageTemplatesType
array
Collection of guest messages templates.
resvAutoAttchTypeCode
string
Available only when Reservation Discounts and Advanced Discounts are active
configTestUpsellRuleType
object
This gives detailed information about an upsell rule which is returned upon testing an upsell rule against a reservation.
4 properties
reservationProtectionConditionType
object
Details of reservation protection condition
2 properties
configOccupancyLevelType
object
This type holds the upsell amount by occupancy levels. This is used when upsell rule is being set bu occupancy levels
3 properties
expressionParameterType
object
3 properties
templateTurnAwayCodeType
object
Base details common between hotel and template TurnAway codes.
7 properties
guestMessages
object
Request object for creating a new guest message.
3 properties
scriptLocationType
object
Unique identifier of a Script.
3 properties
traceTextsType
array
Collection of trace texts.
roomSpecialRatings
object
Request object for modifying room specials rating details.
3 properties
copyTraceTextsCriteriaType
object
Copy Trace texts criteria type to copy multiple trace texts from one Hotel to another Hotel.
2 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
templateTurnAwayCodes
object
Response object for fetching template turnaway codes.
3 properties
addtionalCodeInfoType
array
Holds name of additional code information
eCouponCodesType
array
List of eCoupon Codes.
conditionGroupType
object
3 properties
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
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
alertCodesType
array
Collection of hotel level alert codes with attached alert types.
traceTextsToBeFetched
object
Response object for fetching trace texts.
3 properties
membershipLevelRatings
object
Request object for modifying membership levels rating details.
3 properties
traceTextChangeType
object
Type provides trace text that will be modified.
2 properties
turnAwayTypeType
string
Simple Type for TurnAwayType Types.
reservationColorType
object
Property level reservation color information.
6 properties
alertCodeType
object
Common code type for code, description
7 properties
copyConfigurationCodeType
object
Information needed to copy configuration code from one property to the other.
3 properties
codeListType
array
reservationColorsResponse
object
Response object for fetch reservation colors.
3 properties
retrievedGuestMessages
object
Response object for information regarding guest message.
8 properties
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
roomFeatureRatingType
string
Possible Room Feature rating values.
upsellRulesToTest
object
Request object for testing upsell rules.
3 properties
upsellRulesToTestDetails
object
Response object for testing upsell rules.
3 properties
masterInfoCodeDetailType
string
alertCodes
object
Response object for information regarding alert templates.
3 properties
status
object
Response Body.
2 properties
masterInfoType
object
2 properties
ratePlanRatingType
string
Possible Rate plan rating values.
configTestUpsellRuleSearchType
object
Search criteria for testing upsell rules.
14 properties
guestMessageTemplateType
object
A template for guest message.
4 properties
roomSpecialRatingInfoType
object
Rating details for room Specials.
3 properties
locatorCodesInfo
object
Response object for fetching locator codes.
8 properties
roomRatingsInfoType
array
Collection of rooms and their ratings.
articlePostItType
object
Post it information of an article.
2 properties
autoAttachElementsConfig
object
Response object for the configuration rules that specify the elements to be automatically attached to the reservation.
4 properties
alertTemplatesType
array
Collection of alert code templates.
eCouponCodeType
object
eCoupon code detailed information.
10 properties
hotelTurnAwayCodes
object
Response object for fetching hotel turnaway codes
3 properties
membershipLevelRatingsInfoType
array
Collection of membership levels and their ratings.
upsellRules
object
Response object for fetching upsell rules.
3 properties
locatorCodesTemplateInfo
object
Response object for fetching locator codes at template level.
3 properties
mergeCodesType
array
A Merge Code.
configOccupancyLevelsType
array
This type holds a collection of upsell amounts by occupancy levels.
roomRatings
object
Response object for fetching the rooms and their rating details.
8 properties
reservationColorsType
array
Collection of reservation colors.
ratePlanRatingsInfoType
array
Collection of rate plan Codes and their ratings.
codeDescriptionType
object
This contains a generic code and description information.
2 properties
membershipLevelRatingType
integer
The desired rating for membership level, up to 4 numeric values.
articleInfoType
object
Information regarding an article.
9 properties
traceTextType
object
Type provides trace text information.
6 properties
attachTraceType
object
Auto attach trace element.
2 properties
managedByOptions
string
Describes of the Configuration is Managed by Enterprise or Property.
logicalOperatorType
string
reservationProtectionCondition
object
Reservation protection condition in which a reservation would be automatically marked as protected for the property.
3 properties
alertTemplateType
object
Common code type for code, description
6 properties
hotelTurnAwayCodesType
array
Turnaway code details for hotels.
roomFeatureRatingInfoType
object
Rating details for room features.
3 properties
resvAutoAttchBasedOnCode
string
Available only when Keyword Functionality is active.
ratePlanRatingsInfo
object
Request object for modifying rate plan codes and their rating details.
3 properties
globalAlertsInfo
object
Response object for fetching Global Alerts.
3 properties
conditionType
object
4 properties
trxInfoType
object
Transaction codes info.
10 properties
expressionFieldType
object
6 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
2 required
globalAlerts
object
Request object for creating a new Global Alert.
3 properties
formulaType
string
Simple type for storing formula type.
scriptType
object
A Script associated to either Chain, CRO or Property and to a Language and/or Membership Type.
7 properties
masterType
string
scriptTypeType
string
Type for Web Reg Card.
translationTextType2000
object
Contains Multiple translated texts and language codes.
2 properties
phoneNumberType
string
Phone number
reservationColorsToChange
object
Request object to change reservation colors.
3 properties
locatorCodesType
array
Collection of locator codes.
ratePlanRatingInfoType
object
Rating details for a rate plan.
4 properties
configUpsellRuleType
object
This gives detailed information about an upsell rule.
24 properties
guestMessageTemplates
object
Response object for information regarding guest message templates.
3 properties
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
eCouponCodes
object
Response object to fetch eCoupon codes.
3 properties
globalAlertType
object
A property level global alert attached with global alert types.
11 properties
templateTurnAwayCodesType
array
Collection of template turnaway codes
guestMessageCodeType
object
A template for guest message.
5 properties
alertCodeTemplates
object
Response object for information regarding alert templates.
3 properties
traceTextChanges
object
Request object for changing trace texts.
3 properties
basedOnCondition
object
Auto attach based advanced query filter.
2 properties
basedOnMembershipType
object
Auto attach based on membership.
2 properties
operaVersionNumberType
string
Current Opera Version Number
autoAttachElementsConfigType
array
Auto attachment rule details.
attachElementsType
object
Elements to be attached to the rule.
5 properties
upsellRulesCopy
object
3 properties
roomSpecialRatingsInfoType
array
Collection of rooms specials and their ratings.
codeInfoType
object
4 properties
configTestUpsellRulesType
array
This type holds a collection of upsell rules which are returned on testing a reservation.
roundingRuleType
string
Simple type for storing rounding rule type.
globalAlertsType
array
Collection of property level global alert details with attached global alert types.
locatorCodesTemplateType
array
Collection of locator codes.
traceTextChangesType
array
Collection of trace texts that will be modified.
translationsTextType
array
Language code for the translation.
ratePlanRatings
object
Response object for fetching the rate codes and their rating details.
8 properties
locatorCodeType
object
Common code type for code, description
6 properties
attachPreferenceType
object
Auto attach preference element.
2 properties
roomRatingType
string
Possible room rating values.
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
eCouponCodesCopy
object
Request object to copy the existing eCoupon codes from source property to the selected target properties.
3 properties
autoAttachElements
object
Add configuration rule(s) that specify the elements to be automatically attached to the reservation.
3 properties
hotelTurnAwayCodeType
object
Base details common between hotel and template TurnAway codes.
8 properties
guestMessageCodesType
array
Collection of guest messages with attached guest message types.
roomSpecialRatingType
string
Possible Room special rating values.
notificationType
object
Global Alert Notification type for Screen, Print, email and text
9 properties
eCouponCopyType
object
Copy eCoupons from one Property to one or multiple properties.
3 properties
translationTextType50
object
Contains Multiple translated texts and language codes.
2 properties
autoAttachElementsCopy
object
3 properties
expressionOperatorType
object
3 properties
roomRatingsInfo
object
Request object for modifying room rating details.
3 properties
resvAutoAttchBasedOn
object
The Based On information for the rule.
11 properties
globalAlertsCopy
object
Request object for copying Global Alerts.
3 properties
locatorCodes
object
Request object for modifying an existing locator code.
3 properties
membershipLevelRatingInfoType
object
Rating details for membership levels.
4 properties
membershipLevelRatingsInfo
object
Response object for fetching the membership levels and their rating details.
8 properties
roomSpecialRatingsInfo
object
Response object for fetching the room specials and their rating details.
8 properties
operaVersion
object
Response for Ping operation.
3 properties
roomFeatureRatings
object
Request object for modifying room features rating details.
3 properties
links
array
autoAttachRuleType
object
Auto attachment rule details.
6 properties
hotelCodeListType
array
Hotel code.
mergeCodeType
object
A Merge Code.
2 properties
configUpsellRulesType
array
This type holds a collection of upsell rules.
locatorCodeTemplateType
object
Common code type for code, description
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
#ReservationConfig
Where this information came from
This is an independent, third-party profile of Oracle Hospitality Reservation Config 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.