June 2025 ReadMe
Overview
This document contains a list of upcoming major changes to Oracle Hospitality APIs.
What will Change | Details of the Change | Target Product and Version | Impact | Call to Action |
---|---|---|---|---|
In the operation “getARCreditCardPayments” the data type of the attribute "fiscalFolioNo" is changing from from number to string in the object "aRCreditCardPaymentInfoType" |
In the “getARCreditCardPayments” operation the response object "aRCreditCardPaymentInfoType" has an attribute "fiscalFolioNo" which is of number type. However, the actual data may include alphabetic characters as well as numeric values. The attribute "fiscalFolioNo" is therefore converted to a string type, which can accommodate the string value. |
OPERA Cloud version 25.4 |
Customers or Partners whose integration expects a number in the “fiscalFolioNo” field may break when they detect alphabetic characters in the field. |
Review your integrations or applications that rely on the "getARCreditCardPayments" operation of ars.json schema and update them to handle fiscalFolioNo as a string data type. By doing so, you will ensure compatibility with the updated schema and avoid potential errors or data truncation. Test your integrations or applications with the updated schema to ensure compatibility and identify any potential issues before the change goes live. This will enable you to address any issues proactively and minimize downtime. Once the Change is Live: Update your local copies of the ars.json schema to reflect the changed data type. This will ensure that your integrations or applications remain compatible with the updated schema and can take advantage of the changes. Verify that your integrations or applications are working correctly with the updated schema. By doing so, you will be able to confirm that the changes have not introduced any issues and that your integrations or applications are functioning as expected. |
Validation is being added to the operation “setRateAccessExclusion” |
Invalid rateCode or sourceCode data will now trigger a HTTP 400 (Bad Request) response. The error message will indicate the invalid data. |
OPERA Cloud version 25.3 |
Customers or Partners using the “setRateAccessExclusion” operation will start to receive 400 error if the rateCodes and sourceCodes included in the request are not valid. |
Prepare Now: Customers or Partners using the “setRateAccessExclusion” operation should adjust their code to fetch valid rateCodes and valid sourceCodes for the property before calling the API. Test your new orchestration with these changes in a UAT or sandbox environment to address any issues proactively. |
The status field will no longer be returned in error responses from Oracle Hospitality Property APIs. |
As part of standardizing error response payloads across the platform, the Property API will remove the status field from all error responses. This change simplifies error handling and aligns with updated API design guidelines. |
OPERA Cloud version 25.3 |
Integrations that look at the status field in the error response body to make business decisions may fail. |
Prepare Now: Adjust your code to look at the HTTP response code, not the status field in the error response. Test code that determines next steps based upon the status code to ensure it works the same way using the HTTP response code. |
The data included in the Business Event payload of the below API operations will be now be dictated by what Data Elements are configured in OPERA Cloud Business Event Configuration. Previously, ALL data elements were included in the payload, regardless of what was configured in Business Event configuration. This change applies only to polling via the getBusinessEvents and getBusinessEventsByExternalSystemName APIs, not to Streaming Business Events. |
With this update, when a Business Event is triggered, only the Data Elements explicitly configured for that event in OPERA Cloud will be included in the API response payload. Data elements that have not been selected in Business Event Configuration will no longer be transmitted, even if they are updated within OPERA Cloud. This change is being introduced to improve performance, efficiency, and system stability by reducing unnecessary data transmission. |
OPERA Cloud version 25.3 |
Integrations that rely on receiving all data elements in Business Event payloads may experience incomplete data if their Business Event Configuration in OPERA Cloud has not been updated accordingly. If not adjusted:
|
Review Configuration: Check your Business Event Configuration in OPERA Cloud and ensure all required data elements are selected. Communicate with Partners: If you're a customer, confirm with your OHIP partner if any configuration changes are needed. If you're a partner, reach out to your customers to align on configuration updates. Adapt Integration Logic: Ensure your integration can handle payloads with variable data elements depending on the configuration. Add Orchestration: Orchestrate such that when you receive a Business Event notification you look at the primaryKey and send an API call to obtain the latest version of that resource using the primaryKey. This has the added benefit that the API call will return the full resource and child elements, whereas the Business Event notification includes only the header of the resource. |
The hotelIds query parameter will no longer be supported in the getHurdleRates operation. |
The getHurdleRates operation (/par/v1/hotels/{hotelId}/hurdles) includes a query parameter "hotelIds" but also includes the hotelId in the URL. The hotelIds query parameter will be removed, and the operation will only return hurdle rates for the hotel specified in the URL. |
OPERA Cloud version 25.4 |
Integrations that expect to obtain hurdle rates from multiple hotels in one API call will start receiving details from only one hotel. |
Prepare Now: If hurdle rates are required from more hotel send separate API calls for each hotel, changing the hotelId in the URL as needed. |
Parent topic: Upcoming Major Changes