OPERA Cloud Customer Relationship Management Outbound API
APIs to cater for Customer Relationship Management external (outbound) functionality with OPERA. These APIs facilitate various operations related to getting data from an external system, and inserting it into OPERA. Compatible with OPERA Cloud release 26.2.0.0. 12 operation(s) documented; base path /crm/v1. Harvested verbatim from Oracle's public hospitality-api-docs repository (Swagger 2.0, release 26.2.0.0).
OPERA Cloud Customer Relationship Management Outbound API is one of 135 APIs that Oracle Hospitality publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Profile, ProfileExternal, ProfileMembership, Property Management, and OPERA Cloud. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 12 operations across 12 paths, organized into 3 resource areas, and defines 328 schemas. It is described by OpenAPI 2.0, at version 26.2.0.0.
12 operations
12 paths
328 schemas
9 GET2 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 12
Across 12 paths, the API surfaces 12 operations — 9 GET, 2 POST, 1 PUT. They span 3 resource areas: ProfileExternal, ProfileMembership, Profile. Each is listed below with its method, path, parameters, and response codes.
ProfileExternal 8
The Profile External module allows you to retrieve and manage profiles from an external system.
GET
/externalSystems/{extSystemCode}/chains/{chainCode}/externalProfiles
Retrieve profiles from external system
GET
/externalSystems/{extSystemCode}/chains/{chainCode}/externalProfiles/{profileExternalId}
Download a Profile from external system
GET
/externalSystems/{extSystemCode}/playerStatistics/{profileId}
Retrieve player statistics
GET
/externalSystems/{extSystemCode}/gamingOffers/{membershipNo}
Get offers that can be attached for a profile
GET
/hotels/{hotelId}/travelAgents/{iataNumber}
Validate IATA number.
GET
/validatedAddresses
Retrive valid addresses from a third party vendor.
GET
/validatedAddresses/{externalAddressId}
Get full Address information from third party system for a given external Address ID. The external Address ID is fetched from valdatedAddresses service.
GET
/externalSystems/{extSystemCode}/chains/{chainCode}/validateMembershipNumber
Validate Membership Number attached to a membership
ProfileMembership 3
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
Profile 1
The Profile APIs allow you to view, create, update, and delete profiles in OPERA Cloud. Each time a new profile in created in OPERA Cloud, a profileID is assigned. Use this profil…
POST
/externalSystems/{extSystemCode}/memberships/{membershipType}/membershipIDs
Generate membership number
Schemas 328
The contract defines 328 schemas that model the data the API accepts and returns. The most detailed are stayDetailType (69 properties), stagedProfileMembershipType (49 properties), profileMembershipType (39 properties), profileDistributionFilterType (36 properties). Each schema is shown below with its type and property counts.
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
links
array
profileType
object
Type provides the detailed information about the profile and its children.
33 properties
commentInfoType
object
Comment related to the profile/reservation.
7 properties
commentType
object
An indication of a new paragraph for a sub-section of a formatted text message.
13 properties
formattedTextTextType
object
Provides text and indicates whether it is formatted or not.
2 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
codeDescriptionType
object
This contains a generic code and description information.
2 properties
customerType
object
Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
21 properties
alienInfoType
object
immigration/visa information of a foreign person.
3 properties
anonymizationType
object
Provides information about guest's anonymization status.
2 properties
anonymizationStatusType
string
Guest has been anonymized.
identificationInfoType
object
Information on the identification of the customer.
3 properties
identificationType
object
Identification information of the customer.
10 properties
personNameType
object
This provides name information for a person.
11 properties
personNameTypeType
string
Person's name in an external system.
countryNameType
object
Code for a country or a nationality.
2 properties
profileMembershipType
object
Detailed information of the memberships.
39 properties
paragraphType
object
An indication of a new paragraph for a sub-section of a formatted text message.
1 property
tierAdministrationType
string
Do not upgrade membership. The membership may be downgraded.
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.
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.
cardReIssueType
string
Request to re issue a new card.
benefitsType
array
Basic information about membership benefit.
benefitType
object
Basic information about membership benefit.
3 properties
profileRestrictions
object
3 properties
profileStatusType
string
reservationIdList
array
Unique Id that references an object uniquely in the system.
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…
taxTypeType
object
Provides information about the Tax Type.
8 properties
resAttachedProfileListType
array
resAttachedProfileType
object
3 properties
profileIdList
array
Unique Id that references an object uniquely in the system.
resProfileTypeType
string
resCommunicationType
object
Communication details for a reservation.
2 properties
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
telephoneType
object
Information on a telephone number for the customer.
11 properties
emailInfoType
object
Information on an email for the customer.
3 properties
emailType
object
Information on an email for the customer.
10 properties
reservationQueueInformationType
object
Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
6 properties
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
resCashieringType
object
Cashiering Information for the reservation.
14 properties
folioTextsType
object
This stores the information the type of tax calculation especially with tax exemption, etc.
1 property
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
5 properties
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
3 properties
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
8 properties
currencyAmountType
object
A monetary value expressed with a currency code.
1 property
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
resCompAccountingType
object
Information regarding comp accounting on the reservation.
2 properties
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
reservationDepositType
object
Reservation Deposit Type.
7 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.
reservationInterfaceStatusType
object
Hotel Interface Type for a reservation and status of the various services
3 properties
interfaceRightsStatusType
object
4 properties
hotelInterfaceType
object
8 properties
hotelInterfaceTypeType
string
XML Posting Interface
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
reservationPaymentMethodType
object
7 properties
resPaymentCardType
object
Information on a credit card for the customer.
16 properties
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
cardProcessingType
string
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 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…
32 properties
reservationBlockType
object
Key information about the block for a reservation.
3 properties
blockIdList
array
Unique Id that references an object uniquely in the system.
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
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
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
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
reservationAllowedActionsType
array
Allowed action.
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
7 properties
facilityTaskType
object
Information regarding facility task on a reservation.
3 properties
facilityCodesType
array
List of the facility codes.
facilityCodeType
object
Facility Housekeeping Code, its description and quantity.
3 properties
housekeepingTaskCodeType
object
Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.
7 properties
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
reservationFolioWindowsType
array
Collection of reservation folio windows.
reservationFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
4 properties
payeeInfoType
object
Payee information.
7 properties
addressInfoType
object
Provides address information.
3 properties
addressType
object
Provides address information.
17 properties
aRAccountShortInfoType
object
Accounts Receivabales Account details type charged for batched posting.
4 properties
aRAccountStatusType
object
Type for the Account Status. Status can be restricted and a message/description added to the Account.
3 properties
commissionPayoutToType
string
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
reservationTurndownInfoType
object
Turndown information for a reservation
2 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…
resSharedGuestListType
array
Collection of shared guest reservations.
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 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
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
30 properties
resAccompanyGuestListType
array
Collection of accompany guests
resAccompanyGuestInfoType
object
5 properties
givenNameType
string
Given name, first name or names
namePrefixType
string
Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
nameTypeType
string
surnameType
string
Family name, last name.
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
phoneNumberType
string
Phone number
basicEmailType
string
Email address
vIPType
object
The supplier's ranking of the customer.
2 properties
resGuestExternalInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
2 properties
indicatorsType
array
Collection of lamp indicators.
indicatorType
object
Lamp indicator Type.
2 properties
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
3 properties
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 properties
searchMatchesType
array
List of Generic Name-Value-Pair Parameters used for super search matches.
searchMatchType
object
Search match indicating attribute and the matching value.
2 properties
salesInfoType
object
Provides sales information about the profiles of type company, travel agent, source and contact.
13 properties
companyType
object
18 properties
iATAInfoType
object
IATA Information of the profile.
3 properties
uRLInfoType
object
Web site address.
2 properties
ownerType
object
Generic type for information about an owner.
11 properties
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
profileTypeType
string
The types of Profile handled by the web service.
imageSetType
object
Represents on image set record.
10 properties
imageStyleType
string
An enumeration of image styles.
profileCashieringType
object
Contains cashiering related details for the profile
14 properties
directBillingType
object
This is the preconfigured routing instruction type.
2 properties
lastStayInfoType
object
Contains last stay related details for the profile
4 properties
mailingActionsType
object
Defines mailing action list for the profile.
3 properties
eCertificatesType
array
List of e-certificates for the profile.
eCertificateType
object
E-Certificates details.
23 properties
eCertificateConsumptionType
object
E-Certificates details.
13 properties
eCertificateConsumeSourceType
string
Indicates that OPERA E-Certificate is consumed by hotelPMS.
eCertificateIssueSourceType
string
Indicates that OPERA E-Certificate is issued by external system.
eCertificateInfoType
object
E-Certificates details.
14 properties
eCertificateScopeType
string
Indicates that OPERA E-Certificate is available for a specific list of hotels.
eCertificateUsageCriteriaType
object
E-Certificates details.
8 properties
eCertificateGenerationType
object
E-Certificates details.
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
eCertificateStatusType
string
Indicates that OPERA E-Certificate is reserved.
eCertificateIssueType
string
Indicates that guest purchased OPERA E-Certificate.
privacyInfoType
object
Defines Privacy related information for the profile.
14 properties
profileTaxInfoType
object
Profile information related to tax.
7 properties
negotiatedInfoType
object
This provides information for a profile negotiated rate.
6 properties
profileAccessType
object
3 properties
profileSharedLevelType
string
Simple types for Shared level.
preferenceTypeType
object
Preference details for the profile.
13 properties
preferenceType
object
Guest Preference details for the profile.
7 properties
profileSubscriptionListType
array
Details of the OPERA Profile subscription to external system
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…
9 properties
keywordType
object
3 properties
keywordDetailType
object
1 property
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
dateUDFsType
array
Used to hold collection of user defined fields of Date Type.
dateUDFType
object
Used to hold user defined field of Date Type.
3 properties
characterUDFsType
array
Used to hold collection of user defined fields of Character/String Type.
characterUDFType
object
Used to hold user defined field of Character/String Type.
3 properties
numericUDFsType
array
Used to hold collection of user defined fields of Numeric Type.
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
profileAllowedActionsType
array
Allowed actions for profile operations.
profileAllowedActionType
string
Flag indicating whether Profile is Enrolled to Primary Membership Program.
masterInfoType
object
2 properties
codeInfoType
object
4 properties
addtionalCodeInfoType
object
Allows to supply additional information in the form of name value pairs in Code block, for a given MasterInfoType.
1 property
masterInfoCodeDetailType
string
masterType
string
guestProfileType
object
Type provides the detailed information about the profile and its children.
30 properties
guestProfileTypeType
string
The types of Profile handled by the web service.
companyProfileType
object
Type provides the detailed information about the profile and its children.
32 properties
companyProfileTypeType
string
The types of Profile handled by the web service.
articleInfoType
object
Information regarding an article.
9 properties
articlePostItType
object
Post it information of an article.
2 properties
colorType
string
Color configuration type. This color configuration provides a visual category of entities.
externalProfileSummaryInfoType
object
Summary information about a external profile and the associated Unique IDs.
2 properties
externalProfileSummaryType
object
Type provides the basic information about the external profile.
14 properties
ownersType
array
Generic type for a list of owners.
profileAdditionalInfoType
object
5 properties
profileNameType
object
This provides name information for a person.
8 properties
vIPStatusType
object
VIP status of the customer.
2 properties
primaryProfileInfoType
object
Contains basic information of profile.
3 properties
stagedProfileType
object
Detailed information about the staged profile.
21 properties
stagedProfileCustomerType
object
Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
27 properties
stagedProfileErrorType
object
Criteria to fetch the staged profile.
2 properties
stagedProfileErrorField
string
Simple type for stage profile error filed to specify which filed in the stage profile has error.
stagedProfilePhoneType
object
Information on a telephone number for the customer.
6 properties
stagedProfileIdentificationsType
object
Information on the identification of the customer.
6 properties
stagedProfileCommentInfosType
array
List of Notes for the customer.
stagedProfileCommentInfoType
object
Comment related to the profile/reservation.
13 properties
stagedProfileCompanyType
object
21 properties
stagedProfileUserDefinedFieldsType
object
Used to hold user defined fields(UDFs) for staged profile.
3 properties
stagedProfileNumericUDFsType
array
Used to hold collection of user defined fields of Numeric Type.
stagedProfileNumericUDFType
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…
8 properties
stagedProfileCharacterUDFsType
array
Used to hold collection of user defined fields of Character/String Type.
stagedProfileCharacterUDFType
object
Used to hold user defined field of Character/String Type.
8 properties
stagedProfileDateUDFsType
array
Used to hold collection of user defined fields of Date Type.
stagedProfileDateUDFType
object
Used to hold user defined field of Date Type.
8 properties
stagedProfileEmailType
object
Information on an email for the customer.
6 properties
stagedProfileURLType
object
Web site address.
5 properties
stagedProfileKeywordType
object
5 properties
stagedProfileRoutingInstructionType
object
2 properties
stagedProfileTrxInfoType
object
Transaction codes info.
12 properties
stagedProfileBillingInstructionType
object
Configured Billing Instruction which represents a set of Transaction Codes.
7 properties
stagedProfileMembershipType
object
Detailed information of the memberships.
49 properties
stagedProfilePreferenceType
object
Guest Preference details for the profile.
13 properties
stagedProfileAddressType
object
Provides address information.
8 properties
stagedAddressCleansStatus
string
Simple type for status of staged address cleansing.
stagedProfileNegotiatedRateType
object
This holds a list of NegotiatedInfoType.
6 properties
stagedProfileChangeInstructionsType
object
Information about instructions to change the staged profile.
1 property
stagedProfileId
object
Unique identifier for a staged profile.
2 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
dateRangeType
object
Date Range with Start and End dates.
2 properties
profileCommissionAccountInfoListType
array
Profile commission info which contains bank account and commission code details.
profileCommissionAccountInfoType
object
Profile commission info which contains bank account and commission code details
3 properties
bankAccountType
object
Bank account information like Account ID, Bank Name, Currency, etc.
13 properties
commissionPaymentMethodType
object
This contains a generic code and description information.
3 properties
profileCommissionAccountCriteriaType
object
Contains base info to determine profile commission bank account and code.
5 properties
codeListType
array
operaVersionNumberType
string
Current Opera Version Number
duplicateExternalSubscriptionsListType
array
Details of the OPERA Profile subscription to external system
duplicateExternalSubscriptionsType
object
Contains subscription details about an OPERA Profile that is linked to multiple external profiles within the same external system.
3 properties
duplicateOPERASubscriptionsListType
array
Details of the OPERA Profile subscription to external system
duplicateOPERASubscriptionsType
object
Contains subscription details about an external profile within a particular external system that is linked to multiple OPERA profiles.
2 properties
forgetProfilesCriteriaType
object
Criteria to identify the profiles to be forgotten.
1 property
profiles
array
Unique identifier for a profile.
eCertificateGenerationDetailsType
object
E-Certificates issue API call details.
5 properties
suspendedProfileMatchStatsType
array
Collection of suspended profile match statistics.
suspendedProfileMatchStatType
object
Type which represents suspended profile match statistics information.
4 properties
profileDistributionFiltersType
array
Profile Distribution Filter details.
profileDistributionFilterType
object
Profile Distribution Filter details.
36 properties
profileDistributionFilterIDType
object
Unique identifier of a Profile Distribution Filter.
1 property
profileEnrollmentType
object
Type provides the detailed information about the profile and its children.
22 properties
externalProfileSummariesType
object
A complex type containing the collection of Profile objects or Unique IDs of Profiles.
4 properties
externalStatusType
string
Success return when there is no error and operation is successful.
externalProfileType
object
Type provides the detailed information about the profile.
4 properties
incidentsType
array
Collection of Incidents for the profile.
incidentType
object
Guest Incident details for the profile.
8 properties
enrollmentMatchProfilesType
array
Provide match profile details for enrollment.
claimSourceType
string
Source of the membership claim.
claimActivityLogListType
array
Summary of claim activity log information.
claimActivityLogType
object
Summary of claim activity log information.
7 properties
claimRecordType
string
Record Type associated with a claim.
claimApprovalStatusType
string
Claim approve or reject status.
membershipClaimDetailsType
object
Detailed information of a claim.
20 properties
claimMembershipType
object
Summary of claim activity log information.
9 properties
claimAdjustmentPointsType
object
Summary of membership claim award points and tier points.
18 properties
claimReservationInfoType
object
Summary of claim activity log information.
4 properties
membershipAwardPointsByHotelType
array
List of available award points information by Hotel.
membershipAwardPointByHotelType
object
Award points information group by Hotel.
2 properties
memberAwardType
object
16 properties
memberAwardDetailsType
array
Details related to member award per stay date.
memberAwardDetailType
object
Details related to member award like award type, stay date, rate code, etc.
23 properties
memberAwardProcessType
string
Processing type of the award like Actual , Projected or Inactive.
membershipTransactionType
object
Detailed transaction information related to a membership.
2 properties
membershipTransactionDetailsType
object
Detailed information related to a membership transaction.
26 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
membershipAwardPointsType
object
Details associated with award points.
6 properties
membershipTransactionTierPointsType
object
Details associated with tier points.
6 properties
membershipDetailsType
object
Details about a membership like ProfileID, Card Number, Type, Level, etc.
8 properties
memberPointsToExpireListType
array
List of of member points to expire.
memberPointToExpireType
object
Information related to a member point to expire.
5 properties
membershipTransactionExceptionsType
array
Contains Membership transaction exception information.
membershipTransactionExceptionType
object
Details about a membership like ProfileID, Card Number, Type, Level, etc.
28 properties
membershipTransactionExceptionComputePointsType
object
Options to compute award and tier points for membership transaction exception.
8 properties
profileStatisticsType
object
Contains summary/detail/Revenue statistics information for Profile.
5 properties
stayStatisticsDetailListType
array
Collection of stay statistics detail information
stayStatisticsDetailType
object
Contains stay statistics detail information
4 properties
stayDetailType
object
The Reservation class contains the current reservation being created or altered.
69 properties
stayStatisticsRevenueType
object
Contains different list of stay statistics revenue information
8 properties
statisticsRevenueTypeType
object
Contains Revenue information
2 properties
stayReservationType
string
Enumeration for stay types.
revenueStatisticsSummaryListType
array
List of the detailed and yearly summarized information about the profile revenue.
revenueStatisticsSummaryType
object
Summary of the revenue for a year
2 properties
revenueStatisticsDetailListType
array
The collection of profile revenue statistics.
revenueStatisticsDetailType
object
The different statistics from the revenue of a profile.
8 properties
statisticsReportType
string
Indicate to get revenue of Stay Records.
statisticsSummaryListType
object
Collection of Profile statistics summary information
2 properties
profileStatisticsbyYearSummaryType
object
Contains stay statistics summary information by year
3 properties
stayDetailSummaryType
object
Contains stay related information such as reservation nights,room nights,arrival rooms,cancel rooms,etc.
8 properties
profileHotelStatisticsbyYearSummaryType
object
Contains stay statistics summary information by year
4 properties
operaVersion
object
Response for Ping operation.
2 properties
profile
object
Object for creation of profiles. This object contains profile details with unique identifiers for each profile.
3 properties
guest
object
Request object for creation of guest/contact/employee profile. This object contains profile details with unique identifiers of a profile. The standard optional…
3 properties
company
object
Request object for creation of company/agent/group/source profile. This object contains profile details with unique identifiers of a profile. The standard opti…
3 properties
enrollment
object
Response object for fetching profile enrollment from external system.
2 properties
externalProfiles
object
Response object for fetching profiles from external CRM System. This object contains profile primary details, profile summary details, master info list contain…
2 properties
externalProfile
object
Response object for fetching profile from external CRM System. This object contains profile details, preferences and incidents.
2 properties
enrollmentMatchProfiles
object
Response object to fetch match profiles for enrollment.
2 properties
membershipClaim
object
Request object for creating membership claim.
2 properties
membershipAwardPointsByHotel
object
Response object for fetching member award points by Hotel.
2 properties
membershipTransaction
object
Response object for fetching a membership transaction.
2 properties
memberPointsToExpire
object
Response object for fetching member points to expire information.
2 properties
membershipTransactionExceptions
object
Response object for fetching membership transaction exceptions.
2 properties
award
object
Request object to redeem award.
2 properties
stagedProfile
object
Request object for changing the staged profile.
3 properties
preference
object
Response object for fetch preference. This object contains collection of preferences,Success,Warnings and Errors related to this operation.
3 properties
membership
object
Request object for create membership. This object contains unique identifiers for each profile and list of membership details to be created. The standard optio…
3 properties
profileCommissionAccountInfo
object
Response object for fetching profile commission detail.
2 properties
profileCommissionAccount
object
Request object for creating profile commission detail.
2 properties
duplicateExternalSubscriptions
object
Response object for fetching subscriptions where the same OPERA profile is linked to multiple external profiles within the same external system.
7 properties
duplicateOPERASubscriptions
object
Response object for fetching subscriptions where an external profile within a particular external system is linked to multiple OPERA profiles.
7 properties
forgetProfilesCriteria
object
Operation to validate profiles for forgetting.
2 properties
eCertificates
object
Response object for fetch ECertificates. This object contains collection of ECertificates,Success,Warnings and Errors related to this operation.
2 properties
eCertificateGeneration
object
Request object to issue E-Certificate.
2 properties
suspendedProfileMatchStats
object
Response object for fetch suspended profile match statistics. This object contains collection of MatchCriteria,Threshold points,profile type.
2 properties
profileDistributionFilters
object
Response object for fetching Profile Distribution Filters.
2 properties
profileStatistics
object
Response object for fetching profile stay/reservation/revenue statistics. This object contains collection of summary or detail,Success,Warnings and Errors rela…
2 properties
fetchPlayerStatisticsRS
object
Response of the WS operation to fetch player statistics.
2 properties
playerStatisticsType
object
Contains Player Statistics information
29 properties
gamingOffers
object
Response object for fetching offers from external system.
2 properties
gamingOffersType
array
Offers that are availabl to be attached
iataNumberDetails
object
Response object to fetch IATA Number validation for Travel Agency Profile.
3 properties
checkIataNumberType
object
Type provides the IATA Validation information.
14 properties
membershipNumber
object
Request object for generating membership number.
3 properties
generateMembershipNumberCriteriaType
object
Auto generate membership number criteria.
2 properties
status
object
Response Body.
2 properties
memberInformation
object
Response object for member info.
3 properties
memberInfoRSType
object
4 properties
memberInfoDetailsType
object
14 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
addressValidationsType
array
A collection of validated Addresses.
addressValidationInfoType
object
3 properties
validateMembershipNumber
object
Response object for fetching offers from external system.
2 properties
validatedAddresses
object
Response object for fetching Addresses from external system.
3 properties
validatedAddress
object
Response object for fetching full address based on ID from external system.
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle Hospitality 12
Other APIs Oracle Hospitality publishes across the network.
OPERA Cloud Distribution ARI Publication
OPERA Cloud Distribution Outbound Lookup
OPERA Cloud Distribution Content Notification
OPERA Cloud Distribution Book
OPERA Cloud Distribution Content
OPERA Cloud Distribution Property Controls
OPERA Cloud Distribution Reservation Service
OPERA Cloud Distribution Authentication API
OPERA Cloud Distribution Onboarding
OPERA Cloud Distribution Reservation Notification
OPERA Cloud Distribution Shop
Nor1 Integrated Upsell API
#Profile#ProfileExternal#ProfileMembership#Property Management#OPERA Cloud
Where this information came from
This is an independent, third-party profile of OPERA Cloud Customer Relationship Management Outbound 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.