Oracle Hospitality Profile Membership API
This will allow you to create a guest profile enrollment in OPERA Cloud. Enrollment relates to a membership program, so as an example you can enrol the guest Mr Tom Smith into a Membership / loyalty program.
Oracle Hospitality Profile Membership 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 ProfileMembership. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 45 operations across 38 paths, and defines 347 schemas. It is described by OpenAPI 3.2.0, at version 26.2.0.0.
Requests are made against a single base URL, /crm/v1.
45 operations
38 paths
347 schemas
2 DELETE30 GET7 POST6 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 45
Across 38 paths, the API surfaces 45 operations — 2 DELETE, 30 GET, 7 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.
ProfileMembership 45
This will allow you to create a guest profile enrollment in OPERA Cloud. Enrollment relates to a membership program, so as an example you can enrol the guest Mr Tom Smith into a M…
POST
/externalSystems/{extSystemCode}/chains/{chainCode}/enrollments
Create an Enrollment
PUT
/externalSystems/{extSystemCode}/profiles/{externalProfileId}/profileAwards
Redeem an award
GET
/externalSystems/{extSystemCode}/profiles/{externalProfileId}/memberships
Get membership information on a profile
GET
/airline/transactionsdeprecated
Get airline transactions status
GET
/availableAwardsBasedOnType
Get Available Awards
DELETE
/awards
Delete Awards
GET
/awardsToGrant
Get Awards to Grant
POST
/enrollments
Create an Enrollment
GET
/hotels/{hotelId}/memberships/{membershipId}deprecated
Get Membership Issued awards points
POST
/issueOtherAwards
Issue an OTHER type award
GET
/memberHistory
Get primary membership history details of a guest.
GET
/membershipClaims
Get membership claims
POST
/membershipClaims
Create membership Claim
GET
/membershipClaims/{claimId}
Get membership claim
PUT
/membershipClaims/{claimId}
Change membership Claim
POST
/membershipPoints/calculations
Calculate Membership Points
GET
/membershipPointsExceptions
Get membership points exception details
PUT
/membershipPointsExceptions
Update membership points exceptions
GET
/membershipReservationActivity
Get Membership Reservation Activity
GET
/membershipTransactions/{membershipTransactionId}
Get a membership transaction
GET
/membershipTransactions/{membershipTransactionId}/awardPoints
Fetch the Award Points Accrued for the current points transaction.
GET
/membershipTransactions/{membershipTransactionId}/pointRejectionReasons
Fetch the reason points were not awarded for a given points transaction.
GET
/membershipTransactions/{membershipTransactionId}/rates
Fetch the rate details associated to current points transaction.
GET
/membershipTransactions/{membershipTransactionId}/revenue
Fetch the revenue details for the stay associated with current point transaction.
GET
/membershipTransactions/{membershipTransactionId}/tierPoints
Fetch the Tier Points Accrued for the current points transaction
GET
/memberships/{membershipId}/award
Export Membership Award
GET
/memberships/{membershipId}/awardExports
Get Membership Award Export Information
GET
/memberships/{membershipId}/awards
Get Membership Award list
GET
/memberships/{membershipId}/claims
Get membership claims
GET
/memberships/{membershipId}/pointsToExpire
Get membership points to expire
PUT
/memberships/{membershipId}/pointsToExpire
Extend Member Points set to Expire
GET
/memberships/{membershipId}/promotions
Fetch membership promotions of a guest
POST
/memberships/{membershipId}/promotions
Create membership promotion of a guest
PUT
/memberships/{membershipId}/promotions/{promotionCode}
Change membership promotion of a guest
DELETE
/memberships/{membershipId}/promotions/{promotionCode}
Delete membership promotion of a guest
GET
/memberships/{membershipId}/transactions
Get membership transactions
POST
/memberships/{membershipId}/transactions
Post a membership transaction
GET
/membershipsCard/{membershipCardNo}/membershipType/{membershipCardType}/pointsToExpire
Get membership points to expire
GET
/membershipsCard/{membershipCardNo}/membershipType/{membershipCardType}/transactions
Get membership transactions
GET
/profileForEnrollment
Get Profiles for Enrollment
PUT
/profiles/{profileId}/awards/redeem
Redeem an award
GET
/profiles/{profileId}/membershipTransactionExceptionsdeprecated
Get membership transaction exception details
GET
/profiles/{profileId}/memberships/history
Get membership card history information on a profile
GET
/profiles/{profileId}/memberships/info
Get membership information on a profile
GET
/services/profileMembership/status
Operation to check status of ProfileMembership service
Schemas 347
The contract defines 347 schemas that model the data the API accepts and returns. The most detailed are profileEnrollmentType_2 (72 properties), reservationInfoType (51 properties), profileMembershipType_2 (43 properties), profileMembershipType (39 properties). Each schema is shown below with its type and property counts.
codeDescriptionType
object
This contains a generic code and description information.
2 properties
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
memberAwardDetailsType
array
Details related to member award per stay date.
identificationType
object
Identification information of the customer.
10 properties
cardReIssueType
string
Request to re issue a new card.
memberAwardType
object
16 properties
keywordDetailType
object
1 property
tierAdministrationType
string
Do not upgrade membership. The membership may be downgraded.
benefitsType
array
Basic information about membership benefit.
countryNameType
object
Code for a country or a nationality.
2 properties
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
memberInfoDetailsType
object
14 properties
emailInfoType
object
Information on an email for the customer.
3 properties
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
profileEnrollmentType
object
Type provides the detailed information about the profile and its children.
22 properties
personNameType
object
This provides name information for a person.
11 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
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.
identificationInfoType
object
Information on the identification of the customer.
3 properties
personNameTypeType
string
Person's name in an external system.
memberInfoRSType
object
4 properties
reservationIdList
array
Unique Id that references an object uniquely in the system.
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.
memberInformation
object
Response object for member info.
3 properties
benefitType
object
Basic information about membership benefit.
3 properties
enrollment
object
Response object for fetching profile enrollment from external system.
2 properties
award
object
Request object to redeem award.
2 properties
memberAwardProcessType
string
Processing type of the award like Actual , Projected or Inactive.
profileMembershipType
object
Detailed information of the memberships.
39 properties
profileTypeType
string
The types of Profile handled by the web service.
timeSpanType
object
Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, whild Duration provides a measure of time to…
3 properties
uRLInfoType
object
Web site address.
2 properties
anonymizationStatusType
string
Guest has been anonymized.
profileIdList
array
Unique Id that references an object uniquely in the system.
profileStatusType
string
addressInfoType
object
Provides address information.
3 properties
keywordType
object
3 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
formattedTextTextType
object
Provides text and indicates whether it is formatted or not.
2 properties
emailType
object
Information on an email for the customer.
10 properties
addressType
object
Provides address information.
17 properties
links
array
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
telephoneType
object
Information on a telephone number for the customer.
11 properties
alienInfoType
object
immigration/visa information of a foreign person.
3 properties
paragraphType
object
An indication of a new paragraph for a sub-section of a formatted text message.
1 property
anonymizationType
object
Provides information about guest's anonymization status.
2 properties
customerType
object
Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
21 properties
memberAwardDetailType
object
Details related to member award like award type, stay date, rate code, etc.
23 properties
reservationQueueInformationType
object
Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
6 properties
resAccompanyGuestInfoType
object
5 properties
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…
36 properties
memberAwardType_2
object
17 properties
airlineImportStatusType
string
List of possible import statuses of a membership airline processing record.
membershipAwardsAvailabilityType
array
List of available awards information.
salesInfoType
object
Provides sales information about the profiles of type company, travel agent, source and contact.
13 properties
membershipTransactionsSummaryCollection
object
Response object for fetching multiple memberships transactions summaries.
3 properties
airlineTransactionStatusType
object
Contains details of the membership transaction processing status, provided by the airline.
2 properties
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
rateAvailabilityType
object
Member Award availability details based on chosen award types as Product,Rate,Upgrade,FT Payment and Other.
16 properties
profileSubscriptionListType
array
Details of the OPERA Profile subscription to external system
negotiatedType
object
This holds a list of NegotiatedInfoType.
3 properties
airlineTransactionType
object
Contains details of the membership transaction processing status, provided by the airline.
10 properties
availableAwardsBasedOnType
object
Response object to fetch member available awards based on the type being passed.
3 properties
characterUDFsType
array
Used to hold collection of user defined fields of Character/String Type.
timeSpanType_2
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
indicatorType
object
Lamp indicator Type.
2 properties
membershipDetailsType
object
Details of membership transactions summary such as the membership details, transactions summary, points summary, etc.
10 properties
imageStyleType
string
An enumeration of image styles.
addressInfoType_2
object
Provides address information.
3 properties
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
eCertificateInfoType
object
E-Certificates details.
14 properties
rewardsInfoType
object
Indicates membership base information like CurrentBalance,association and Owned card.
9 properties
customerType_2
object
Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
26 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
membershipTransactionType
object
Detailed transaction information related to a membership.
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…
claimActivityLogListType
array
Summary of claim activity log information.
profileSubscriptionType
object
Contains details of the profile subscription. The subscription represents the link between the OPERA profile and the external profile within a particular exter…
12 properties
profileDeliveryModuleType
string
Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..
hotelInterfaceType
object
8 properties
rates
object
Response object for fetching Membership Transaction Rates information.
3 properties
cardProcessingType
string
reservationHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
memberAwardActionType
string
Specify whether award is to issue, cancel or update.
membershipTransactionExceptions
object
Response object for fetching membership transaction exceptions.
3 properties
memberPointsExceptions
object
Response object for fetching membership points exceptions.
9 properties
housekeepingTaskCodeType
object
Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.
7 properties
resAccompanyGuestListType
array
Collection of accompany guests
resSharedGuestListType
array
Collection of shared guest reservations.
facilityTaskType
object
Information regarding facility task on a reservation.
3 properties
membershipHistoryType
object
Contains details of the profile's primary membership history.
6 properties
surnameType
string
Family name, last name.
ownerType
object
Generic type for information about an owner.
11 properties
exceptionDetailType_2
object
Complex type that contains error details for a REST call.
9 properties
2 required
membershipTransactionExceptionsType
array
Contains Membership transaction exception information.
searchMatchType
object
Search match indicating attribute and the matching value.
2 properties
enrollmentMatchProfilesType
array
Provide match profile details for enrollment.
profileDeliveryMethod
object
Delivery Information type to the profile.
7 properties
membershipTransactionExceptionComputePointsType
object
Options to compute award and tier points for membership transaction exception.
8 properties
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
commissionPaymentMethods
string
Check
membershipPointsExceptions
object
Response object for fetching membership points exceptions.
3 properties
operaVersionNumberType
string
Current Opera Version Number
addressType_2
object
Provides address information.
18 properties
hotelStayType
object
Type provides the hotel stay information.
4 properties
membershipPointsToCalculate
object
Request to run membership points calculation job.
3 properties
membershipTransaction
object
Response object for fetching a membership transaction.
3 properties
pointsRejectionReasonType
object
Information related to a Points Rejection Reason summary.
3 properties
stayFutureListType
object
A collection of reservation history details attached to Profiles.
4 properties
errorInstance_2
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
userDefinedFieldsType
object
A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc.
3 properties
relationshipAddressType
object
Provides address information for a Relationship.
5 properties
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
dateRangeType
object
Date Range with Start and End dates.
2 properties
membershipPromotionType
object
Information related to a membership promotion.
7 properties
airlineTransactionsStatus
object
Request object for fetching membership transactions processed by the airline.
9 properties
aRAccountStatusType
object
Type for the Account Status. Status can be restricted and a message/description added to the Account.
3 properties
hotelStaysType
array
Detailed information of the hotel stay.
billingPrivilegesType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
13 properties
reservationTaxTypeInfo
object
Provides information about the Tax Type.
9 properties
membershipTransactionRatesType
object
Summary of rate details of current transaction associated with the stay.
7 properties
privacyInfoType
object
Defines Privacy related information for the profile.
15 properties
formattedTextTextType_2
object
Provides text and indicates whether it is formatted or not.
2 properties
operaVersion
object
Response for Ping operation.
3 properties
profileCashieringType
object
Contains cashiering related details for the profile
14 properties
otherAwardsIssueCriteria
object
Request object to issue an OTHER type award to a member's profile.
3 properties
relationshipInfoType
object
Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.
8 properties
membershipTransactionRateType
object
Information related to a membership transaction rate.
7 properties
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 properties
turndownStatusType
string
Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Complet…
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
webUserHistoryType
object
Creation date time, Creator Id, last modification date time and last Modifier Id.
7 properties
negotiatedInfoType
object
This provides information for a profile negotiated rate.
6 properties
reservationInfoType
object
The Reservation class contains the current reservation being created or altered.
51 properties
calculatedPointType
object
Information related to a Calculated Points.
6 properties
calculatedPoints
object
Response object for fetching membership transaction points information.
3 properties
eCertificateType
object
E-Certificates details.
23 properties
resCashieringType
object
Cashiering Information for the reservation.
14 properties
reservationDepositType
object
Reservation Deposit Type.
7 properties
profileMembershipType_2
object
Detailed information of the memberships.
43 properties
reservationPaymentMethodType
object
7 properties
membershipAwardListType
object
Information related to Member Award Issue List.
38 properties
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
telephoneInfoType_2
object
Information on a telephone number for the customer.
3 properties
membershipPointsExceptionsType
object
Contains Membership points exception information.
3 properties
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 properties
enrollmentTypeType
string
The type of external system that the guest is enrolling in, such as Loyalty, Gaming or Activities.
identificationInfoType_2
object
Information on the identification of the customer.
3 properties
status
object
Response Body.
2 properties
profileRestrictions
object
3 properties
promotionType
object
Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.
3 properties
pointsRejectionReasons
object
Response object for fetching member transactions points rejection reasons information.
3 properties
claimRecordType
string
Record Type associated with a claim.
memberPointsToExpireCollectionType
object
Membership points to expire with the membership details to differentiate.
2 properties
membershipTransactionsSummary
object
Response object for fetching member point totals information.
6 properties
relationshipInfoSummaryType
object
RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact p…
7 properties
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
resAttachedProfileListType
array
eCertificateConsumptionType
object
E-Certificates details.
13 properties
membershipAwardPointByHotelType
object
Award points information group by Hotel.
2 properties
resGuestExternalInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
2 properties
relationshipProfileSummaryType
object
11 properties
givenNameType
string
Given name, first name or names
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
3 properties
companyInfoType
object
Company Information of the Profile.
3 properties
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
9 properties
imageSetType
object
Represents on image set record.
11 properties
rulePointsTypeType
string
Possible membership points types.
facilityCodeType
object
Facility Housekeeping Code, its description and quantity.
3 properties
eCertificateUsageCriteriaType
object
E-Certificates details.
8 properties
alienInfoType_2
object
immigration/visa information of a foreign person.
3 properties
membershipAwardsListType
array
List of Member Awards information.
claimMembershipType
object
Summary of claim activity log information.
9 properties
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
5 properties
membershipTransactionExceptionType
object
Details about a membership like ProfileID, Card Number, Type, Level, etc.
28 properties
eCertificateIssueSourceType
string
Indicates that OPERA E-Certificate is issued by external system.
interfaceRightsStatusType
object
4 properties
profileNameType
object
This provides name information for a person.
8 properties
stayReservationInfoType
object
The Reservation class contains the current reservation being created or altered.
7 properties
mailingActionsType
object
Defines mailing action list for the profile.
4 properties
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
30 properties
reservationFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
4 properties
enrollmentPaymentDetailsType
object
Payment details to enrolll profile to the membership program.
5 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,…
4 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,…
6 properties
membershipOtherAwardInfoType
object
Information about the OTHER type Award and profile membership. OTHER type awards can be redeemed based on the points available with a particular member.
4 properties
membershipPromotionDetails
object
The request element used to create a membership promotion.
3 properties
reservationInterfaceStatusType
object
Hotel Interface Type for a reservation and status of the various services
3 properties
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
commissionPayoutToType
string
membershipTransactionRevenuesType
object
Summary of stay details for current transaction.
7 properties
upgradeAvailabilityType
object
Member Award availability details based on chosen award types as Product,Rate,Upgrade,FT Payment and Other.
17 properties
membershipAwardPointsType
object
Details associated with award points.
6 properties
lastStayInfoType
object
Contains last stay related details for the profile
4 properties
membershipAwardExportInfo
object
Response object to fetch members information for Fulfillment house processing.
3 properties
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
profileSharedLevelType
string
Simple types for Shared level.
membershipTransactionRevenueType
object
Information related to a membership transactions Revenue.
7 properties
reservationFolioWindowsType
array
Collection of reservation folio windows.
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
commentInfoType
object
Comment related to the profile/reservation.
7 properties
membershipClaims
object
Response object for fetching membership claims.
9 properties
pointsRejectionReasonsType
object
Summary of reason points were not awarded for a given points transaction.
7 properties
directBillingType
object
This is the preconfigured routing instruction type.
2 properties
eCertificateStatusType
string
Indicates that OPERA E-Certificate is reserved.
mailingPreferencesType
object
Indicates guest's mailing preferences.
2 properties
airlineTransactionImportInfoType
object
Contains details of the membership transaction processing status, provided by the airline.
3 properties
eCertificateScopeType
string
Indicates that OPERA E-Certificate is available for a specific list of hotels.
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
gdsNegotiatedInfoType
object
This provides information for a channel negotiated rate.
5 properties
eCertificateGenerationType
object
E-Certificates details.
3 properties
eCertificatesType
array
List of e-certificates for the profile.
profileTaxInfoType
object
Profile information related to tax.
7 properties
aRAccountShortInfoType
object
Accounts Receivabales Account details type charged for batched posting.
4 properties
claimAdjustmentPointsType
object
Summary of membership claim award points and tier points.
18 properties
extendMemberPointsToExpire
object
Request object to extend a member points to expire.
4 properties
reservationTurndownInfoType
object
Turndown information for a reservation
2 properties
memberTransactionRecentSummaryType
object
Itemized information related to a membership transactions summary.
4 properties
resProfileTypeType
string
codeListType
array
futureListType
object
A collection of reservation history details attached to Profiles.
4 properties
reservationStayHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
membershipClaimSummaryType
object
Summary information of a claim.
23 properties
commentType
object
An indication of a new paragraph for a sub-section of a formatted text message.
16 properties
enrollment_2
object
Response object for fetching profile enrollment from external system.
3 properties
claimActivityLogType
object
Summary of claim activity log information.
7 properties
membershipReservationDetailCodeType
string
Supported memebership reservation detail code type.
nameTypeType
string
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
payeeInfoType
object
Payee information.
7 properties
blockIdList
array
Unique Id that references an object uniquely in the system.
otherAwardAvailabilityType
object
Information related to the Other type Award.
4 properties
issueAwardInfoType
object
Information about issue award.
6 properties
awardsToGrant
object
Response object to fetch award details to grant an award.
3 properties
membershipReservationDetailUnitType
object
The filetered membership reservation information.
2 properties
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
historyListType
object
A collection of reservation history details attached to Profiles.
4 properties
webUserAccountsType
array
Web User Accounts List.
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
memberPointsToExpireCollection
object
Response object for fetching member points to expire information.
3 properties
emailInfoType_2
object
Information on an email for the customer.
3 properties
memberPointsToExpireListType
array
List of of member points to expire.
memberInfoType
object
Contains details of the membership transaction processing status, provided by the airline.
4 properties
facilityCodesType
array
List of the facility codes.
membershipCardHistoryType
object
Contains details of the card history of a member.
2 properties
memberHistoryList
object
Response object for member history.
9 properties
claimSourceType
string
Source of the membership claim.
dateUDFsType
array
Used to hold collection of user defined fields of Date Type.
resCompAccountingType
object
Information regarding comp accounting on the reservation.
3 properties
dateUDFType
object
Used to hold user defined field of Date Type.
3 properties
uRLInfoType_2
object
Web site address.
3 properties
awardId
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
membershipTransactionTierPointsType
object
Details associated with tier points.
6 properties
membershipPointsCalculationProcessType
string
Issuing awards for guests belonging to a membership type, with a specific award code that is of Other type.
resAttachedProfileType
object
3 properties
taxTypeType
object
Provides information about the Tax Type.
8 properties
memberAwardDetailType_2
object
Details related to member award like award type, stay date, rate code, etc.
28 properties
memberPointsExceptionType
object
Details about a membership like ProfileID, Card Number, Type, Level, etc.
20 properties
membershipPromotionsDetails
object
Response object for fetching membership promotions information.
3 properties
membershipAwardRecipientInfoType
object
Type holds details of member.
4 properties
eCertificateIssueType
string
Indicates that guest purchased OPERA E-Certificate.
webUserAccountType
object
Web User Account of the guest.
11 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.
membershipAwardExportType
object
Types holds the details of Member.
3 properties
otherAvailabilityType
object
Information related to Other Award.
9 properties
membershipTransactionDetailsType
object
Detailed information related to a membership transaction.
31 properties
memberPointsToExpire
object
Response object for fetching member points to expire information.
9 properties
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
membershipIssueAwards
object
Response object for fetching member issued award list.
9 properties
revenues
object
Response object for fetching Membership Transaction Revenue.
3 properties
membershipTransactionId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
claimReservationInfoType
object
Summary of claim activity log information.
4 properties
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 properties
memberTransactionSummaryTierPointsType
object
Items summary associated with Tier points.
8 properties
numericUDFType
object
Used to hold user defined field of Numeric Type. It is highly recommended to use UDFN01, UDFN02,...UDFN40 (Total 40) as Numeric UDF names(commonly used on Rese…
3 properties
namePrefixType
string
Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.). Currently this attribute is not used for PUT and POST operations.
issueAwardsInfoType
array
List of awards info.
personNameType_2
object
This provides name information for a person.
13 properties
issuedAward
object
Response object for issue awards.
3 properties
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
resPaymentCardType
object
Information on a credit card for the customer.
19 properties
memberTransactionSummaryAwardPointsType
object
Items summary associated with award points.
4 properties
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
7 properties
indicatorsType
array
Collection of lamp indicators.
membershipAwardBasedOnType
string
This award allows a guest to apply available membership points towards the balance of his or her bill.
roomOwnershipType
object
Define the search criteria for retrieving room ownership records
9 properties
uniqueID_Type_2
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
telephoneType_2
object
Information on a telephone number for the customer.
12 properties
membershipAwardPointsByHotelType
array
List of available award points information by Hotel.
memberTransactionSummaryGuestStaysType
object
Items summary associated with guest stays.
2 properties
earningPreferencesType
object
Indicates guest's rewards earning preferences.
3 properties
calculatedPointsType
object
Summary of Points Accrued for current transaction.
7 properties
membershipAwardsExportType
array
List of member's information.
preferenceType
object
Guest Preference details for the profile.
8 properties
airlineTransactionsType
array
Contains details of the membership transaction processing status, provided by the airline.
customizedPrivacyCodesType
object
Customized privacy codes and values
2 properties
resCommunicationType
object
Communication details for a reservation.
2 properties
membershipExceptionStatusType
string
List of possible membership exception type.
basicEmailType
string
Email address
membershipClaimDetailsType
object
Detailed information of a claim.
20 properties
profileCommissionType
object
This is the preconfigured routing instruction type.
7 properties
identificationType_2
object
Identification information of the customer.
10 properties
roomPreferencesType
object
Indicates the guest's room preferences.
11 properties
relationshipProfileType
object
13 properties
membershipReservationDetails
object
Response element for membership reservation activity updated.
4 properties
membershipClaim
object
Request object for creating membership claim.
3 properties
memberPointToExpireType
object
Information related to a member point to expire.
6 properties
masterAccountInfoType
object
2 properties
profileEnrollmentType_2
object
Type provides the detailed information about the profile and its children.
72 properties
numericUDFsType
array
Used to hold collection of user defined fields of Numeric Type.
membershipAwardPointsByHotel
object
Response object for fetching member award points by Hotel.
3 properties
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
memberPointsSummaryType
object
Member Points Summary.
2 properties
memberTransactionSummaryType
object
Itemized information related to a membership transactions summary.
3 properties
phoneNumberType
string
Phone number
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
eCertificateConsumeSourceType
string
Indicates that OPERA E-Certificate is consumed by hotelPMS.
iATAInfoType
object
IATA Information of the profile.
3 properties
preferenceTypeType
object
Preference details for the profile.
12 properties
emailType_2
object
Information on an email for the customer.
11 properties
transactionSummaryAttributeType
object
Attributes of Summary transactions.
2 properties
uRLType
object
Web site address, in IETF(The Internet Engineering Task Force) specified format.
5 properties
claimApprovalStatusType
string
Claim approve or reject status.
companyType
object
21 properties
changeRelationsType
object
Detailed information regarding the changes made to relationships for the profile.
5 properties
stayHistoryListType
object
A collection of reservation history details attached to Profiles.
4 properties
productAvailabilityType
object
Member Award availability details based on chosen award types as Product,Rate,Upgrade,FT Payment and Other.
14 properties
reservationAllowedActionsType
array
Allowed action.
membershipPointsCalculationType
object
Details needed for calculating membership points.
4 properties
vIPType
object
The supplier's ranking of the customer.
2 properties
searchMatchesType
array
List of Generic Name-Value-Pair Parameters used for super search matches.
membershipClaimSummaryListType
array
Contains summary information of the claim.
membershipTransactionsSummaryType
object
Details of membership transaction like Details, Summary, point, etc.
4 properties
membershipAwardAvailabilityType
object
Details of Member Award Type. Awards will be available for redemption of award points associated with a particular member.
4 properties
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
3 properties
enrollmentMatchProfiles
object
Response object to fetch match profiles for enrollment.
3 properties
award_2
object
Request object to redeem award.
3 properties
memberCardHistoryList
object
Response object for member card history.
9 properties
reservationBlockType
object
Key information about the block for a reservation.
3 properties
characterUDFType
object
Used to hold user defined field of Character/String Type.
3 properties
gdsNegotiatedType
object
This holds a list of GdsNegotiatedInfoType.
4 properties
profileAccessType
object
4 properties
paragraphType_2
object
An indication of a new paragraph for a sub-section of a formatted text message.
2 properties
hotelInterfaceTypeType
string
XML Posting Interface
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
#ProfileMembership
Where this information came from
This is an independent, third-party profile of Oracle Hospitality Profile Membership 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.