The identity and technical contract details declared by the specification.
OfferDetailsResponse
object
OfferDetailsRoomStay
object
Room stay information with all details per room per rate
5 properties
Offer
object
11 properties
BlockInformation
object
Block related information
3 properties
OfferRateInformation
object
Details on the rate plan of the offer.
6 properties
OfferGuaranteePolicy
object
Policy for guaranteeing reservation.
7 properties
OfferPaymentCodeDescriptionType
object
Payment type entity which contains a code and description
3 properties
GuaranteePolicyRequirements
object
Additional requirement for the payment policy.
4 properties
OfferDepositPolicy
object
Deposit Policy Details
5 properties
OfferPolicyRevenueType
string
The revenue type the policy is associated to.
OfferDepositPolicyPaymentCodeDescriptionType
object
2 properties
OfferDepositPolicyType
object
The deposit rule associated to the deposit policy.
6 properties
OfferDepositPolicyDeadlineType
object
The deadline associated to the deposit rule.
DepositOffsetDropTime
string
Defines as to when the deposit rule will take effect, works together with offsetTimeUnit and offsetMultiplier. BeforeArrival - The rule will take effect before…
PolicyOffsetType
object
Deposit deadline, relative.
2 properties
OffsetTimeUnit
string
Time unit used to define the rule.
PolicyBasisType
string
The basis type used to compute the amount due. Nights -The amount is based by the number of nights specified Percentage - The amount is based on a percentage o…
OfferRateRange
object
Rate range information
OfferRateTimeUnit
string
Time unit used to define the rate of the rate plan.
OfferTotalType
object
The daily rate of the offer.
3 properties
CurrencyCodeType
string
The code used for the local currency of the property. ISO 4217 currency code
OfferDateRange
object
Date range information
2 properties
GuaranteeRequirementType
string
The guarantee requirement for the rate plan. GuaranteeRequired - Required guarantee such as credit card, IATA number, etc. Deposit - Deposit is required None -…
OfferOverallRateInformation
object
Rate plan information of the offer.
4 properties
OfferRateMode
string
Type of rate returned, useful on a request for multiple nights stay where multiple rates may apply during the stay. Highest - The highest rate for the stay wil…
OfferAdditionalGuestAmountType
object
OfferAgeQualifyingCodeEnum
string
Indicates if the rate is for each additional adult or child.
OfferCancelPenalty
object
Cancellation Policy Details
2 properties
OfferCancellationPolicyType
object
The cancellation rule associated to the cancellation policy.
4 properties
4 required
CancelPolicyAmountPercentType
object
The method used to compute the penalty associated to the cancellation rule.
BasicAmountPercentType
object
4 properties
CancelPolicyDeadlineType
object
The deadline associated to the cancellation rule.
3 properties
OfferTotalTypeWithTaxes
object
Information on the total cost for the entire stay, including taxes.
4 properties
OfferTaxesType
object
A collection of taxes.
6 properties
OfferTaxType
object
Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should…
5 properties
OfferAvailabilityStatus
string
Indicates the availability status of the offer. AvailableForSale - Offer is available for sale NoAvailability - Offer is not available for sale
OfferPackage
object
Package code details applied to an offer rate plan.
12 properties
PackageGroupType
object
2 properties
PostingRhythmType
string
The posting frequency of the package element or package group associated to the rate plan. EveryNight - Package charge posted every night of the stay ArrivalNi…
PackageInventoryItemType
object
2 properties
deepLink
object
Represents an book url.
1 property
OfferDetailsPropertyInfo
object
Property information
PropertyOffersPropertyInfo
object
Property information
Address
object
Address Details such as city, state, country, postal code etc.
5 properties
PropertySearchPropertyInfo
object
Property information
4 properties
OfferPointOfInterest
object
The point of interest for guests to get to the hotel.
10 properties
PropertyOffersHotelAmenity
object
5 properties
AlternatePropertyDistance
object
4 properties
CompassDirection
string
Relative direction from the property to the alternate property. North, West, South, East N: North, W: West, S: South, E: East, NW: North West, NE: North East,…
DistanceUnit
string
Distance measurement unit for the distance from the property to the alternate property.
Transportation
object
4 properties
Direction
object
Details on directions from and to the property.
1 property
Location
object
Details on the location of the property.
1 property
GeneralInformation
object
General information about the property.
2 properties
Communications
object
The contact information for the property.
3 properties
Email
object
2 properties
Phone
object
3 properties
OfferDetailsRoomType
object
Details of the room type selected during the request including room type information, availability status of the room type, and room amenities.
PropertyOffersRoomType
object
Room Type information
16 properties
PropertyOffersRoomAmenity
object
6 properties
OfferRoomAmenityAvailabilityStatus
string
Indicates the availability status of the room amenity. AvailableForSale - Room amenity is available for sale NoAvailability - Room amenity is not available for…
OfferRoomTypeAvailabilityStatus
string
Indicates the availability status of the room type. AvailableForSale - Room type is available for sale NoAvailability - Room type is not available for sale Not…
Occupancy
object
Details on the occupancy of the room type.
4 properties
OfferDetailsRatePlan
object
Details of the rate plan selected during the request including rate plan information, availability status of the rate plan, and commission.
PropertyOffersRatePlan
object
PromotionCodeItem
object
1 property
OfferRatePlanCommission
object
Information on commission rate associated to the rate plan.
1 property
OfferMealPlan
object
Details on meal plans included with the rate plan.
4 properties
OfferRatePlanMealType
string
OfferRatePlanMealPlanType
string
Type of meal plan the rate plan includes - DEPRECATED AND WILL BE REMOVED IN FUTURE VERSIONS
RatePackage
object
Package code details applied to a rate plan.
11 properties
PropertySearchRatePlan
object
11 properties
AdditionalDetails
object
Additional information related to the rate plan.
2 properties
AccountType
string
Rate Plan account type
OfferRatePlanAvailabilityStatus
string
Availability status of the rate plan. AvailableForSale - Rate plan is available for sale NoAvailability - Rate plan is not available for sale NotFound - Rate p…
Restriction
object
Holds restriction information that is restricting offer from being available
2 properties
Description
object
Multi line description of the rate plan.
4 properties
HotelAvailabilityStatus
string
Availability status of the property. AvailableForSale - Property has availability based on criteria requested NoAvailability - Property has no availability bas…
PropertySearchResponse
object
Property Search Response
1 property
PropertySearchRoomStay
object
5 properties
OfferMinMaxTotalType
object
ExceptionDetail
object
Common Error Response format
7 properties
PropertyOffersResponse
object
1 property
PropertyOffersRoomStay
object
6 properties
PropertyAlternateOffersResponse
object
1 property
PropertyAlternateOffersRoomStay
object
3 properties
OfferAlternateOffersItem
object
8 properties
OfferTotalTaxSurchargeType
object
The daily rate of the offer including total tax and total fees (surcharges).
PropertyAlternateOffersPropertyInfo
object
Property information
3 properties
PropertyPackageAddonsResponse
object
Package Addons Response
1 property
PropertyPackage
object
14 properties
PropertyPackageInventoryItem
object
3 properties
CalculationRuleType
string
Simple type for package calculation rules.
PackageTotalType
object
Information on the total cost for the entire stay, including taxes.
4 properties
PackageRatesType
object
Details on the package of the offer.
1 property
PackageAmountType
object
Base charge related to a package
1 property
PackageBaseType
object
The daily rate of the package.
3 properties
PropertyPackageGroup
object
5 properties
PropertyPackageListItem
object
2 properties
PropertyCalendarResponse
object
1 property
PropertyCalendarRoomStay
object
3 properties
OfferCalendarItem
object
8 properties
PropertyCalendarPropertyInfo
object
Property information
4 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oracle Hospitality publishes across the network.
