OPERA Cloud Rate API
APIs to cater for Rate Availability functionality in OPERA Cloud. Rate Management provides all the tools you need to effectively define and manage the rate structures for a property in OPERA Cloud. Some of the things you can do include creating and managing rate codes, rate classes, rate categories, display sets, rate strategies, as well as managing promotion groups and codes. Compatible with OPERA Cloud release 26.2.0.0. 144 operation(s) documented; base path /rtp/v1. Harvested verbatim from Oracle's public hospitality-api-docs repository (Swagger 2.0, release 26.2.0.0).
OPERA Cloud Rate API is one of 135 APIs that Oracle Hospitality publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Availability, Rate Plan, ChainConfig, HotelConfig, and Property Management. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 144 operations across 85 paths, organized into 4 resource areas, and defines 321 schemas. It is described by OpenAPI 2.0, at version 26.2.0.0.
144 operations
85 paths
321 schemas
26 DELETE43 GET30 POST45 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 144
Across 85 paths, the API surfaces 144 operations — 26 DELETE, 43 GET, 30 POST, 45 PUT. They span 4 resource areas: RatePlan, ChainConfig, HotelConfig, Availability. Each is listed below with its method, path, parameters, and response codes.
RatePlan 112
The Rate Plan APIs allow for creating, managing, and retrieving rates and their related components such as negotiated rates and packages.
POST
/controlSegmentTemplate/{controlSegmentCode}
Create Control Segment Template
DELETE
/controlSegmentTemplate/{controlSegmentCode}
Delete Control Segment Template
PUT
/controlSegmentTemplate/{controlSegmentCode}
Change Control Segment Template
GET
/controlSegmentTemplates
Get Control Segment Templates
GET
/controlSegments
Get Control Segments
GET
/hotels/{hotelId}/bestavailablerates
Fetch Best Available Rates
POST
/hotels/{hotelId}/bestavailablerates
Create a Best Available Rates
DELETE
/hotels/{hotelId}/bestavailablerates
Delete Best Available Rates
GET
/hotels/{hotelId}/blocks/ratePlans
Get rate plans for a given block
POST
/hotels/{hotelId}/controlSegments/{controlSegmentCode}
Create a new Control Segment
DELETE
/hotels/{hotelId}/controlSegments/{controlSegmentCode}
Delete a Control Segment
PUT
/hotels/{hotelId}/controlSegments/{controlSegmentCode}
Modify a Control Segment
DELETE
/hotels/{hotelId}/massRateChangeLog
Delete mass rate change log
GET
/hotels/{hotelId}/massRateChangeStatus
Get mass rate change status
PUT
/hotels/{hotelId}/massRatePlanSchedulesdeprecated
Set mass rate plan schedules
GET
/hotels/{hotelId}/negotiatedRates
Get negotiated rates and profiles
POST
/hotels/{hotelId}/negotiatedRates
Create negotiated rates
PUT
/hotels/{hotelId}/negotiatedRates/distributions
Distribute negotiated rates
PUT
/hotels/{hotelId}/negotiatedRates/{rateCode}
Change negotiated rates
GET
/hotels/{hotelId}/negotiatedRates/{rateCode}/profiles
Fetch Negotiated Rates
GET
/hotels/{hotelId}/packageForecastGroups
Get Hotel Package Forecast Groups
POST
/hotels/{hotelId}/packageForecastGroups
Create Hotel Package Forecast Groups
PUT
/hotels/{hotelId}/packageForecastGroups
Change Hotel Package Forecast Groups
DELETE
/hotels/{hotelId}/packageForecastGroups
Delete Hotel Package Forecast Groups
GET
/hotels/{hotelId}/packageFormulaRanges
Get package formula ranges
POST
/hotels/{hotelId}/packageFormulaRanges
Create package formula ranges
PUT
/hotels/{hotelId}/packageFormulaRanges/{packageFormulaRangeId}
Change package formula ranges
DELETE
/hotels/{hotelId}/packageFormulaRanges/{packageFormulaRangeId}
Delete package formula ranges
GET
/hotels/{hotelId}/packageGroups
Get package groups
POST
/hotels/{hotelId}/packageGroups
Create package group
PUT
/hotels/{hotelId}/packageGroups
Change package group
DELETE
/hotels/{hotelId}/packageGroups/{packageCode}
Delete package group
GET
/hotels/{hotelId}/packages/{packageCode}
Get package for given package
POST
/hotels/{hotelId}/packages/{packageCode}
Create package
PUT
/hotels/{hotelId}/packages/{packageCode}
Change the package
DELETE
/hotels/{hotelId}/packages/{packageCode}
Delete the package
GET
/hotels/{hotelId}/packages/{packageCode}/rates
Get package rates
POST
/hotels/{hotelId}/packages/{packageCode}/text
Generate package description with AI Author Service Proxy.
DELETE
/hotels/{hotelId}/profiles/{profileId}/startDate/{startDate}/negotiatedRates/{ratePlanId}
Delete negotiated rates
GET
/hotels/{hotelId}/promotionCodes
Get promotion codes
PUT
/hotels/{hotelId}/promotionCodes/{promotionCode}
Change promotion codes
POST
/hotels/{hotelId}/promotionCodes/{promotionCode}
Create promotion codes
POST
/hotels/{hotelId}/promotionCodes/{promotionCode}/coupons
Generate promotion coupon codes
GET
/hotels/{hotelId}/promotionCodes/{promotionCode}/coupons
Get promotion coupon codes
PUT
/hotels/{hotelId}/promotionCodes/{promotionCode}/coupons/{couponId}
Update promotion coupon codes
GET
/hotels/{hotelId}/promotionCodes/{promotionCode}/coupons/{couponId}
Get promotion coupon code
GET
/hotels/{hotelId}/promotionGroups
Get promotion groups
PUT
/hotels/{hotelId}/promotionGroups/copy
Copy promotion groups
PUT
/hotels/{hotelId}/promotionGroups/{groupCode}
Change promotion groups
POST
/hotels/{hotelId}/promotionGroups/{groupCode}
Create promotion groups
DELETE
/hotels/{hotelId}/promotionGroups/{groupCode}
Delete promotion groups
PUT
/hotels/{hotelId}/rateAccessExclusions
Set rate access exclusions
DELETE
/hotels/{hotelId}/rateAccessExclusions
Delete rate access exclusions
GET
/hotels/{hotelId}/rateGroups
Get rate groups
PUT
/hotels/{hotelId}/rateGroups
Change rate groups
POST
/hotels/{hotelId}/rateGroups
Create rate groups
DELETE
/hotels/{hotelId}/rateGroups
Delete rate groups
GET
/hotels/{hotelId}/ratePlan/schedule/yieldAdjustment
Get rate plan schedule yield adjustments
POST
/hotels/{hotelId}/ratePlanSchedules/{scheduleId}/split
Split rate plan schedule
GET
/hotels/{hotelId}/ratePlans
Get rate plans by Hotel Code
POST
/hotels/{hotelId}/ratePlans
Create rate plans
PUT
/hotels/{hotelId}/ratePlans/sync
Synchronizes Rate Plan information including Rate Header and Packages across target properties.
GET
/hotels/{hotelId}/ratePlans/{ratePlanCode}
Get rate plan
PUT
/hotels/{hotelId}/ratePlans/{ratePlanCode}
Change rate plan
DELETE
/hotels/{hotelId}/ratePlans/{ratePlanCode}
Delete rate plan
PUT
/hotels/{hotelId}/ratePlans/{ratePlanCode}/copy
Copy rate plans
PUT
/hotels/{hotelId}/ratePlans/{ratePlanCode}/dailySchedules
Set daily rate plan schedule range
DELETE
/hotels/{hotelId}/ratePlans/{ratePlanCode}/dailySchedules
Delete daily rate plan schedule range
GET
/hotels/{hotelId}/ratePlans/{ratePlanCode}/metrics
Get rate plan metrics
PUT
/hotels/{hotelId}/ratePlans/{ratePlanCode}/packages
Change rate plan package
POST
/hotels/{hotelId}/ratePlans/{ratePlanCode}/packages
Create rate plan package
DELETE
/hotels/{hotelId}/ratePlans/{ratePlanCode}/packages
Delete rate plan packages
PUT
/hotels/{hotelId}/ratePlans/{ratePlanCode}/postingRhythms
Change rate plan posting rhythms
POST
/hotels/{hotelId}/ratePlans/{ratePlanCode}/postingRhythms
Create rate plan posting rhythms
DELETE
/hotels/{hotelId}/ratePlans/{ratePlanCode}/postingRhythms
Delete rate plan posting rhythms
GET
/hotels/{hotelId}/ratePlans/{ratePlanCode}/schedules
Get rate plan schedules
PUT
/hotels/{hotelId}/ratePlans/{ratePlanCode}/schedules
Change rate plan schedules
POST
/hotels/{hotelId}/ratePlans/{ratePlanCode}/schedules
Create rate plan schedules
DELETE
/hotels/{hotelId}/ratePlans/{ratePlanCode}/schedules
Delete rate plan schedule
PUT
/hotels/{hotelId}/ratePlans/{ratePlanCode}/schedules/set
Set rate plan schedules
PUT
/hotels/{hotelId}/ratePlans/{ratePlanCode}/sourceTiers/{sourceTierId}/destinationTiers/{destinationTierId}/schedules/copy
Copy tiered rate schedules
GET
/hotels/{hotelId}/rateStrategies
Get rate strategies
POST
/hotels/{hotelId}/rateStrategies
Create rate strategies
PUT
/hotels/{hotelId}/rateStrategies/{rateStrategyId}
Change rate strategies
DELETE
/hotels/{hotelId}/rateStrategies/{rateStrategyId}
Delete rate strategies
GET
/hotels/{hotelId}/rates/activityLog
Get rate activity log
GET
/hotels/{hotelId}/yieldAdjustments
Get yield adjustments
GET
/packageForecastGroups
Get Template Package Forecast Groups
POST
/packageForecastGroups
Create Template Package Forecast Groups
PUT
/packageForecastGroups
Change Template Package Forecast Groups
DELETE
/packageForecastGroups/{packageForecastGroupCode}
Delete Template Package Forecast Groups
GET
/packages
Get packages
PUT
/packages/copy
Copy package code(s)
PUT
/packages/text/{responseId}
Save the package description to the AI Author Service.
GET
/profiles/{profileId}/negotiatedRates
Get negotiated rate details for given profile
GET
/promotionCodes
Get Template Promotion Codes
PUT
/promotionCodes/{promotionCode}
Change Template Promotion Code
POST
/promotionCodes/{promotionCode}
Create Template Promotion Code
POST
/promotionCodes/{promotionCode}/coupons
Generate template promotion coupon codes
GET
/promotionCodes/{promotionCode}/coupons
Get promotion coupon codes at template level.
PUT
/promotionCodes/{promotionCode}/coupons/inactivate
Inactivate promotion coupon codes for a given batch code.
PUT
/promotionCodes/{promotionCode}/coupons/{couponId}
Update promotion coupon codeat template level.
GET
/promotionCodes/{promotionCode}/coupons/{couponId}
Get promotion coupon code at template level.
PUT
/ratePlanSchedules
Manages rate plan schedules
GET
/ratePlans
Get rate plans
POST
/rateStrategies
Set rate strategies
GET
/services/rateplan/status
Get Rate plan service version
PUT
/upsert/hotels/{hotelId}/packageFormulaRanges
Create/Change package formula ranges
PUT
/upsert/hotels/{hotelId}/promotionCodes/{promotionCode}
Change/Create promotion codes
PUT
/upsert/hotels/{hotelId}/rateGroups
Change/Create rate groups
PUT
/upsert/hotels/{hotelId}/rateStrategies
Create/Change rate strategies
PUT
/upsert/promotionCodes/{promotionCode}
Change/create Template Promotion Code
ChainConfig 4
These APIs will allow you to configure rate related configuration related for Administration.
GET
/displaySets
Get Display Sets
POST
/displaySets
Create Display Sets
PUT
/displaySets/{displaySetsId}
Change Display Sets
DELETE
/displaySets/{displaySetsId}
Delete Display Sets
HotelConfig 25
These APIs will allow you to configure rate related configuration related for Administration.
GET
/hotels/{hotelId}/rateCategories
Get Rate Category
POST
/hotels/{hotelId}/rateCategories
Create Rate Category
DELETE
/hotels/{hotelId}/rateCategories
Delete Rate Category
PUT
/hotels/{hotelId}/rateCategories
Change Rate Category
GET
/hotels/{hotelId}/rateClasses
Get rate classes
POST
/hotels/{hotelId}/rateClasses
Create new rate class
PUT
/hotels/{hotelId}/rateClasses/{rateClassCode}
Changes to rate class
DELETE
/hotels/{hotelId}/rateClasses/{rateClassCode}
Delete rate class
GET
/hotels/{hotelId}/rateSeasons
Get Hotel Rate Seasons
POST
/hotels/{hotelId}/rateSeasons
Create Hotel Rate Seasons
PUT
/hotels/{hotelId}/rateSeasons/{seasonCode}
Change Hotel Rate Seasons
DELETE
/hotels/{hotelId}/rateSeasons/{seasonCode}
Delete Hotel Rate Seasons
GET
/templates/rateCategories
Get Template Rate Categories
POST
/templates/rateCategories
Create a Template Rate Category
PUT
/templates/rateCategories/{rateCategoryCode}
Change Template Rate Category
DELETE
/templates/rateCategories/{rateCategoryCode}
Delete a Template Rate Category
GET
/templates/rateClasses
Get template rate classes
POST
/templates/rateClasses
Create new template rate class
PUT
/templates/rateClasses/{rateClassCode}
Change template rate class
DELETE
/templates/rateClasses/{rateClassCode}
Delete template rate class
GET
/templates/rateSeasons
Get Template Rate Seasons
POST
/templates/rateSeasons
Create Template Rate Seasons
PUT
/templates/rateSeasons/{seasonCode}
Change Template Rate Seasons
DELETE
/templates/rateSeasons/{seasonCode}
Delete Template Rate Seasons
PUT
/upsert/hotels/{hotelId}/rateSeasons/{seasonCode}
Create/Change Hotel Rate Seasons
Availability 3
The Availability APIs within the Rate module allow you to retrieve, create and update Promotion codes, as well as Coupon codes.
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 321
The contract defines 321 schemas that model the data the API accepts and returns. The most detailed are ratePlanType (53 properties), configPostingAttributesType (21 properties), ratePlanScheduleDetailType (20 properties), promotionCodeDetailsType (18 properties). Each schema is shown below with its type and property counts.
displaySetsDetails
object
Response object for fetching Display Sets.
3 properties
displaySetsType
array
List of Display Sets.
displaySetType
object
Contains Common Master configuration detail.
6 properties
translationTextType2000
object
Contains Multiple translated texts and language codes.
2 properties
translationsTextType
array
Language code for the translation.
links
array
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
2 required
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
displaySetsCriteria
object
Request object for creating Display Sets.
3 properties
status
object
Response Body.
2 properties
displaySetsToBeChanged
object
Request object for changing Display Sets.
3 properties
getBestAvailableRatesDetails
object
8 properties
bestAvailableRatesListType
object
The list of best availabe rates for rate code(s)
3 properties
bestAvailableRateType
object
The list of best availabe rates for rates code(s).
3 properties
codeListType
array
masterInfo
object
The reference to the rate codes selected as best availabe rates
1 property
codeDescriptionType
object
This contains a generic code and description information.
2 properties
createBestAvailableRates
object
Request to create best available rates for rate code(s)
3 properties
bestAvailableRatesType
object
The best available rate for rate code(s)
5 properties
dateRangeType
object
Date Range with Start and End dates.
2 properties
blockRatePlans
object
Response object to fetch rate plans summary information for blocks.
3 properties
blockRatePlansType
object
Description of rate codes for the block and their information.
2 properties
blockRatePlanType
object
The block rate plan code information.
10 properties
massRateChangeStatus
object
A response message to fetch the status of mass rate update operation.
3 properties
massRateChangeStatusListType
array
Mass rate update details.
massRateChangeStatusType
object
Mass Rate Update Status details.
5 properties
massRateChangeProcessStatusType
string
Simple type for base type, flat or percentage.
massRateChangeDetailLogListType
array
Mass rate update details.
massRateChangeDetailLogType
object
3 properties
massRateChangeRecordStatusType
string
Simple type for base type, flat or percentage.
massRatePlanSchedules
object
A Request message to update the rate codes schedule.
3 properties
massRateChangeCriteriaType
object
Container for mass rate update operation.
10 properties
timeSpanDaysOfWeekType
object
Container for Time span with days of week.
8 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
ratePlanScheduleType
string
Simple type for rate code types.
baseType
string
Simple type for base type, flat or differential.
amountOrOffsetType
string
Simple type for amount type.
percentageOrFlatType
string
Simple type for flat or percentage type.
rateCodes
List of rate codes.
rateCodesListType
array
Rate Codes.
roomTypes
List of room types.
roomTypeListType
array
Room Type.
rateAmountsType
object
13 properties
rateByAgeBucketsType
array
Rate amount by age bucket.
rateByAgeBucketType
object
Rate amount by age bucket.
4 properties
ratePlanRoundingType
string
Simple type for base type, flat or percentage.
negotiatedRates
object
Response object for fetching negotiated rates and profile discounts.
9 properties
negotiatedRatesType
array
List of Negotiated rates to be maintained.
negotiatedRateType
object
Negotiated rate details
3 properties
negotiatedProfileType
object
Profile details
5 properties
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
uniqueID_Type
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
2 properties
profileNameType
object
This provides name information for a person.
8 properties
personNameTypeType
string
Person's name in an external system.
negRateAccessType
object
Details of Negotiated rate.
8 properties
profileDiscountType
object
Discount details for a profile.
8 properties
profileTypeType
string
The types of Profile handled by the web service.
distributedNegotiatedRates
object
Request object for distribute negotiated rates. This object contains a list of negotiated rates that are to be distributed and a list of properties to which to…
4 properties
hotelCodeListType
array
Hotel code.
negotiatedRatesDetails
object
Response Body.
2 properties
hotelPackageForecastGroups
object
Response object for fetching package forecast groups for a hotel.
8 properties
hotelPackageForecastGroupsType
array
Hotel package forecast group details.
hotelPackageForecastGroupType
object
Base details common between hotel and template package forecast groups.
6 properties
hotelPackageForecastGroupsToCreate
object
Request object for creating new package forecast groups for a hotel.
3 properties
hotelPackageForecastGroupsToChange
object
Request object for modifying package forecast groups for a hotel.
3 properties
packageFormulaRanges
object
Response for the request to search for package formula ranges. Based on the hotel code and tax range type code, response can contain multiple package formula r…
3 properties
packageFormulaRangesType
array
Collection of Package Formula Ranges.
packageFormulaRangeType
object
Package Formula Ranges data.
11 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
packageGroupsInfo
object
Response object to fetch package groups.
4 properties
hotelPackageGroupsType
object
2 properties
packageGroupType
object
Information about a package group common to all usages.
9 properties
packageCodeListType
array
Package Full Information
packageCodeType
object
13 properties
packageCodeHeaderType
object
4 properties
configPackagePrimaryDetailsType
object
A Config Package Info type.
10 properties
configPackageTransactionType
object
A HotelPackageTransaction type.
6 properties
packagePostingRulesType
object
5 properties
packageTransactionCodeType
object
3 properties
amountDeterminationType
string
Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.
configPostingAttributesType
object
A config Package posting attributes type.
21 properties
functionArgumentsType
array
Collection of function arguments and their corresponding values.
functionArgumentType
object
This type provided details of a function argument and the value it holds.
8 properties
packagePostingRhythmType
object
Package Posting rhythm type.
5 properties
postingRhythmType
string
Simple type for posting Rhythm types. Note: for redemption packages, EveryNight is the only valid value.
packageCalculationRuleType
string
Simple type for package caluculation rules.
pkgInventoryItemType
object
4 properties
configPackageUsageDetailType
object
A Config Package Usage Detail type.
4 properties
productSourceType
string
Sources of Products
configPackageScheduleType
object
A Hotel Package Schedule. 'new' prefixed properties hold updated values for create or update operations; non-prefixed properties hold original values for updat…
15 properties
hotelPackageSchedulePriceType
object
A Hotel Package Schedule Pricing.
5 properties
packageChildBuckets
string
Simple type for package child buckets.
masterInfoType
object
2 properties
codeInfoType
object
4 properties
addtionalCodeInfoType
array
Holds name of additional code information
masterInfoCodeDetailType
string
masterType
string
packageGroup
object
3 properties
packageInfo
object
Request object to create a package.
3 properties
packageRates
object
Response object to fetch rate plan codes associated for a package. It contains package's short information.
4 properties
ratePlanShortInfoType
object
The Rate plan code information.
13 properties
ratePlanPrimaryDetailsType
object
11 properties
rateCodeLockStatusType
string
Indicates that the rate code is locked by the central system and cannot be edited at the property level.
ratePlanApprovalStatusType
string
Indicates that the Rate Plan is approved for selling.
ratePlanClassificationsType
object
5 properties
ratePlanDescriptionsType
object
Info URL, Short and Long Info details of the rate plan.
4 properties
ratePlanExternalAttributesType
object
1 property
codeType
string
Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
propertyPromotionCodes
object
3 properties
propertyPromotionCodesType
array
A property promotion.
propertyPromotionCodeType
object
A template promotion.
7 properties
promotionCodeDetailsType
object
Details of the promotion.
18 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
propertyPromotionRateCodesType
array
List of Promotion Rate Code
propertyPromotionRateCodeType
object
5 properties
promoCodeRoutingInstructionType
object
Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit
15 properties
trxCodesInfoType
array
List of Transaction codes info.
trxInfoType
object
Transaction codes info.
10 properties
articleInfoType
object
Information regarding an article.
9 properties
articlePostItType
object
Post it information of an article.
2 properties
colorType
string
Color configuration type. This color configuration provides a visual category of entities.
billingInstructionsType
array
Set of Billing Instruction codes.
billingInstructionType
object
Configured Billing Instruction which represents a set of Transaction Codes.
4 properties
authorizerInfoType
object
Authorizer Information
5 properties
propertyPromotionCode
object
3 properties
promotionGroups
object
3 properties
promotionGroupsType
array
A promotion group.
promotionGroupType
object
Details of a Promotion Group
9 properties
promotionCodeType
object
A template promotion.
2 properties
promotionGroupsCopy
object
3 properties
copyPromotionGroupsCriteriaType
object
Copy Promotion Groups criteria type to copy multiple Promotion Groups from one Hotel to another Hotel.
1 property
copyPromotionGroupType
object
The type describes Promotion Groups Details being copied.
2 properties
promotionGroup
object
3 properties
rateAccessExclusions
object
3 properties
rateAccessExclusionsType
object
3 properties
1 required
rateAccessExclusionType
object
Access Exclusion information indicating the actions allowed under a HUB or Hotel for which the access exclusion is set.
8 properties
rateCategoryDetails
object
Response object for fetching Rate Categories for a property.
3 properties
hotelRateCategoriesType
object
2 properties
rateCategoryType
object
This type represents the rate category type.
3 properties
rateCategoryCriteria
object
Request object for Creating a new Rate Category for a property.
3 properties
hotelRateCategoryType
object
This type represents the rate category type.
3 properties
rateCategoryToBeChanged
object
Request object for modifying a Rate Category for a property.
3 properties
rateClassDetails
object
Response for fetch rate classes.
3 properties
rateClassesType
array
Collection of hotel rate classes.
rateClassType
object
A hotel rate class.
7 properties
simpleRateCategoriesType
array
List of Rate Categories with description.
rateClassCriteria
object
Request to create new rate class.
3 properties
rateClassToBeChanged
object
Request to save changes to rate class.
3 properties
rateGroupsInfo
object
8 properties
rateGroupsType
array
Collection of Rate Groups.
rateGroupType
object
Details of Rate Group.
4 properties
rateGroups
object
3 properties
ratePlanScheduleYieldAdjustments
object
Response object to fetch Yield adjustments for rate plan schedule.
4 properties
scheduleYieldSummaryType
array
Yield summary for each adjutment type.
yieldSummaryType
object
Yield adjustment summary for each adjutment type.
2 properties
adjustmentCategoryType
string
Simple type for Yield Adjustment types.
scheduleYieldInfoType
object
The list of complete Yield adjustment information for the rate schedule.
8 properties
yieldInfoType
object
The complete Yield adjustment information for the rate schedule.
6 properties
ratePlanScheduleToSplit
object
Request object to split rate plan schedule.
4 properties
baseRatePlanScheduleDetailType
object
11 properties
scheduleRateAmountsType
object
15 properties
advancedBaseRateOffsetType
object
A Rate which is of Advanced Dynamic Base Rate can have rate schedule based on an offset from its Base Rate or BAR Rate.
6 properties
rateAmountBoundariesType
object
Rate amount boundaries for the rate plan schedule. Minimum and/or maximum rate amounts can be defined for one and/or two adults.
2 properties
rateAmountBoundaryType
object
Set of rate amounts for one and/or two adults. This set will represent either the minimum or maximum rate boundary.
2 properties
ratePlanScheduleClassificationsType
object
2 properties
occupantThresholdPricingType
object
Definition for creating pricing for a rate schedule, based on occupants threshold level.
3 properties
scheduleAdjustmentDetailsType
array
The list of adjustment codes for the rate plan schedule.
adjustmentDetailType
object
The adjustment code details for the rate schedule.
3 properties
ratePackagesType
object
2 properties
ratePackageCodeListType
array
Rate Package Full Information
ratePackageCodeType
object
Package code details applied to a rate plan.
13 properties
ratePackageGroupType
object
Information about a package group common to all usages.
8 properties
tierIDType
integer
ratePlanInfo
object
Response object to fetch rate plan's complete details.
4 properties
ratePlanType
object
The Rate plan code Details.
53 properties
ratePlanTransactionDetailsType
object
9 properties
ratePlanRoomTransactionCodesType
array
Single transaction code and room type/class association.
ratePlanRoomTransactionCodeType
object
Transaction code associated to a room type or room class on a rate plan.
3 properties
exchangePostingType
string
Fixed at Block.
ratePlanPostingRhythmType
object
Rate Plan Posting rhythm type.
1 property
ratePlanAdvancedPostingRhythmsType
array
Posting rhythm details for a rate plan containing Buy x Get y functionality.
ratePlanAdvancedPostingRhythmType
object
Posting rhythm details for a rate plan containing Buy x Get y functionality.
8 properties
ratePlanCommissionType
object
3 properties
ratePlanDepositType
object
1 property
depositMaturityPreferenceType
string
Fixed values for Deposite Maturity Preference affecting the rate code
rateRoomTypeListType
array
Details of each room type
rateRoomTypeDetailType
object
Details of single room type
4 properties
ratePlanControlsType
object
2 properties
ratePlanSellControlsType
object
8 properties
ratePlanYieldControlsType
object
4 properties
ratePlanYieldableType
string
Simple type for valid values for Yieldable element for the Rate plan code.
yieldMarketCodeListType
array
Yield Market Code for the rate plan code.
ratePlanDistributionType
object
6 properties
indicatorsType
array
Collection of lamp indicators.
indicatorType
object
Lamp indicator Type.
2 properties
ratePlanBasedOnRatesType
array
Rate plan type based on rates.
ratePlanBasedOnRateType
object
Base Rate type such as "Base Rate", "Dynamic Base Rate"
5 properties
ratePlanCodeListType
array
Rate Plan code.
advancedDynamicBaseRateType
object
Advanced Dynamic Base Rate type
4 properties
basedOnRatePlanType
string
None means that rate is a standard rate. If sent in the changeRatePlan operation will delete any Based on Rate Plan Type.
ratePlanScheduleInfoType
object
This type contains summary details about the rate plan schedules such as Schedulesefined etc.
1 property
ratePlanNotesType
array
ratePlanNoteType
object
Details of the Rate Plan Approval Note
7 properties
ratePlanRoutingInstructionsType
object
Routing fetchInstructions details for a rate plan.
3 properties
routingProfileTypeType
string
Profile Types available for routing instructions.
ratePlan
object
Request object to create rate plan.
3 properties
ratePlansCopy
object
Request object for Copying rate plans to multiple hotels.
3 properties
copyRatePlansCriteriaType
object
Copy Rate plans criteria type to copy multiple rate plans from one Hotel to another Hotel.
5 properties
copyRatePlanType
object
The type describes Rate plan Details being copied.
2 properties
ratePlansCopyDetails
object
Return object to the request for copying rate plans to multiple hotels.
3 properties
copyRatePlansResponseType
object
Copy Rate plan response contains the response messages to identify what happened during copy process.
2 properties
dailyRatePlanScheduleRange
object
A Request message that sets the rate plan schedules for daily rates as a range.
3 properties
ratePlanPackages
object
Request object to attach package codes and package groups to a rate plan.
4 properties
genericHotelCodeCodeType
object
Generic Type to specify unique/primary id for the code. mostly used for Hotel level configuration codes removal request.
2 properties
ratePlanPostingRhythms
object
Request object for creating new rate plan advanced posting rhythms.
4 properties
ratePlanSchedulesInfo
object
Response object to fetch rate plan schedules.
4 properties
ratePlanScheduleListType
object
9 properties
ratePlanSchedulesType
object
2 properties
ratePlanScheduleDetailType
object
Details of rate plan schedule including room type list and days of week of the schedule.
20 properties
ratePlanMasterInfoType
object
The Rate plan info type is used primarily by rate plan schedules to get basic rate plan header details.
14 properties
rateTiersType
array
Details for each rate tier.
rateTierType
object
Details for a single rate tier.
3 properties
ratePlanSchedules
object
Request object to change rate plan schedules.
5 properties
ratePlanSchedulesToCreate
object
Request object to create rate plan schedules.
5 properties
tieredRateSchedulesCopy
object
Request object to copy the specified tier 1 rate schedules into the specified tiers.
9 properties
rateOffsetType
object
Rate Offset details for copying a rate schedule to a different tier.
3 properties
rateSeasonsDetails
object
Response object for fetching rate seasons for a hotel.
9 properties
rateSeasonsType
array
Hotel rate season details.
rateSeasonType
object
Base details common between hotel and template rate seasons.
6 properties
rateSeasonsCriteria
object
Request object for creating new rate seasons for a hotel.
3 properties
rateSeasonsToBeChanged
object
Request object for modifying rate seasons for a hotel.
3 properties
rateStrategies
object
Response object for Fetching existing Rate strategies.
8 properties
rateStrategiesType
object
The Rate strategy type.
2 properties
rateStrategyType
object
The Rate strategy type.
4 properties
strategyDetailType
object
The Rate strategy details.
4 properties
strategyConditionType
object
The Rate strategy condition details type.
5 properties
rateStrategyConditionType
string
Rate Strategy control types.
thresholdType
object
Condition threshold value with incremental flag.
2 properties
strategyRestrictionType
object
The Rate strategy restriction details.
9 properties
strategyRestrictionStatusesType
string
strategyControlType
object
The Rate strategy Control type.
2 properties
rateStrategy
object
Request object for Creating a new Rate Strategy.
3 properties
hotelRateStrategyType
object
The Rate strategy type with Hotel code.
5 properties
rateActivityLog
object
Response object to fetch rate activity log.
3 properties
activityLogListType
object
7 properties
activityLogType
object
12 properties
promotionCouponValidationDetails
object
Response for validating a coupon.
3 properties
couponInfoType
object
Information about the coupon.
3 properties
yieldAdjustments
object
Response object to fetch Yield adjustments based on the requested criteria.
3 properties
yieldAdjustmentsType
object
The Yield adjustments defined in the system based on the request.
5 properties
templatePackageForecastGroups
object
Response object for fetching template package forecast groups.
3 properties
templatePackageForecastGroupsType
array
Template package forecast group details.
templatePackageForecastGroupType
object
Base details common between hotel and template package forecast groups.
5 properties
packagesInfo
object
Response object to fetch list of packages.
4 properties
hotelPackageCodesType
object
Depending on the fetch instructions either full details or basic details will be fetched
3 properties
packageCodeShortInfoType
object
8 properties
packagesCopy
array
List of the package codes to be copied to other hotel code(s).
copyPackageCodesType
object
Copy instructions for package codes.
3 properties
copyPackageCodeInfoType
object
The type gives details of the source package code to be copied along with information of the target where the package code is being copied. Details include sou…
3 properties
templatePromotionCodes
object
9 properties
templatePromotionCodesType
array
A template promotion.
templatePromotionCodeType
object
A template promotion.
3 properties
templatePromotionCode
object
3 properties
ratePlansSchedulesToManage
object
Request object to create/change/delete rate plans schedules.
3 properties
hotelRatePlanSchedulesType
object
3 properties
ratePlansSummary
object
Response object to fetch rate plans summary information.
4 properties
rateStrategiesToSet
object
Request object for setting rate strategies. This operation will change details of rate strategy if rate strategy with the given Hotel Code, Restriction Dates,…
3 properties
templateRateCategoryDetails
object
3 properties
templateRateCategoriesType
array
templateRateCategoryCriteria
object
3 properties
templateRateCategoryType
object
This type represents the rate category type.
2 properties
templateRateCategoryToBeChanged
object
3 properties
templateRateClassDetails
object
Response for fetch template rate classes.
3 properties
templateRateClassesType
array
Collection of template rate classes.
templateRateClassType
object
A template rate class.
5 properties
templateRateClassCriteria
object
Request to create new template rate class.
3 properties
templateRateClassToBeChanged
object
Request to save changes to template rate class.
3 properties
templateRateSeasonsDetails
object
Response object for fetching template rate seasons.
3 properties
templateRateSeasonsType
array
Hotel rate season details.
templateRateSeasonType
object
Base details common between hotel and template rate seasons.
4 properties
templateRateSeasonsCriteria
object
Request object for creating new template rate seasons.
3 properties
templateRateSeasonsToBeChanged
object
Request object for modifying template rate seasons.
3 properties
actionType
string
Action types allowed by the event api.
updateRatePlanSchedulesType
object
3 properties
ratePlansSync
object
Request object to synchronize rate codes.
2 properties
2 required
ratePlansSyncTargetType
object
Attributes related to sync target like Hotel Ids.
1 property
1 required
managedByOptions
string
Describes of the Configuration is Managed by Enterprise or Property.
ratePlanSchedulesToSet
object
Request object to set rate plan schedules.
3 properties
generatePromotionCouponCodes
object
Request object to generate the promotion coupon code.
1 property
generatePromotionCouponCodeType
object
Consist details to generate promotion coupon codes.
10 properties
3 required
couponGenerateOptionType
string
Coupon Generation Options.
updatePromotionCouponCode
object
Request object to update the promotion coupon code.
1 property
updatePromotionCouponCodeType
object
Promotion coupon code details to be updated.
1 property
1 required
getPromotionCouponCodes
object
Collection of promotion coupon code details.
9 properties
getPromotionCouponCode
object
Response object to get the promotion coupon code based on the resort and promotion code.
3 properties
inactivatePromotionCouponBatchCodeType
object
Promotion coupon batch code details to be inactivated.
2 properties
1 required
promotionCouponCodeType
object
Promotion coupon code details.
9 properties
generatedCouponCodeDetails
object
Response consists of the generated promotion coupon code details.
3 properties
couponCodeStatus
string
Status of a promotion coupon code.
daysOfWeekControlsType
object
Populated when Package Availability Control is set to 'Days of the Week'. Atleast one of the properties must be provided.
7 properties
operaVersion
object
Response for Ping operation.
3 properties
ratePostingInterval
string
Allowed values for rate posting interval. Nightly is default when not provided.
translationTextType40
object
Contains Multiple translated texts and language codes.
2 properties
ratePlanMetrics
object
Rate plan metrics counts.
2 properties
restrictionGroupType
string
Casino restriction group assigned to this rate plan. Allowed values: A or B. Required when casinoComp is true.
generatePackageCodeDescriptionRequest
object
Request object to generate a package code description.
5 properties
generatePackageCodeDescriptionResponse
object
Response object containing the generated text.
4 properties
savePackageCodeDescriptionRequest
object
Request object containing the saved text and response id used to save a response into the AI Author Service.
1 property
1 required
savePackageCodeDescriptionResponse
object
Response object containing the saved text and response id used to save a response into the AI Author Service.
3 properties
templateControlSegmentType
object
Template Control Segment (no hotelId).
7 properties
3 required
templateControlSegmentCriteria
object
Request object that holds the details of Control Segment Template to be created.
3 properties
templateControlSegmentToBeChanged
object
Request object that holds the details of Control Segment Template to be changed.
3 properties
templateControlSegmentDetails
object
Response for fetch Control Segment Templates.
6 properties
propertyControlSegmentType
object
Create/Update request body for Control Segment (hotelId is provided in the path).
6 properties
4 required
controlSegmentsDetails
object
4 properties
controlSegmentType
object
Control Segment details for a hotel. Only Groups A and B are supported.
8 properties
4 required
ruleGroupsType
object
Restriction rules by group. Only Groups A and B are supported.
2 properties
ruleGroupType
object
8 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 Distribution ARI Publication
OPERA Cloud Distribution Outbound Lookup
OPERA Cloud Distribution Content Notification
OPERA Cloud Distribution Book
OPERA Cloud Distribution Content
OPERA Cloud Distribution Property Controls
OPERA Cloud Distribution Reservation Service
OPERA Cloud Distribution Authentication API
OPERA Cloud Distribution Onboarding
OPERA Cloud Distribution Reservation Notification
OPERA Cloud Distribution Shop
Nor1 Integrated Upsell API
#Availability#Rate Plan#ChainConfig#HotelConfig#Property Management#OPERA Cloud
Where this information came from
This is an independent, third-party profile of OPERA Cloud Rate 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.