Oracle Hospitality Rate Plan API
The Rate Plan APIs allow for creating, managing, and retrieving rates and their related components such as negotiated rates and packages.
Oracle Hospitality Rate Plan 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 Rate Plan. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 112 operations across 68 paths, and defines 281 schemas. It is described by OpenAPI 3.2.0, at version 26.2.0.0.
Requests are made against a single base URL, /rtp/v1.
112 operations
68 paths
281 schemas
19 DELETE33 GET23 POST37 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 112
Across 68 paths, the API surfaces 112 operations — 19 DELETE, 33 GET, 23 POST, 37 PUT. 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
Schemas 281
The contract defines 281 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.
hotelPackageCodesType
object
Depending on the fetch instructions either full details or basic details will be fetched
3 properties
ratePostingInterval
string
Allowed values for rate posting interval. Nightly is default when not provided.
ratePlansCopy
object
Request object for Copying rate plans to multiple hotels.
3 properties
rateGroupsType
array
Collection of Rate Groups.
packagePostingRulesType
object
5 properties
ratePlanAdvancedPostingRhythmType
object
Posting rhythm details for a rate plan containing Buy x Get y functionality.
8 properties
templatePromotionCodes
object
9 properties
scheduleYieldSummaryType
array
Yield summary for each adjutment type.
copyRatePlansResponseType
object
Copy Rate plan response contains the response messages to identify what happened during copy process.
2 properties
propertyControlSegmentType
object
Create/Update request body for Control Segment (hotelId is provided in the path).
6 properties
4 required
ratePlanPostingRhythms
object
Request object for creating new rate plan advanced posting rhythms.
4 properties
rateAmountsType
object
13 properties
generatePromotionCouponCodeType
object
Consist details to generate promotion coupon codes.
10 properties
3 required
massRateChangeRecordStatusType
string
Simple type for base type, flat or percentage.
configPackageUsageDetailType
object
A Config Package Usage Detail type.
4 properties
ratePlanPrimaryDetailsType
object
11 properties
ruleGroupType
object
8 properties
ratePlansSyncTargetType
object
Attributes related to sync target like Hotel Ids.
1 property
1 required
templateControlSegmentDetails
object
Response for fetch Control Segment Templates.
6 properties
hotelPackageSchedulePriceType
object
A Hotel Package Schedule Pricing.
5 properties
rateCodesListType
array
Rate Codes.
savePackageCodeDescriptionResponse
object
Response object containing the saved text and response id used to save a response into the AI Author Service.
3 properties
copyRatePlanType
object
The type describes Rate plan Details being copied.
2 properties
colorType
string
Color configuration type. This color configuration provides a visual category of entities.
copyPromotionGroupType
object
The type describes Promotion Groups Details being copied.
2 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
packageCodeHeaderType
object
4 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
packageFormulaRangeType
object
Package Formula Ranges data.
11 properties
ratePlanExternalAttributesType
object
1 property
adjustmentDetailType
object
The adjustment code details for the rate schedule.
3 properties
ratePlan
object
Request object to create rate plan.
3 properties
ratePlansCopyDetails
object
Return object to the request for copying rate plans to multiple hotels.
3 properties
amountDeterminationType
string
Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.
templatePromotionCode
object
3 properties
pkgInventoryItemType
object
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
baseType
string
Simple type for base type, flat or differential.
ratePlanScheduleType
string
Simple type for rate code types.
daysOfWeekControlsType
object
Populated when Package Availability Control is set to 'Days of the Week'. Atleast one of the properties must be provided.
7 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
ratePlanControlsType
object
2 properties
templatePromotionCodeType
object
A template promotion.
3 properties
indicatorsType
array
Collection of lamp indicators.
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
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
profileDiscountType
object
Discount details for a profile.
8 properties
indicatorType
object
Lamp indicator Type.
2 properties
updatePromotionCouponCode
object
Request object to update the promotion coupon code.
1 property
billingInstructionType
object
Configured Billing Instruction which represents a set of Transaction Codes.
4 properties
rateAccessExclusionsType
object
3 properties
1 required
ratePlanRoomTransactionCodesType
array
Single transaction code and room type/class association.
ratePlanClassificationsType
object
5 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
masterInfo
object
The reference to the rate codes selected as best availabe rates
1 property
ratePlanScheduleToSplit
object
Request object to split rate plan schedule.
4 properties
propertyPromotionCodeType
object
A template promotion.
7 properties
addtionalCodeInfoType
array
Holds name of additional code information
negRateAccessType
object
Details of Negotiated rate.
8 properties
rateGroups
object
3 properties
ratePlanYieldControlsType
object
4 properties
packageRates
object
Response object to fetch rate plan codes associated for a package. It contains package's short information.
4 properties
promotionCodeDetailsType
object
Details of the promotion.
18 properties
packageFormulaRangesType
array
Collection of Package Formula Ranges.
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
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
ruleGroupsType
object
Restriction rules by group. Only Groups A and B are supported.
2 properties
scheduleRateAmountsType
object
15 properties
strategyDetailType
object
The Rate strategy details.
4 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
bestAvailableRateType
object
The list of best availabe rates for rates code(s).
3 properties
ratePackageGroupType
object
Information about a package group common to all usages.
8 properties
rateGroupsInfo
object
8 properties
yieldAdjustments
object
Response object to fetch Yield adjustments based on the requested criteria.
3 properties
ratePackageCodeType
object
Package code details applied to a rate plan.
13 properties
rateAccessExclusionType
object
Access Exclusion information indicating the actions allowed under a HUB or Hotel for which the access exclusion is set.
8 properties
yieldInfoType
object
The complete Yield adjustment information for the rate schedule.
6 properties
massRateChangeProcessStatusType
string
Simple type for base type, flat or percentage.
timeSpanDaysOfWeekType
object
Container for Time span with days of week.
8 properties
getPromotionCouponCodes
object
Collection of promotion coupon code details.
9 properties
bestAvailableRatesType
object
The best available rate for rate code(s)
5 properties
updateRatePlanSchedulesType
object
3 properties
codeListType
array
activityLogListType
object
7 properties
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
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
ratePlanScheduleDetailType
object
Details of rate plan schedule including room type list and days of week of the schedule.
20 properties
promotionGroup
object
3 properties
ratePlanSellControlsType
object
8 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
rateStrategyConditionType
string
Rate Strategy control types.
generatedCouponCodeDetails
object
Response consists of the generated promotion coupon code details.
3 properties
negotiatedRatesType
array
List of Negotiated rates to be maintained.
copyPackageCodesType
object
Copy instructions for package codes.
3 properties
ratePlanApprovalStatusType
string
Indicates that the Rate Plan is approved for selling.
hotelPackageForecastGroups
object
Response object for fetching package forecast groups for a hotel.
8 properties
masterInfoCodeDetailType
string
ratePlanRoutingInstructionsType
object
Routing fetchInstructions details for a rate plan.
3 properties
controlSegmentsDetails
object
4 properties
configPostingAttributesType
object
A config Package posting attributes type.
21 properties
packagePostingRhythmType
object
Package Posting rhythm type.
5 properties
yieldSummaryType
object
Yield adjustment summary for each adjutment type.
2 properties
ratePlanSchedulesInfo
object
Response object to fetch rate plan schedules.
4 properties
authorizerInfoType
object
Authorizer Information
5 properties
massRateChangeStatusListType
array
Mass rate update details.
status
object
Response Body.
2 properties
functionArgumentType
object
This type provided details of a function argument and the value it holds.
8 properties
masterInfoType
object
2 properties
amountOrOffsetType
string
Simple type for amount type.
rateCodes
List of rate codes.
ratePlanMetrics
object
Rate plan metrics counts.
2 properties
ratePlanScheduleYieldAdjustments
object
Response object to fetch Yield adjustments for rate plan schedule.
4 properties
rateGroupType
object
Details of Rate Group.
4 properties
ratePlanCodeListType
array
Rate Plan code.
packageTransactionCodeType
object
3 properties
dailyRatePlanScheduleRange
object
A Request message that sets the rate plan schedules for daily rates as a range.
3 properties
promotionCouponCodeType
object
Promotion coupon code details.
9 properties
blockRatePlansType
object
Description of rate codes for the block and their information.
2 properties
ratePlanAdvancedPostingRhythmsType
array
Posting rhythm details for a rate plan containing Buy x Get y functionality.
getBestAvailableRatesDetails
object
8 properties
templateControlSegmentToBeChanged
object
Request object that holds the details of Control Segment Template to be changed.
3 properties
createBestAvailableRates
object
Request to create best available rates for rate code(s)
3 properties
articlePostItType
object
Post it information of an article.
2 properties
ratePlanDistributionType
object
6 properties
promotionCodeType
object
A template promotion.
2 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
rateStrategyType
object
The Rate strategy type.
4 properties
ratePlanMasterInfoType
object
The Rate plan info type is used primarily by rate plan schedules to get basic rate plan header details.
14 properties
massRateChangeDetailLogType
object
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
roomTypeListType
array
Room Type.
ratePlanNotesType
array
rateTiersType
array
Details for each rate tier.
templatePackageForecastGroupsType
array
Template package forecast group details.
basedOnRatePlanType
string
None means that rate is a standard rate. If sent in the changeRatePlan operation will delete any Based on Rate Plan Type.
massRatePlanSchedules
object
A Request message to update the rate codes schedule.
3 properties
packageInfo
object
Request object to create a package.
3 properties
ratePlanShortInfoType
object
The Rate plan code information.
13 properties
rateRoomTypeListType
array
Details of each room type
strategyConditionType
object
The Rate strategy condition details type.
5 properties
tieredRateSchedulesCopy
object
Request object to copy the specified tier 1 rate schedules into the specified tiers.
9 properties
codeDescriptionType
object
This contains a generic code and description information.
2 properties
ratePlanSchedulesToCreate
object
Request object to create rate plan schedules.
5 properties
rateStrategy
object
Request object for Creating a new Rate Strategy.
3 properties
hotelRateStrategyType
object
The Rate strategy type with Hotel code.
5 properties
percentageOrFlatType
string
Simple type for flat or percentage type.
negotiatedProfileType
object
Profile details
5 properties
translationTextType40
object
Contains Multiple translated texts and language codes.
2 properties
productSourceType
string
Sources of Products
articleInfoType
object
Information regarding an article.
9 properties
strategyControlType
object
The Rate strategy Control type.
2 properties
configPackageTransactionType
object
A HotelPackageTransaction type.
6 properties
managedByOptions
string
Describes of the Configuration is Managed by Enterprise or Property.
postingRhythmType
string
Simple type for posting Rhythm types. Note: for redemption packages, EveryNight is the only valid value.
rateByAgeBucketsType
array
Rate amount by age bucket.
thresholdType
object
Condition threshold value with incremental flag.
2 properties
hotelPackageForecastGroupType
object
Base details common between hotel and template package forecast groups.
6 properties
rateOffsetType
object
Rate Offset details for copying a rate schedule to a different tier.
3 properties
controlSegmentType
object
Control Segment details for a hotel. Only Groups A and B are supported.
8 properties
4 required
updatePromotionCouponCodeType
object
Promotion coupon code details to be updated.
1 property
1 required
copyRatePlansCriteriaType
object
Copy Rate plans criteria type to copy multiple rate plans from one Hotel to another Hotel.
5 properties
trxInfoType
object
Transaction codes info.
10 properties
depositMaturityPreferenceType
string
Fixed values for Deposite Maturity Preference affecting the rate code
packageCodeListType
array
Package Full Information
routingProfileTypeType
string
Profile Types available for routing instructions.
templateControlSegmentCriteria
object
Request object that holds the details of Control Segment Template to be created.
3 properties
ratePlanSchedulesType
object
2 properties
rateActivityLog
object
Response object to fetch rate activity log.
3 properties
scheduleYieldInfoType
object
The list of complete Yield adjustment information for the rate schedule.
8 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
propertyPromotionCodesType
array
A property promotion.
ratePlanYieldableType
string
Simple type for valid values for Yieldable element for the Rate plan code.
ratePlanScheduleClassificationsType
object
2 properties
packageCalculationRuleType
string
Simple type for package caluculation rules.
generatePackageCodeDescriptionRequest
object
Request object to generate a package code description.
5 properties
personNameTypeType
string
Person's name in an external system.
rateStrategies
object
Response object for Fetching existing Rate strategies.
8 properties
activityLogType
object
12 properties
promoCodeRoutingInstructionType
object
Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit
15 properties
masterType
string
ratePlanBasedOnRatesType
array
Rate plan type based on rates.
advancedDynamicBaseRateType
object
Advanced Dynamic Base Rate type
4 properties
translationTextType2000
object
Contains Multiple translated texts and language codes.
2 properties
ratePlanSchedulesToSet
object
Request object to set rate plan schedules.
3 properties
couponCodeStatus
string
Status of a promotion coupon code.
massRateChangeCriteriaType
object
Container for mass rate update operation.
10 properties
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
strategyRestrictionStatusesType
string
templateControlSegmentType
object
Template Control Segment (no hotelId).
7 properties
3 required
ratePlanRoundingType
string
Simple type for base type, flat or percentage.
bestAvailableRatesListType
object
The list of best availabe rates for rate code(s)
3 properties
packagesCopy
array
List of the package codes to be copied to other hotel code(s).
packageGroupType
object
Information about a package group common to all usages.
9 properties
ratePlanInfo
object
Response object to fetch rate plan's complete details.
4 properties
rateRoomTypeDetailType
object
Details of single room type
4 properties
ratePlanPackages
object
Request object to attach package codes and package groups to a rate plan.
4 properties
promotionGroupsCopy
object
3 properties
ratePlanType
object
The Rate plan code Details.
53 properties
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
propertyPromotionCodes
object
3 properties
blockRatePlans
object
Response object to fetch rate plans summary information for blocks.
3 properties
packageCodeType
object
13 properties
hotelRatePlanSchedulesType
object
3 properties
ratePlanScheduleInfoType
object
This type contains summary details about the rate plan schedules such as Schedulesefined etc.
1 property
packageCodeShortInfoType
object
8 properties
adjustmentCategoryType
string
Simple type for Yield Adjustment types.
hotelPackageForecastGroupsToCreate
object
Request object for creating new package forecast groups for a hotel.
3 properties
packageChildBuckets
string
Simple type for package child buckets.
ratePlanNoteType
object
Details of the Rate Plan Approval Note
7 properties
hotelPackageGroupsType
object
2 properties
ratePlanTransactionDetailsType
object
9 properties
massRateChangeStatusType
object
Mass Rate Update Status details.
5 properties
codeType
string
Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
ratePlansSchedulesToManage
object
Request object to create/change/delete rate plans schedules.
3 properties
packageGroupsInfo
object
Response object to fetch package groups.
4 properties
yieldMarketCodeListType
array
Yield Market Code for the rate plan code.
hotelPackageForecastGroupsType
array
Hotel package forecast group details.
codeInfoType
object
4 properties
trxCodesInfoType
array
List of Transaction codes info.
generatePromotionCouponCodes
object
Request object to generate the promotion coupon code.
1 property
blockRatePlanType
object
The block rate plan code information.
10 properties
ratePlanBasedOnRateType
object
Base Rate type such as "Base Rate", "Dynamic Base Rate"
5 properties
translationsTextType
array
Language code for the translation.
rateByAgeBucketType
object
Rate amount by age bucket.
4 properties
configPackagePrimaryDetailsType
object
A Config Package Info type.
10 properties
packagesInfo
object
Response object to fetch list of packages.
4 properties
exchangePostingType
string
Fixed at Block.
propertyPromotionRateCodesType
array
List of Promotion Rate Code
massRateChangeDetailLogListType
array
Mass rate update details.
ratePlanSchedules
object
Request object to change rate plan schedules.
5 properties
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
promotionGroups
object
3 properties
ratePlansSync
object
Request object to synchronize rate codes.
2 properties
2 required
packageGroup
object
3 properties
generatePackageCodeDescriptionResponse
object
Response object containing the generated text.
4 properties
couponGenerateOptionType
string
Coupon Generation Options.
negotiatedRates
object
Response object for fetching negotiated rates and profile discounts.
9 properties
strategyRestrictionType
object
The Rate strategy restriction details.
9 properties
templatePromotionCodesType
array
A template promotion.
restrictionGroupType
string
Casino restriction group assigned to this rate plan. Allowed values: A or B. Required when casinoComp is true.
ratePlansSummary
object
Response object to fetch rate plans summary information.
4 properties
massRateChangeStatus
object
A response message to fetch the status of mass rate update operation.
3 properties
yieldAdjustmentsType
object
The Yield adjustments defined in the system based on the request.
5 properties
copyPromotionGroupsCriteriaType
object
Copy Promotion Groups criteria type to copy multiple Promotion Groups from one Hotel to another Hotel.
1 property
dateRangeType
object
Date Range with Start and End dates.
2 properties
profileNameType
object
This provides name information for a person.
8 properties
occupantThresholdPricingType
object
Definition for creating pricing for a rate schedule, based on occupants threshold level.
3 properties
baseRatePlanScheduleDetailType
object
11 properties
templatePackageForecastGroups
object
Response object for fetching template package forecast groups.
3 properties
propertyPromotionCode
object
3 properties
hotelPackageForecastGroupsToChange
object
Request object for modifying package forecast groups for a hotel.
3 properties
negotiatedRatesDetails
object
Response Body.
2 properties
negotiatedRateType
object
Negotiated rate details
3 properties
promotionGroupsType
array
A promotion group.
functionArgumentsType
array
Collection of function arguments and their corresponding values.
ratePackageCodeListType
array
Rate Package Full Information
ratePlanDepositType
object
1 property
ratePlanCommissionType
object
3 properties
ratePlanScheduleListType
object
9 properties
profileTypeType
string
The types of Profile handled by the web service.
ratePlanPostingRhythmType
object
Rate Plan Posting rhythm type.
1 property
propertyPromotionRateCodeType
object
5 properties
rateStrategiesType
object
The Rate strategy type.
2 properties
inactivatePromotionCouponBatchCodeType
object
Promotion coupon batch code details to be inactivated.
2 properties
1 required
getPromotionCouponCode
object
Response object to get the promotion coupon code based on the resort and promotion code.
3 properties
roomTypes
List of room types.
templatePackageForecastGroupType
object
Base details common between hotel and template package forecast groups.
5 properties
rateTierType
object
Details for a single rate tier.
3 properties
billingInstructionsType
array
Set of Billing Instruction codes.
operaVersion
object
Response for Ping operation.
3 properties
hotelCodeListType
array
Hotel code.
links
array
ratePlanDescriptionsType
object
Info URL, Short and Long Info details of the rate plan.
4 properties
tierIDType
integer
ratePackagesType
object
2 properties
ratePlanRoomTransactionCodeType
object
Transaction code associated to a room type or room class on a rate plan.
3 properties
promotionGroupType
object
Details of a Promotion Group
9 properties
rateAccessExclusions
object
3 properties
scheduleAdjustmentDetailsType
array
The list of adjustment codes for the rate plan schedule.
rateCodeLockStatusType
string
Indicates that the rate code is locked by the central system and cannot be edited at the property level.
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
#Rate Plan
Where this information came from
This is an independent, third-party profile of Oracle Hospitality Rate Plan 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.