The identity and technical contract details declared by the specification.
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
cardReIssueType
string
Request to re issue a new card.
stayInfoType
object
Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaini…
46 properties
resAccompanyGuestInfoType
object
9 properties
resSharedGuestInfoType
object
Contains information regarding the share reservation.
5 properties
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
backToBackResSequenceType
object
Type object represents Back To Back Sequence Position and Total Count of Linked Back To Back Reservations ordered by consecutive Stay Dates.
2 properties
namePrefixType
string
Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
packageCodeHeaderType
object
3 properties
membershipEarningPreferenceType
string
The earning preference of a membership, it depends on the type of property. eg. when the property is a airline it should be Miles, other than Points.
reservationIdList
array
Unique Id that references an object uniquely in the system.
reservationPackageScheduleType
object
A HotelPackageSchedule type.
21 properties
resPaymentCardType
object
Information on a credit card for the customer.
19 properties
pkgInventoryItemType
object
4 properties
reservationPaymentMethodType
object
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
childBucketsType
object
Defines children counts with Age Qualifying Group(Child Bucket) classification.
5 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
packageCategoryReservationType
object
Information regarding each reservation being returned in the response
14 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,…
3 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
housekeepingRoomStatusType
string
Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOf…
tierAdministrationType
string
Do not upgrade membership. The membership may be downgraded.
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
configPostingAttributesType
object
A config Package posting attributes type.
14 properties
packagePostingRhythmType
object
Package Posting rhythm type.
5 properties
cardProcessingType
string
masterInfoType
object
2 properties
promotionType
object
Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation. Note: For putReservation wh…
3 properties
packageConsumptionType
object
Package Consumption Information. Includes information on quantity of the package used, allowance consumption etc.
4 properties
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
reservationMembershipType
object
Detailed information of the memberships.
43 properties
blockIdList
array
Unique Id that references an object uniquely in the system.
resAccompanyGuestListType
array
Collection of accompany guests
basicEmailType
string
Email address
resSharedGuestListType
array
Collection of shared guest reservations.
offshoreRateType
object
Defines Offshore rate information.
3 properties
benefitsType
array
Basic information about membership benefit.
reservationRoomOwnershipType
string
Indicates if the assigned reservation room is an Owner/Referral or Regular room.
downgradeType
string
Do not downgrade membership when the next downgrade process runs. When the downgrade process runs, the membership will be automatically set to Grace.
packageCategoryReservations
object
Response object to the Fetch Reservations by package request operation. Based on the criteria, reservation information is returned.
4 properties
productSourceType
string
Sources of Products
configPackageTransactionType
object
A HotelPackageTransaction type.
4 properties
postingRhythmType
string
Simple type for posting Rhythm types.
surnameType
string
Family name, last name.
roomOccupancyType
object
Room Occupancy information.
9 properties
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 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
packageCalculationRuleType
string
Simple type for package caluculation rules.
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
phoneNumberType
string
Phone number
givenNameType
string
Given name, first name or names
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
4 properties
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
emailType
object
Information on an email for the customer.
10 properties
postingIntervalFrequency
string
Specifies the frequency at which charges are posted for the rate plan on the reservation.
codeInfoType
object
3 properties
configPackagePrimaryDetailsType
object
A Config Package Info type.
7 properties
vIPType
object
The supplier's ranking of the customer.
2 properties
externalReferencesType
array
This type contains unique information of external reference.
countryNameType
object
Used for Character Strings, length 0 to 200 - It indicates country/nationality description.
4 properties
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
reservationPackageType
object
A ReservationPackageType class.
13 properties
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
pMS_ResStatusType
string
This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.
benefitType
object
Basic information about membership benefit.
3 properties
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
28 properties
reservationBlockType
object
Key information about the block for a reservation.
3 properties
profileId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
3 properties
reservationId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
4 properties
anonymizationStatusType
string
Guest has been anonymized.
profileIdList
array
Unique Id that references an object uniquely in the system.
childAgeType
object
Defines Child's Age.
1 property
postingIntervalType
object
Posting Interval details for the reservation including begin/end dates, amount and frequency for each posting interval cycle on the reservation. Only available…
6 properties
formattedTextTextType
object
Provides text and indicates whether it is formatted or not.
2 properties
externalReferenceType
object
This type contains unique information of external reference.
3 properties
paragraphType
object
An indication of a new paragraph for a sub-section of a formatted text message.
1 property
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 properties
anonymizationType
object
Provides information about guest's anonymization status.
1 property
childAgesType
array
Age of a child in years.
scheduledRoomMoveResponseType
object
Scheduled Room Move information.
3 properties
bookingTimeSpanType
object
The booking time span of the reservation, only applicable when time increments are being used.
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oracle Hospitality publishes across the network.
