OPERA Cloud Customer Relationship Management API
APIs to cater for Customer Relationship Management (profile) functionality in OPERA Cloud. There are different types of profiles in OPERA Cloud, including Guest, Company, Travel Agent, Source, Group, and Contact profile types. A profile can store and display a wide range of information about the guest, company, travel agent etc., depending upon the type of profile. For example, a guest profile can store the guest name, address, contact information, details on billing, membership benefits, preferences and much more. All profiles in OPERA when created are assigned a ProfileID. This ID will be used throughout the CRM APIs. Compatible with OPERA Cloud release 26.2.0.0. 165 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 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, ProfileLOV, ProfileMembership, and ProfileStatistics. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 165 operations across 132 paths, organized into 6 resource areas, and defines 685 schemas. It is described by OpenAPI 2.0, at version 26.2.0.0.
165 operations
132 paths
685 schemas
17 DELETE89 GET30 POST29 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 165
Across 132 paths, the API surfaces 165 operations — 17 DELETE, 89 GET, 30 POST, 29 PUT. They span 6 resource areas: Profile, ProfileMembership, SuspendedStay, ProfileLOV, ProfileStatistics, ProfileExternal. Each is listed below with its method, path, parameters, and response codes.
Profile 109
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…
GET
/address
Get city states
DELETE
/certificatesdeprecated
Delete certificate
POST
/companies
This API facilitates creation of a company/agent/group/source profile in OPERA.
GET
/companies/{corporateID}
Get company profile by corporate ID
GET
/duplicateExternalSubscriptions
Get profiles with duplicate external subscriptions
GET
/duplicateOPERASubscriptions
Get profiles with duplicate OPERA Cloud subscriptions
GET
/ecertificates
Get e-certificate
POST
/ecertificates
Create e-certificate
DELETE
/ecertificates/{certificateId}
Delete e-certificate
PUT
/ecertificates/{certificateId}
Consume an E-Certificate
PUT
/ecertificates/{certificateId}/action/validate
Verify E-Certificate Number
POST
/ecertificates/{certificateId}/extensions
Extend E-Certificate Expiry date
GET
/externalSystems/{extSystemCode}/profiles/{profileExternalId}
Get profile by external ID
PUT
/externalSystems/{extSystemCode}/profiles/{profileExternalId}
Update by external ID
POST
/guests
Create a guest, contact or employee profile in OPERA
GET
/guests/{guestId}
Get guest profile by guest ID
PUT
/hotels/{hotelId}/profiles/{profileId}/commissionAccount
Copy profile commission account
DELETE
/hotels/{hotelId}/profiles/{profileId}/flexFieldCode/{flexFieldCode}
Operation to delete a flex field.
GET
/hotels/{hotelId}/profiles/{profileId}/flexFieldValues
Operation to fetch flex field values.
POST
/hotels/{hotelId}/profiles/{profileId}/flexFieldValues
Operation to create a flex field with value for a module.
PUT
/hotels/{hotelId}/profiles/{profileId}/flexFieldValues
Operation to update flex field value.
PUT
/hotels/{hotelId}/profiles/{profileId}/reprocess
Re-Process a single Stage Record
GET
/membershipTierProjections
Get Membership Tier Projection
GET
/memberships/{membershipId}/fullfillmentExportLogsdeprecated
Get Fulfillment Export Logs
POST
/memberships/{membershipType}/membershipNumbers
Generate membership number
PUT
/processStagedProfile
Process a staged profile
GET
/profileMatchdeprecated
Fetch the profile Id if a unique guest profile Exists
POST
/profileMatch/searches
Fetch the profile Id if a unique guest profile Exists
GET
/profileTransactions/{profileId}
Get Profile Transactions
GET
/profilesdeprecated
Search for profile(s)
POST
/profiles
Create a profile
GET
/profiles/action/validate
Validate and check profiles
GET
/profiles/activityLog
Fetch profile activity log
GET
/profiles/profileMatchesdeprecated
Get potential profile matches
POST
/profiles/profileMatches/searches
Get potential profile matches
POST
/profiles/searches
Search for profile(s)
GET
/profiles/stageProfileMatches
Get potential stage profile matches
GET
/profiles/{profileId}
Get profile by ID
PUT
/profiles/{profileId}
Update a profile by ID
DELETE
/profiles/{profileId}
Forget or delete a profile by ID
GET
/profiles/{profileId}/accounts
Get profile accounts
GET
/profiles/{profileId}/attachments
Get profile attachments
DELETE
/profiles/{profileId}/attachments/{attachmentId}
Delete profile attachment
GET
/profiles/{profileId}/awardsAndCertificates
Get Profile awards and certificates
GET
/profiles/{profileId}/cashieringDetails
Get cashiering details for a profile
PUT
/profiles/{profileId}/cashieringDetails
Change cashiering details for a profile
GET
/profiles/{profileId}/commissionAccount
Get commission account on a profile
DELETE
/profiles/{profileId}/commissionAccount
Delete a commission account from a profile
POST
/profiles/{profileId}/commissionAccount
Add a commission account on a profile
PUT
/profiles/{profileId}/commissionAccount
Set profile commission account
POST
/profiles/{profileId}/emails
Create an Email.
GET
/profiles/{profileId}/flexFieldValues
Operation to fetch flex field values.
GET
/profiles/{profileId}/hotels/{hotelId}/forecasts
Fetch Account Forecasts by hotel
POST
/profiles/{profileId}/hotels/{hotelId}/forecasts
Create account forecast in a hotel
DELETE
/profiles/{profileId}/hotels/{hotelId}/forecasts
Delete multiple account forecasts
PUT
/profiles/{profileId}/hotels/{hotelId}/forecasts/periodCodes/{periodCode}
Update account forecast in a hotel by period code
DELETE
/profiles/{profileId}/hotels/{hotelId}/forecasts/periodCodes/{periodCode}
Delete account forecast in a hotel by period code
DELETE
/profiles/{profileId}/hotels/{hotelId}/preferenceType/{preferenceType}/preferences/{preferenceCode}
Delete a preference from a profile
DELETE
/profiles/{profileId}/hotels/{hotelId}/stagedProfile
Delete a staged profile
GET
/profiles/{profileId}/links
Get linked profiles
GET
/profiles/{profileId}/matches
Get profile matches
PUT
/profiles/{profileId}/membershipType/{membershipType}/membershipId/{membershipId}
Change membership information on a profile
DELETE
/profiles/{profileId}/membershipType/{membershipType}/membershipId/{membershipId}
Delete membership information from a profile
POST
/profiles/{profileId}/memberships
Create membership on a profile
GET
/profiles/{profileId}/owners
Get profile owners
PUT
/profiles/{profileId}/owners
Change profile owners
POST
/profiles/{profileId}/owners
Assign profile owners
DELETE
/profiles/{profileId}/preferenceType/{preferenceType}/preferences/{preferenceCode}
Delete a global preference from a profile
GET
/profiles/{profileId}/preferences
Get preferences on a profile
PUT
/profiles/{profileId}/preferences
Distribute preferences on a profile
POST
/profiles/{profileId}/preferences
Add preferences to a profile
GET
/profiles/{profileId}/relationships
FetchProfileRelationships method provides the ability to retrieve a profile relationships for a profile based on the unique internal profile ID specified.
PUT
/profiles/{profileId}/reservations/action/validate
Check future past bookings
GET
/profiles/{profileId}/stayHistory
FetchStayHistory method provides stay history and future reservations of a profile based on the unique internal ID specified.
POST
/profiles/{sourceProfileId}/relationships/{targetProfileId}
CreateProfileRelationship method provides the ability to create profile relationship based on the request criteria of SourceProfileID,TargetProfileID and SourceRelationType specified.
PUT
/profiles/{sourceProfileId}/relationships/{targetProfileId}
ChangeProfileRelationship method provides the ability to update(delete and add) profile relationship based on the request criteria of SourceProfileID , TargetProfileID, To Be ChangedProfileID and Sou…
DELETE
/profiles/{sourceProfileId}/relationships/{targetProfileId}
DeleteProfileRelationship method provides the ability to delete profile relationship based on the request criteria of SourceProfileID,TargetProfileID and SourceRelationType specified.
POST
/profiles/{survivorProfileId}/merges
Merge two profiles by ID
GET
/profiles/{survivorProfileId}/merges/snapshot
Get merge profiles snapshot
GET
/profiles/{survivorProfileId}/stageProfiles/snapshot
Get merge stage profile snapshot
GET
/profilesByIds
Search for profile(s)
PUT
/profilesMatchList
Updates a list of matchIds to skip or don't skip profile match.
GET
/profilesMatchList/profileType/{profileType}
Get profiles match list.
PUT
/reProcessStageRecords
Re-Process all Stage Records
GET
/reProcessStageRecords/logs
Get reProcess stage records logs.
GET
/recentlyAccessedProfiles
Fetch recently accessed profiles
DELETE
/service/profileService/cache
Operation to delete cache for Profile service
GET
/services/profile/status
Operation to check the status of profile service
GET
/stagedProfile/{id}
Get a staged profile
PUT
/stagedProfile/{id}
Change a staged profile
GET
/stagedProfilesdeprecated
Get staged profiles
POST
/stagedProfiles/searches
Get staged profiles
POST
/stayMembership
This API facilitates attaching or replacing a membership to a given stayRecord.
POST
/stayRecord
This API facilitates uploading stage records to LCS.
GET
/stayRecord/{stayRecordId}
Get Stay Record Detail.
PUT
/stayRecords/{stayRecordId}
Ability to edit Orphan Stay Records
GET
/suspendedAddressesdeprecated
Fetch Suspended Profile Addresses
GET
/suspendedProfiles/errorsSummary
Get suspended profiles errors summary details
GET
/suspendedProfiles/errorsSummary/profileType
Get suspended profiles match errors summary information grouped by profile type.
GET
/suspendedProfiles/errorsSummary/property
Get suspended profiles match errors summary information grouped by property.
POST
/suspendedProfiles/errorsSummary/property
Get suspended profiles match errors summary information grouped by property.
GET
/suspendedProfiles/matchStats
Get suspended profile match statistics information.
GET
/suspendedProfiles/matchStats/matchCriteria
Get suspended profiles match statistics information grouped by match criteria.
GET
/suspendedProfiles/matchStats/profileType
Get suspended profiles match statistics information grouped by profile type.
GET
/suspendedProfiles/matchStats/property
Get suspended profiles match statistics information grouped by property.
GET
/suspendedProfiles/matchStats/propertyAndProfileType
Get suspended profiles match statistics information grouped by property and profile type.
GET
/suspendedProfiles/matchStats/threshold
Get suspended profiles match statistics summary information filtering by threshold type.
PUT
/synchronizeProfileSubscriptions
Synchronize profile subscriptions
PUT
/validateForgetProfiles
Validate forget profiles
ProfileMembership 42
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…
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
SuspendedStay 6
These APIs will allow you to view, create, update, and delete profiles in OPERA Cloud.
PUT
/processSuspendedStays
Process Suspended Stays
GET
/suspendedStayRecordId/{suspendedStayRecordId}
Get a Suspended Stay by the Suspended Stay Record ID.
PUT
/suspendedStayRecordId/{suspendedStayRecordId}
Update a Suspended Stay by the Suspended Stay Record ID.
DELETE
/suspendedStayRecordId/{suspendedStayRecordId}
Delete a suspended stay by the Suspended Stay Record ID.
GET
/suspendedStays
Get Suspended Stays
GET
/suspendedStaysErrorsSummary
Get suspended stays errors summary
ProfileLOV 2
Profiles have many Lists of Values, storing the available options a user can select when updating a profile. This module allows you to get available ListOfValues for Profile Prefe…
GET
/profileListOfValues/availableARAddresses
Get available AR Addresses
GET
/profileListOfValues/availablePreferences
Get available preferences
ProfileStatistics 3
These APIs will allow you to retrieve statistical data for a specified profile.
GET
/profileMembershipStatistics
Get Membership statistics
GET
/profileStatistics
Get Profile Statistics
GET
/services/profileStats/status
Operation to check the status of ProfileStats service
ProfileExternal 3
The Profile External module allows you to retrieve and manage profiles from an external system.
GET
/services/profileExternal/status
Operation to check status of ProfileExternal service
POST
/validateEmail
Validate email Id from a third party vendor.
POST
/validatePhone
Validate phone number from a third party vendor.
Schemas 685
The contract defines 685 schemas that model the data the API accepts and returns. The most detailed are profileEnrollmentType (72 properties), stayDetailType (70 properties), stayRecordsType (61 properties), profileType (58 properties). Each schema is shown below with its type and property counts.
cityState
object
Response object for fetching City and State based on search criteria. This object contains address information,Success,Warnings and Errors related to this oper…
3 properties
addressType
object
Provides address information.
18 properties
countryNameType
object
Code for a country or a nationality.
2 properties
links
array
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 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
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
2 required
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
airlineTransactionsStatus
object
Request object for fetching membership transactions processed by the airline.
9 properties
airlineTransactionsType
array
Contains details of the membership transaction processing status, provided by the airline.
airlineTransactionType
object
Contains details of the membership transaction processing status, provided by the airline.
10 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
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
memberInfoType
object
Contains details of the membership transaction processing status, provided by the airline.
4 properties
surnameType
string
Family name, last name.
givenNameType
string
Given name, first name or names
airlineTransactionStatusType
object
Contains details of the membership transaction processing status, provided by the airline.
2 properties
airlineTransactionImportInfoType
object
Contains details of the membership transaction processing status, provided by the airline.
3 properties
airlineImportStatusType
string
List of possible import statuses of a membership airline processing record.
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
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
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
matchProfileType
object
Provides information for match profile.
3 properties
profileIdList
array
Unique Id that references an object uniquely in the system.
matchStatusType
string
No Match found based on the Threshold.
status
object
Response Body.
2 properties
availableAwardsBasedOnType
object
Response object to fetch member available awards based on the type being passed.
3 properties
membershipAwardsAvailabilityType
array
List of available awards information.
membershipAwardAvailabilityType
object
Details of Member Award Type. Awards will be available for redemption of award points associated with a particular member.
4 properties
rateAvailabilityType
object
Member Award availability details based on chosen award types as Product,Rate,Upgrade,FT Payment and Other.
16 properties
productAvailabilityType
object
Member Award availability details based on chosen award types as Product,Rate,Upgrade,FT Payment and Other.
14 properties
upgradeAvailabilityType
object
Member Award availability details based on chosen award types as Product,Rate,Upgrade,FT Payment and Other.
17 properties
otherAvailabilityType
object
Information related to Other Award.
9 properties
awardsToGrant
object
Response object to fetch award details to grant an award.
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…
5 properties
externalReferencesType
array
This type contains unique information of external reference.
externalReferenceType
object
This type contains unique information of external reference.
2 properties
companyProfileType
object
Type provides the detailed information about the profile and its children.
47 properties
companyType
object
21 properties
iATAInfoType
object
IATA Information of the profile.
3 properties
imageSetType
object
Represents on image set record.
11 properties
imageStyleType
string
An enumeration of image styles.
addressInfoType
object
Provides address information.
3 properties
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
telephoneType
object
Information on a telephone number for the customer.
12 properties
emailInfoType
object
Information on an email for the customer.
3 properties
emailType
object
Information on an email for the customer.
11 properties
uRLInfoType
object
Web site address.
3 properties
uRLType
object
Web site address, in IETF(The Internet Engineering Task Force) specified format.
5 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.
16 properties
formattedTextTextType
object
Provides text and indicates whether it is formatted or not.
2 properties
profileMembershipType
object
Detailed information of the memberships.
43 properties
paragraphType
object
An indication of a new paragraph for a sub-section of a formatted text message.
2 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.
benefitsType
array
Basic information about membership benefit.
benefitType
object
Basic information about membership benefit.
3 properties
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.
cardReIssueType
string
Request to re issue a new card.
preferenceTypeType
object
Preference details for the profile.
12 properties
preferenceType
object
Guest Preference details for the profile.
8 properties
keywordType
object
3 properties
keywordDetailType
object
1 property
negotiatedType
object
This holds a list of NegotiatedInfoType.
3 properties
negotiatedInfoType
object
This provides information for a profile negotiated rate.
6 properties
gdsNegotiatedType
object
This holds a list of GdsNegotiatedInfoType.
4 properties
gdsNegotiatedInfoType
object
This provides information for a channel negotiated rate.
5 properties
indicatorsType
array
Collection of lamp indicators.
indicatorType
object
Lamp indicator Type.
2 properties
relationshipInfoType
object
Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.
8 properties
changeRelationsType
object
Detailed information regarding the changes made to relationships for the profile.
5 properties
relationshipProfileType
object
13 properties
customerType
object
Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
26 properties
personNameType
object
This provides name information for a person.
13 properties
personNameTypeType
string
Person's name in an external system.
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
alienInfoType
object
immigration/visa information of a foreign person.
3 properties
companyInfoType
object
Company Information of the Profile.
3 properties
ownerType
object
Generic type for information about an owner.
11 properties
codeDescriptionType
object
This contains a generic code and description information.
2 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
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
profileStatusType
string
profileTypeType
string
The types of Profile handled by the web service.
masterAccountInfoType
object
2 properties
lastStayInfoType
object
Contains last stay related details for the profile
4 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
profileAccessType
object
4 properties
profileSharedLevelType
string
Simple types for Shared level.
profileRestrictions
object
3 properties
mailingActionsType
object
Defines mailing action list for the profile.
4 properties
privacyInfoType
object
Defines Privacy related information for the profile.
15 properties
profileCashieringType
object
Contains cashiering related details for the profile
14 properties
directBillingType
object
This is the preconfigured routing instruction type.
2 properties
profileCommissionType
object
This is the preconfigured routing instruction type.
7 properties
commissionPaymentMethods
string
Check
webUserAccountsType
array
Web User Accounts List.
webUserAccountType
object
Web User Account of the guest.
11 properties
webUserHistoryType
object
Creation date time, Creator Id, last modification date time and last Modifier Id.
7 properties
profileTaxInfoType
object
Profile information related to tax.
7 properties
salesInfoType
object
Provides sales information about the profiles of type company, travel agent, source and contact.
13 properties
eCertificatesType
array
List of e-certificates for the profile.
eCertificateType
object
E-Certificates details.
23 properties
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
eCertificateConsumptionType
object
E-Certificates details.
13 properties
eCertificateConsumeSourceType
string
Indicates that OPERA E-Certificate is consumed by hotelPMS.
eCertificateStatusType
string
Indicates that OPERA E-Certificate is reserved.
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
eCertificateIssueSourceType
string
Indicates that OPERA E-Certificate is issued by external system.
eCertificateIssueType
string
Indicates that guest purchased OPERA E-Certificate.
eCertificateGenerationType
object
E-Certificates details.
3 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…
12 properties
companyProfileTypeType
string
The types of Profile handled by the web service.
duplicateExternalSubscriptions
object
Response object for fetching subscriptions where the same OPERA profile is linked to multiple external profiles within the same external system.
9 properties
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
duplicateOPERASubscriptions
object
Response object for fetching subscriptions where an external profile within a particular external system is linked to multiple OPERA profiles.
9 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
eCertificates
object
Response object for fetch ECertificates. This object contains collection of ECertificates,Success,Warnings and Errors related to this operation.
3 properties
eCertificateGeneration
object
Request object to issue E-Certificate.
3 properties
eCertificateGenerationDetailsType
object
E-Certificates issue API call details.
5 properties
eCertificateToConsume
object
Request object to Consume an E-Certificate.
3 properties
eCertificateToVerify
object
Request object to Verify an E-Certificate Number.
5 properties
stringLength40
string
Used for Character Strings, length 0 to 40.
verifiedECertificate
object
Response object to Verify E-Certificate and will return the profile information.
4 properties
profileNameType
object
This provides name information for a person.
8 properties
eCertificateToExtend
object
Request object to Consume an E-Certificate.
4 properties
enrollment
object
Response object for fetching profile enrollment from external system.
3 properties
profileEnrollmentType
object
Type provides the detailed information about the profile and its children.
72 properties
profileDeliveryMethod
object
Delivery Information type to the profile.
7 properties
profileDeliveryModuleType
string
Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..
relationshipInfoSummaryType
object
RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact p…
7 properties
relationshipProfileSummaryType
object
11 properties
relationshipAddressType
object
Provides address information for a Relationship.
5 properties
reservationHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
historyListType
object
A collection of reservation history details attached to Profiles.
4 properties
reservationInfoType
object
The Reservation class contains the current reservation being created or altered.
51 properties
reservationIdList
array
Unique Id that references an object uniquely in the system.
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
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
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 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.
resGuaranteeType
object
Validations type record returned after Validations are done.
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
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
30 properties
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
namePrefixType
string
Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.). Currently this attribute is not used for PUT and POST operations.
phoneNumberType
string
Phone number
basicEmailType
string
Email address
vIPType
object
The supplier's ranking of the customer.
2 properties
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
resAccompanyGuestListType
array
Collection of accompany guests
resAccompanyGuestInfoType
object
5 properties
resGuestExternalInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
2 properties
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
nameTypeType
string
resSharedGuestListType
array
Collection of shared guest reservations.
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 properties
resAttachedProfileListType
array
resAttachedProfileType
object
3 properties
resProfileTypeType
string
reservationPaymentMethodType
object
7 properties
resPaymentCardType
object
Information on a credit card for the customer.
19 properties
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
cardProcessingType
string
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 properties
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
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
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…
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
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 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
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
7 properties
facilityTaskType
object
Information regarding facility task on a reservation.
3 properties
housekeepingTaskCodeType
object
Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.
7 properties
facilityCodesType
array
List of the facility codes.
facilityCodeType
object
Facility Housekeeping Code, its description and quantity.
3 properties
resCashieringType
object
Cashiering Information for the reservation.
14 properties
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
9 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
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
5 properties
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
resCompAccountingType
object
Information regarding comp accounting on the reservation.
3 properties
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
3 properties
taxTypeType
object
Provides information about the Tax Type.
8 properties
reservationDepositType
object
Reservation Deposit Type.
7 properties
reservationAllowedActionsType
array
Allowed action.
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
reservationInterfaceStatusType
object
Hotel Interface Type for a reservation and status of the various services
3 properties
hotelInterfaceType
object
8 properties
hotelInterfaceTypeType
string
XML Posting Interface
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
interfaceRightsStatusType
object
4 properties
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…
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.
resCommunicationType
object
Communication details for a reservation.
2 properties
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
3 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.
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
commissionPayoutToType
string
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
stayHistoryListType
object
A collection of reservation history details attached to Profiles.
4 properties
stayReservationInfoType
object
The Reservation class contains the current reservation being created or altered.
7 properties
stayFutureListType
object
A collection of reservation history details attached to Profiles.
4 properties
roomOwnershipType
object
Define the search criteria for retrieving room ownership records
9 properties
hotelStaysType
array
Detailed information of the hotel stay.
hotelStayType
object
Type provides the hotel stay information.
4 properties
roomPreferencesType
object
Indicates the guest's room preferences.
11 properties
earningPreferencesType
object
Indicates guest's rewards earning preferences.
3 properties
mailingPreferencesType
object
Indicates guest's mailing preferences.
2 properties
rewardsInfoType
object
Indicates membership base information like CurrentBalance,association and Owned card.
9 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
enrollmentPaymentDetailsType
object
Payment details to enrolll profile to the membership program.
5 properties
enrollmentTypeType
string
The type of external system that the guest is enrolling in, such as Loyalty, Gaming or Activities.
profileSummaryInfoType
object
Summary information about a profile and the associated Unique IDs.
2 properties
profileSummaryType
object
Type provides the basic information about the profile.
37 properties
vIPStatusType
object
VIP status of the customer.
2 properties
ownersType
array
Generic type for a list of owners.
profileAllowedActionsType
array
Allowed actions for profile operations.
profileAllowedActionType
string
Flag indicating whether Profile is Enrolled to Primary Membership Program.
primaryProfileInfoType
object
Contains basic information of profile.
3 properties
profileAdditionalInfoType
object
5 properties
masterInfoType
object
2 properties
codeInfoType
object
4 properties
addtionalCodeInfoType
array
Holds name of additional code information
masterInfoCodeDetailType
string
masterType
string
profile
object
Object for creation of profiles. This object contains profile details with unique identifiers for each profile.
7 properties
profileType
object
Type provides the detailed information about the profile and its children.
58 properties
awardKindType
string
Indicates that this is electronic certificate.
reservationCertificateType
string
Certificate is incentive.
rewardCertificateType
string
Point Saver reward.
awardStatusType
string
Indicates that certificate is in use.
fBAInfoType
object
FBA ( Flexible Benefits Awards ) related fields.
22 properties
fBAStatusType
string
Flexible benefit award has been reimbursed.
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…
5 properties
guestProfileType
object
Type provides the detailed information about the profile and its children.
45 properties
guestProfileTypeType
string
The types of Profile handled by the web service.
membershipAwardPointsByHotel
object
Response object for fetching member award points by Hotel.
3 properties
membershipAwardPointsByHotelType
array
List of available award points information by Hotel.
membershipAwardPointByHotelType
object
Award points information group by Hotel.
2 properties
profileCommissionAccountCopy
object
Request object for copying transaction groups configuration.
3 properties
copyProfileCommissionInfoType
object
Contains base info to determine profile commission bank account and code.
6 properties
codeListType
array
membershipClaim
object
Request object for creating membership claim.
3 properties
membershipClaimDetailsType
object
Detailed information of a claim.
20 properties
claimSourceType
string
Source of the membership claim.
claimApprovalStatusType
string
Claim approve or reject status.
claimRecordType
string
Record Type associated with a claim.
claimMembershipType
object
Summary of claim activity log information.
9 properties
claimReservationInfoType
object
Summary of claim activity log information.
4 properties
claimAdjustmentPointsType
object
Summary of membership claim award points and tier points.
18 properties
claimActivityLogListType
array
Summary of claim activity log information.
claimActivityLogType
object
Summary of claim activity log information.
7 properties
membershipPointsToCalculate
object
Request to run membership points calculation job.
3 properties
membershipPointsCalculationType
object
Details needed for calculating membership points.
4 properties
membershipPointsCalculationProcessType
string
Issuing awards for guests belonging to a membership type, with a specific award code that is of Other type.
membershipTierProjections
object
Response object for fetching Membership Tier Process Text.
3 properties
membershipTierProjectionType
object
Membership Upgrade/Downgrade Projection.
2 properties
calculatedPoints
object
Response object for fetching membership transaction points information.
3 properties
calculatedPointsType
object
Summary of Points Accrued for current transaction.
7 properties
calculatedPointType
object
Information related to a Calculated Points.
6 properties
rulePointsTypeType
string
Possible membership points types.
pointsRejectionReasons
object
Response object for fetching member transactions points rejection reasons information.
3 properties
pointsRejectionReasonsType
object
Summary of reason points were not awarded for a given points transaction.
7 properties
pointsRejectionReasonType
object
Information related to a Points Rejection Reason summary.
3 properties
rates
object
Response object for fetching Membership Transaction Rates information.
3 properties
membershipTransactionRatesType
object
Summary of rate details of current transaction associated with the stay.
7 properties
membershipTransactionRateType
object
Information related to a membership transaction rate.
7 properties
revenues
object
Response object for fetching Membership Transaction Revenue.
3 properties
membershipTransactionRevenuesType
object
Summary of stay details for current transaction.
7 properties
membershipTransactionRevenueType
object
Information related to a membership transactions Revenue.
7 properties
membershipTransaction
object
Response object for fetching a membership transaction.
3 properties
membershipTransactionType
object
Detailed transaction information related to a membership.
2 properties
membershipDetailsType
object
Details of membership transactions summary such as the membership details, transactions summary, points summary, etc.
10 properties
membershipTransactionDetailsType
object
Detailed information related to a membership transaction.
31 properties
membershipAwardPointsType
object
Details associated with award points.
6 properties
membershipTransactionTierPointsType
object
Details associated with tier points.
6 properties
membershipAwardExportInfo
object
Response object to fetch members information for Fulfillment house processing.
3 properties
membershipAwardsExportType
array
List of member's information.
membershipAwardExportType
object
Types holds the details of Member.
3 properties
membershipAwardRecipientInfoType
object
Type holds details of member.
4 properties
membershipIssueAwards
object
Response object for fetching member issued award list.
9 properties
membershipAwardsListType
array
List of Member Awards information.
membershipAwardListType
object
Information related to Member Award Issue List.
38 properties
membershipAwardBasedOnType
string
This award allows a guest to apply available membership points towards the balance of his or her bill.
membershipClaims
object
Response object for fetching membership claims.
9 properties
membershipClaimSummaryListType
array
Contains summary information of the claim.
membershipClaimSummaryType
object
Summary information of a claim.
23 properties
fulfillmentExportedLogs
object
Optional elements whether to update exclude extract or delivery status in membership fulfillment
3 properties
fulfillmentExportLogsType
array
This type holds the export log information for the membership fulfillment record.
fulfillmentExportInfoType
object
This type holds the export log information for the membership fulfillment record.
9 properties
exportLogsDeliveryStatusType
string
Delivery Status for export logs - Not Delivered.
memberPointsToExpire
object
Response object for fetching member points to expire information.
9 properties
memberPointsToExpireListType
array
List of of member points to expire.
memberPointToExpireType
object
Information related to a member point to expire.
6 properties
extendMemberPointsToExpire
object
Request object to extend a member points to expire.
4 properties
membershipTransactionsSummary
object
Response object for fetching member point totals information.
6 properties
memberTransactionSummaryType
object
Itemized information related to a membership transactions summary.
3 properties
memberTransactionSummaryAwardPointsType
object
Items summary associated with award points.
4 properties
transactionSummaryAttributeType
object
Attributes of Summary transactions.
2 properties
memberTransactionSummaryTierPointsType
object
Items summary associated with Tier points.
8 properties
memberTransactionSummaryGuestStaysType
object
Items summary associated with guest stays.
2 properties
memberTransactionRecentSummaryType
object
Itemized information related to a membership transactions summary.
4 properties
memberPointsSummaryType
object
Member Points Summary.
2 properties
membershipNumber
object
Request object for generating membership number.
3 properties
generateMembershipNumberCriteriaType
object
Auto generate membership number criteria.
1 property
enrollmentMatchProfiles
object
Response object to fetch match profiles for enrollment.
3 properties
enrollmentMatchProfilesType
array
Provide match profile details for enrollment.
availableARAddresses
object
Response to the request to fetch the available Accounts Receivables(AR) Addresses for a Profile.
3 properties
availablePreferences
object
3 properties
profileMembershipStatistics
object
Response of the WS operation FetchProfileMembershipPoints. It contains the summary statistics and/or the details of each of the membership transactions and its…
9 properties
membershipStatisticsType
object
List of membership transactions and the summary of the different total points statistics.
5 properties
membershipStatisticsSummaryType
object
Totals of the each of the points.
5 properties
membershipTransactionSummaryType
object
Details regarding a transaction of a profile membership.
11 properties
membershipTransactionInfoType
object
Specific details regarding the transaction.
14 properties
membershipTierPointsType
object
Collection of the tier points.
5 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…
9 properties
profileStatisticsType
object
Contains summary/detail/Revenue statistics information for Profile.
6 properties
statisticsSummaryListType
object
Collection of Profile statistics summary information
2 properties
profileHotelStatisticsbyYearSummaryType
object
Contains stay statistics summary information by year
5 properties
stayDetailSummaryType
object
Contains stay related information such as reservation nights,room nights,arrival rooms,cancel rooms,etc.
8 properties
stayReservationType
string
Enumeration for stay types.
stayStatisticsRevenueType
object
Contains different list of stay statistics revenue information
8 properties
statisticsRevenueTypeType
object
Contains Revenue information
2 properties
profileStatisticsbyYearSummaryType
object
Contains stay statistics summary information by year
4 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.
70 properties
revenueStatisticsSummaryListType
array
List of the detailed and yearly summarized information about the profile revenue.
revenueStatisticsSummaryType
object
Summary of the revenue for a year
4 properties
revenueStatisticsDetailListType
array
The collection of profile revenue statistics.
revenueStatisticsDetailType
object
The different statistics from the revenue of a profile.
9 properties
statisticsReportType
string
Indicate to get revenue of Stay Records.
profileSummaries
object
Response object for fetching profiles. This object contains profile primary details,profile summary details,master info list containing code and description us…
4 properties
profileSummariesType
object
A complex type containing the collection of Profile objects or Unique IDs of Profiles.
7 properties
profileMatchType
object
1 property
stageProfileMatchesType
object
1 property
profileMatchTypeType
object
Provides information about the profiles matched.
8 properties
stageProfileMatchType
object
Details about the matched profiles.
3 properties
checkedProfiles
object
Response for checking allowed actions, existence of attached records, or indicators of a profile.
3 properties
checkProfilesType
array
Collection of profiles and the status of its allowed actions, attached records, and indicators.
checkProfileType
object
Profile and the status of its allowed actions, attached records, and indicators.
2 properties
checkProfileResultsType
array
Collection of status of allowed actions, attached records, and indicators of the profile.
checkProfileResultType
object
Status of allowed actions, attached records, and indicators of the profile.
2 properties
checkProfileInstructionType
string
Simple type that corresponds to check profile instructions.
profileActivityLog
object
Response object for fetching profile activity log. This object contains collection of user activity log for the profile,Success,Warnings and Errors related to…
3 properties
activityLogListType
object
7 properties
activityLogType
object
12 properties
profileAccounts
object
Response of profile accounts.
3 properties
aRAccountsType
array
Information regarding the AR Account.
aRAccountType
object
Accounts Receivabales Account details type.
33 properties
traceType
object
15 properties
traceTimeInfoType
object
4 properties
dateTimeSpanType
object
Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to…
2 properties
traceResolveType
object
2 properties
fixedChargesType
array
Holds fixed charge detail.
fixedChargeType
object
Holds fixed charge information.
8 properties
fixedChargeScheduleType
object
Holds schedule of fixed charge.
5 properties
fixedChargeFrequencyType
string
Yearly.
fixedChargeDetailType
object
Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.
7 properties
aRAgingInfoType
object
Information regarding the aging balances for an account.
2 properties
aRBalanceType
object
Balance information for AR.
3 properties
aRAgingType
object
Aging information for an Aging Bucket.
6 properties
dateRangeType
object
Date Range with Start and End dates.
2 properties
aRYearViewInfoType
object
Information regarding Year View balances for an account.
2 properties
aRYearViewType
object
Year information for an Year View.
3 properties
aRInvoicesType
array
A collection of AR Invoices.
aRInvoiceType
object
Details of an AR Invoice.
53 properties
marketCodeInfoType
object
4 properties
roomClassCodeInfoType
object
Code of the room class type.
3 properties
sourceCodeInfoType
object
4 properties
cashierInfoType
object
Cashier information. Contains Id and Name details of the cashier.
2 properties
trxInfoType
object
Transaction codes info.
10 properties
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.
profileInfoType
object
Provides information about attached profiles to the block.
5 properties
folioStatusType
string
The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.
aRInvoiceCategory
string
aRPaymentsType
array
A collection of AR Payments.
aRPaymentType
object
Details of an AR Payment.
18 properties
profileAttachments
object
Response object with the details of the attachments of a profile.
3 properties
attachmentsType
array
Attachment List.
attachmentType
object
Attached files.
12 properties
dateTimeStampGroupType
object
4 properties
award
object
Request object to redeem award.
3 properties
memberAwardType
object
17 properties
memberAwardProcessType
string
Processing type of the award like Actual , Projected or Inactive.
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.
28 properties
memberAwardActionType
string
Specify whether award is to issue, cancel or update.
awardDetails
object
Response of fetch awards request.
3 properties
awardsType
array
List of awards.
awardType
object
Detailed information of the awards.
33 properties
profileCashieringDetailsInfo
object
Response object containing profile routing instructions.
3 properties
profileCashieringDetailType
object
The type contains routing instructions for the profile.
8 properties
profileRoutingInstructionsType
object
The type contains routing instructions for the profile.
3 properties
trxCodesInfoType
array
List of Transaction codes info.
billingInstructionsType
array
Set of Billing Instruction codes.
billingInstructionType
object
Configured Billing Instruction which represents a set of Transaction Codes.
4 properties
profileCashieringDetails
object
Request object for changing the profile cashiering details.
4 properties
profileCommissionAccountInfo
object
Response object for fetching profile commission detail.
3 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
profileCommissionAccount
object
Request object for creating profile commission detail.
3 properties
profileCommissionAccountCriteriaType
object
Contains base info to determine profile commission bank account and code.
5 properties
emailMessageType
object
Request object for storing an email.
9 properties
stringLength80
string
Used for Character Strings, length 0 to 80.
basicEmailListType
array
stringLength200
string
Used for Character Strings, length 0 to 200.
stringLength100
string
Used for Character Strings, length 0 to 100.
accountForecasts
object
Response object for showing forecast information of account profile.
9 properties
accountForecastsType
array
Detail Information about Account Forecast.
accountForecastType
object
Detail Information about Account Forecast.
13 properties
overrideForecastTypeType
string
Defines values for OverrideForecastType.
forecastsInformation
object
3 properties
changeAccountForecastsRS
object
Response Body.
11 properties
successType
object
Returning an empty element of this type indicates the successful processing of an message. This is used in conjunction with the Warning Type to report any warn…
errorsType
array
An error that occurred during the processing of a message.
errorType
object
Standard way to indicate that an error occurred during the processing of an message. If the message successfully processes, but there are business errors, thos…
10 properties
linkedProfiles
object
Response of fetch set of linked Profiles to the requested Profile.
3 properties
matchedProfiles
object
Response object for the match profiles.
3 properties
membershipTransactionExceptions
object
Response object for fetching membership transaction exceptions.
3 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
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…
4 properties
changedMembership
object
Response object for change/update membership. This object contains collection of memberships,Success,Warnings and Errors related to this operation
3 properties
memberInformation
object
Response object for member info.
3 properties
memberInfoRSType
object
4 properties
memberInfoDetailsType
object
14 properties
profileOwnersDetail
object
Response object to fetch the owners of a profile.
3 properties
profileOwners
object
Request object to change profile owners.
3 properties
setProfileOwnersCriteriaType
object
Criteria to update the profile owners.
2 properties
preference
object
Response object for fetch preference. This object contains collection of preferences,Success,Warnings and Errors related to this operation.
4 properties
profileRelationships
object
3 properties
relationshipsSummary
object
Contains details relationships related to a profile.
4 properties
futurePastBookingsCriteria
object
Request for information regarding existence of profile in future and/or past business blocks and/or reservations.
3 properties
hasFuturePastBookingsSearchType
object
Search type for verifying whether there are future and/or past business blocks and/or reservations exist for a Profile.
5 properties
hasFuturePastBookingsExclusionsType
object
Search type for excluding list of business blocks and/or reservations.
2 properties
futurePastBookings
object
This is the Response Message to information regarding existence of profile in future and/or past business blocks and/or reservations.
3 properties
profileStayHistory
object
Response object for showing stay history and future reservations of specific profile.
3 properties
profileStayDetailsType
object
Type provides the stay history and future reservations of specific profile.
1 property
profileRelationship
object
Request object for creating profile relationship.
4 properties
relationshipCriteriaType
object
Contains Criteria Information for a profile relationship.
7 properties
profileRelationshipToBeChanged
object
Request object for changing profile relationship.
3 properties
changeRelationshipCriteriaType
object
Information about the changes in relationship for the profile
6 properties
changeRelationsInfoType
object
Detailed information regarding to be changed relationships for the profile.
8 properties
profileToBeMerged
object
Profile Resource will be merged.
5 properties
mergedProfilesSnapshotDetails
object
Response object for fetching snapshot of merge profiles result.
3 properties
mergedProfileType
object
Provides information for merged profile.
2 properties
mergedStageProfileSnapshot
object
Response object to fetch merge profile based on stage and opera profile.
3 properties
stagedProfileType
object
Detailed information about the staged profile.
22 properties
stagedProfileCustomerType
object
Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
28 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.
stagedProfileCompanyType
object
21 properties
stagedProfileAddressType
object
Provides address information.
8 properties
stagedAddressCleansStatus
string
Simple type for status of staged address cleansing.
stagedProfilePhoneType
object
Information on a telephone number for the customer.
6 properties
stagedProfileEmailType
object
Information on an email for the customer.
6 properties
stagedProfileURLType
object
Web site address.
6 properties
stagedProfileMembershipType
object
Detailed information of the memberships.
50 properties
stagedProfilePreferenceType
object
Guest Preference details for the profile.
14 properties
stagedProfileCommissionType
object
Information on commission for the customer.
8 properties
stagedProfileKeywordType
object
6 properties
stagedProfileNegotiatedRateType
object
This holds a list of NegotiatedInfoType.
6 properties
stagedProfileIdentificationsType
object
Information on the identification of the customer.
6 properties
stagedProfileRoutingInstructionType
object
2 properties
stagedProfileTrxInfoType
object
Transaction codes info.
13 properties
stagedProfileBillingInstructionType
object
Configured Billing Instruction which represents a set of Transaction Codes.
7 properties
stagedProfileUserDefinedFieldsType
object
Used to hold user defined fields(UDFs) for staged profile.
3 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
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
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
stagedProfileCommentInfosType
array
List of Notes for the customer.
stagedProfileCommentInfoType
object
Comment related to the profile/reservation.
14 properties
profileDetails
object
Response object for fetching multiple detailed profiles by unique identifiers..
3 properties
profilesType
object
A collection of Profile objects or Unique IDs of Profiles.
3 properties
recentlyAccessedProfiles
object
Response with the fetched recently accessed profiles.
3 properties
recentlyAccessedProfileType
object
A recently used profile details.
5 properties
stagedProfileDetails
object
Response object for the staged profile.
3 properties
stagedProfile
object
Request object for changing the staged profile.
4 properties
stagedProfileChangeInstructionsType
object
Information about instructions to change the staged profile.
1 property
suspendedAddresses
object
Response object for fetching unique company profile.
3 properties
suspendedAddressesType
object
List of suspended addresses returned, based on the entered seach criteria.
7 properties
suspendedAddressesInfoType
object
10 properties
profileSubscriptionsToSynchronize
object
Request object for re-subscribing profile subscriptions.
3 properties
synchronizeProfileSubscriptionsCriteriaType
object
Criteria for searching profile subscriptions.
2 properties
databaseIDListType
array
Code identifying the external database record which is linked to external systems.
forgetProfilesCriteria
object
Operation to validate profiles for forgetting.
3 properties
forgetProfilesCriteriaType
object
Criteria to identify the profiles to be forgotten.
2 properties
profiles
array
Unique identifier for a profile.
validatedForgetProfiles
object
Response object for validating profiles for forgetting.
3 properties
forgetProfileResultListType
array
Result of processing/validation for forgetting a profile.
forgetProfileResultType
object
Results of Anonymization processing/validation.
4 properties
forgetProfileFailureReasonListType
array
Reason describing why the profile is not eligible to be forgotten.
forgetProfileFailureReasonType
object
Provides information about the reason why the profile is not eligible to be forgotten.
3 properties
actionType
string
Action types allowed by the event api.
revenueBucketType
object
The different revenue buckets of a profile.
3 properties
revenueBucketListType
object
Details about revenue summary.
1 property
membershipPromotionDetails
object
The request element used to create a membership promotion.
3 properties
membershipPromotionsDetails
object
Response object for fetching membership promotions information.
3 properties
membershipPromotionType
object
Information related to a membership promotion.
7 properties
copyInstructionsType
object
Copy Instructions for a profile
1 property
copyInstructionType
string
Copy Instruction for a profile
profileMatchStatusType
string
Status of the match. It can be one of these 3 options: Match Points Computed, Do Not Merge, Can Not Merge.
profilesMatch
object
Response object for fetching the profiles match.
8 properties
profilesMatchType
object
Type that contains the information of a profile match such as main profile, profile to merge, match id, status of the match, date when the points where compute…
10 properties
shortInfoProfileType
object
This type contains short information of a profile.
3 properties
matchListType
object
Type that contains the list of theh matchIds that will be updated to skip or don't skip profile match.
1 property
matchType
object
Type that contains matchId and if this particular matchId is set to skip profile match or not.
2 properties
membershipPointsExceptionsType
object
Contains Membership points exception information.
3 properties
membershipPointsExceptions
object
Response object for fetching membership points exceptions.
3 properties
fileType
string
File Type of the staging file.
memberPointsExceptionType
object
Details about a membership like ProfileID, Card Number, Type, Level, etc.
20 properties
memberPointsExceptions
object
Response object for fetching membership points exceptions.
9 properties
membershipExceptionStatusType
string
List of possible membership exception type.
membershipReservationDetails
object
Response element for membership reservation activity updated.
4 properties
membershipReservationDetailUnitType
object
The filetered membership reservation information.
2 properties
membershipReservationDetailCodeType
string
Supported memebership reservation detail code type.
issueAwardsInfoType
array
List of awards info.
issueAwardInfoType
object
Information about issue award.
6 properties
issuedAward
object
Response object for issue awards.
3 properties
otherAwardAvailabilityType
object
Information related to the Other type Award.
4 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
otherAwardsIssueCriteria
object
Request object to issue an OTHER type award to a member's profile.
3 properties
profileMatch
object
Response object for fetching profile Match.
3 properties
stagedProfileSummariesType
object
A collection of staged profiles.
7 properties
stagedProfileSummaryType
object
Basic information about staged profile.
14 properties
stagedProfileStatus
string
Simple type for status of the staged profiles.
stagedProfileProcessType
string
Process Type enumerator.
stagedProfileId
object
Unique identifier for a staged profile.
2 properties
processStagedProfileType
object
Information required to process a atged profile.
3 properties
stagedProfileSourceType
string
processStagedProfileResultType
object
Information about the staged profile after processing.
4 properties
stagedReasonsType
object
This is used to fetch staged profiles based on the reason why it got staged.
1 property
stagedReasonType
string
Reasons why the profile got staged. InvalidExpirationDate indicates the membership expiration date is not matching with OPERA system. InvalidEnrollmentCode ind…
stagedProfiles
object
Response object for the staged profiles.
3 properties
stagedProfileCriteria
object
3 properties
processedStagedProfile
object
3 properties
profileDistributionConditionGroupType
object
3 properties
logicalOperatorType
string
profileDistributionConditionType
object
4 properties
profileDistributionExpressionFieldType
object
6 properties
profileDistributionFieldNameType
object
1 property
fieldType
string
profileDistributionExpressionParameterType
object
3 properties
profileDistributionExpressionOperatorType
object
3 properties
membershipTransactionsSummaryCollection
object
Response object for fetching multiple memberships transactions summaries.
3 properties
membershipTransactionsSummaryType
object
Details of membership transaction like Details, Summary, point, etc.
4 properties
stayDailyRatesType
object
9 properties
2 required
stayMembershipsType
object
2 properties
stayProfilesType
object
4 properties
1 required
stayRecordsType
object
61 properties
stayRevenuesDetailsType
object
3 properties
stayRevenuesType
object
3 properties
2 required
stayRecord
object
6 properties
stayRecordDetails
object
Complex type that contains stay record details
1 property
flexFieldValues
object
Request object for flex fields values.
3 properties
flexFieldValueType
object
Provides the details of a flex field values
3 properties
flexFieldsResponse
object
Response object for flex fields.
9 properties
memberPointsToExpireCollection
object
Response object for fetching member points to expire information.
3 properties
memberPointsToExpireCollectionType
object
Membership points to expire with the membership details to differentiate.
2 properties
operaVersionNumberType
string
Current Opera Version Number
operaVersion
object
Response for Ping operation.
3 properties
profileTransactionsType
object
Transaction related to the Profile.
19 properties
profileTransactions
object
Response of the WS operation FetchProfileTransactions.
9 properties
suspendedStayRevenueType
object
Suspended Stay Revenue information.
4 properties
suspendedStayErrorType
object
Suspended Stay Error information.
3 properties
suspendedStayErrorsType
object
Collection of Suspended Stay Error information.
1 property
suspendedStayDailyRateType
object
Suspended Stay Rate information.
6 properties
suspendedStayMembershipType
object
Suspended Stay Membership information.
3 properties
suspendedStayType
object
Suspended Stay information.
34 properties
suspendedStaySummaryType
object
Collection of Suspended Stay information.
11 properties
suspendedStaySummariesType
object
A complex type containing the collection of Suspended Stay Summaries.
7 properties
suspendedStayDetailType
object
Suspended Stay Record ID detail about a Suspended Stay.
1 property
suspendedStayDetailsType
object
Suspended Stay Record ID details about a Suspended Stay.
1 property
suspendedStayDetails
object
Request object for process suspended stays.
18 properties
membershipCardHistoryType
object
Contains details of the card history of a member.
2 properties
memberCardHistoryList
object
Response object for member card history.
9 properties
stayRecordDetail
object
Stay Record details for a single stay record including Revenues, Daily Rates and UDFs.
5 properties
stayMembershipDetails
object
Complex type that contains stay membership details and instructions to attach or replace.
6 properties
1 required
stayMembershipAttachMode
string
Flag that indicates if membership should be attached or existing membership should be replaced.
stayMembershipSummaryListType
object
Details about stay membership.
1 property
stayMembershipSummaryType
object
Rendering membership type and membership card number associated to a stay.
2 properties
suspendedProfileType
string
The types of suspended profiles
suspendedProfilesMatchStatsType
object
Suspended profiles match statistics
1 property
rESTPaginationGroup
object
Provides Pagination Information for the REST API.
5 properties
suspendedProfilesMatchStats
object
Response object for fetch suspended profiles match statistics.
3 properties
suspendedProfilesMatchStatType
object
Type which represents suspended profiles match statistics information.
7 properties
suspendedProfilesErrorsSummaryType
object
Profiles errors summary type.
1 property
suspendedProfilesErrorSummaryType
object
Type which represents suspended profile errors information.
2 properties
suspendedProfilesErrorsSummaryInfo
object
Response object for fetch suspended profiles errors summary. This object contains collection of profiles errors and the number of profiles that were encountere…
3 properties
errorDescType
object
Object for specific error description.
3 properties
suspendedProfilesErrorsSummaryByPropertyInfo
object
Response object for fetch suspended profiles errors summary by property. This object contains a collection of suspended profiles match errors and the count of…
3 properties
suspendedProfilesErrorsSummaryByPropertyType
object
Suspended profiles errors summary by property.
1 property
suspendedProfilesErrorSummaryByPropertyType
object
Type which represents a suspended profiles error by property information.
2 properties
suspendedProfilesMatchStatsByThreshold
object
Response object for fetch suspended profiles match statistics filtered by threshold type.
3 properties
suspendedProfilesMatchStatsByThresholdType
object
Suspended profiles match statistics grouped by threshold
1 property
suspendedProfilesMatchStatByThresholdType
object
Type which represents suspended profiles match statistics information.
3 properties
suspendedProfilesMatchStatsByMatchCriteria
object
Response object for fetch suspended profiles match statistics grouped by match criteria.
3 properties
suspendedProfilesMatchStatsByMatchCriteriaType
object
Suspended profiles match statistics grouped by match criteria.
1 property
suspendedProfilesMatchStatByMatchCriteriaType
object
Type which represents suspended profiles match statistics grouped by match criteria.
2 properties
suspendedProfilesMatchStatsByProperty
object
Response object for fetch suspended profiles match statistics grouped by property.
3 properties
suspendedProfilesMatchStatsByPropertyType
object
Suspended profile match statistics grouped by property.
1 property
suspendedProfilesMatchStatByProperty
object
Type which represents suspended profiles match statistics grouped by profile type.
3 properties
suspendedProfilesMatchStatsByProfileType
object
Response object for fetch suspended profiles match statistics grouped by profile type.
3 properties
suspendedProfilesMatchStatsByProfileTypeType
object
Ssuspended profiles match statistics grouped by profile type.
1 property
suspendedProfilesMatchStatsByPropertyAndProfileType
object
Response object for fetch suspended profiles match statistics grouped by property and profile type.
3 properties
suspendedProfilesMatchStatsByPropertyAndProfileTypeType
object
Suspended profiles match statistics grouped by property and profile type.
1 property
suspendedProfilesMatchStatByProfileType
object
Type which represents suspended profiles match statistics grouped by profile type.
3 properties
validateEmail
object
Request object for validating email Id from external system.
4 properties
validateEmailStatus
object
Response Body.
4 properties
reProcessStageRecordsType
object
Provides information about the search criteria for the staged records to reprocess.
12 properties
reProcessStageRecord
object
3 properties
reProcessStageRecords
object
Request object for processing the staged records.
3 properties
reProcessStageRecordsCriteria
object
Object for Reprocessing Stage Records.
3 properties
reProcessStageRecordResultType
object
Information about the staged profile after processing.
5 properties
validatePhone
object
Request object for validating phone number from external system.
4 properties
validatePhoneStatus
object
Response Body.
4 properties
suspendedProfilesMatchStatByPropertyAndProfileTypeCombined
object
Type which represents suspended profiles match statistics grouped by property with detailed view
3 properties
profileTypesListType
object
Type which represents suspended profiles match statistics grouped by profile type with detailed view
3 properties
matchCriteriaListType
object
Type which represents suspended profiles match statistics grouped by profile type with detailed view
2 properties
suspendedProfilesErrorsSummaryByProfileTypeInfo
object
Response object for fetch suspended profiles errors summary by profile type. This object contains a collection of profile types and the count of errors found i…
3 properties
suspendedProfilesErrorsSummaryByProfileType
object
Suspended profiles errors summary by profile type.
1 property
suspendedProfilesErrorSummaryByProfileType
object
Type which represents a suspended profiles error by profile type.
2 properties
applyToType
string
Membership filter of staged profiles.
reProcessStageRecordsLogInfo
object
Response object for fetch reProcessStageRecords logs.
9 properties
reProcessStageRecordLogEntry
object
A log entry for a reprocess/rematch job.
9 properties
suspendedStaysErrorsSummaryResponse
object
3 properties
suspendedStaysErrorsSummaryType
object
7 properties
suspendedStaysErrorsSummary
object
3 properties
2 required
revenueTransactionCodeListType
object
List of revenue by transaction codes.
1 property
revenueTransactionCode
object
Revenue by transaction codes.
8 properties
memberHistoryList
object
Response object for member history.
9 properties
membershipHistoryType
object
Contains details of the profile's primary membership history.
6 properties
searchTypeEnum
string
profileTypeEnum
string
relatedProfileTypeEnum
string
fetchInstructionsEnum
string
allowedActionEnum
string
searchProfilesRequest
object
57 properties
searchProfileMatchesRequest
object
12 properties
searchProfileMatchRequest
object
10 properties
orphanStayRecord
object
The request element used to update orphan stay record elements.
3 properties
orphanStayRecordType
object
This object stores the elements which user wants to update.
12 properties
searchStagedProfilesRequest
object
21 properties
stagedReasonsEnum
string
applyToEnum
string
customizedPrivacyCodesType
object
Customized privacy codes and values
2 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#ProfileLOV#ProfileMembership#ProfileStatistics#SuspendedStay#Property Management#OPERA Cloud
Where this information came from
This is an independent, third-party profile of OPERA Cloud Customer Relationship Management 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.