1. User Guide
  2. Using the Oracle Hospitality APIs
  3. Oracle Hospitality Asynchronous APIs
  4. Workflow
  5. Types and Usage Recommendations

Types and Usage Recommendations

The currently supported Async API operations are listed below.

The Asynchronous APIs can be classified into two types according to how they interact with OPERA Cloud:

  1. Operations that fetch Data from OPERA Cloud. This is applicable to the following operations along with the limits specified below:
    Operation ID  Functionality Limit OPERA Cloud Version Dependencies (if any) Recommendations

    Module: Inventory

    startRevenueInventoryStatisticsProcess (POST) getRevenueInventoryStatisticsProcessStatus (HEAD) 

    getRevenueInventoryStatistics (GET)

    • Enables you to retrieve Revenue Inventory Statistics

    • You can use this API to fetch revenue inventory statistics for past, present, and future reservations from OPERA Cloud. You will be able to filter using stay date (with a start and end date) to fetch inventory data.

    • Every identical request (employing the same query parameters) necessitates a mandatory 30-minute interval between submissions. Please note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    • Current date range limit: 400 days (Refer to the OPERA Cloud Version Dependencies column for more details.)

    • With the OPERA Cloud versions 22.1  and higher, the getRevenueInventoryStatistics API response includes values for roomSold, projected roomRevenue, roomArrival, roomDeparture, and projected totalRevenue for reservations with arrival date same as the property business date.

    • With the OPERA Cloud versions 22.5 and higher, every identical request (employing the same query parameters) necessitates a mandatory 30-minute interval between submissions. Please note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    • With the OPERA Cloud versions 23.2 and higher, the maximum date range allowed per request is extended from 94 to 400 days.

    • With the OPERA Cloud versions 24.1 and higher, the getRevenueInventoryStatistics API includes distributed revenue in its response.

    • With the OPERA Cloud versions 24.1 and higher, the getRevenueInventoryStatistics API does not include pseudo room inventory in its response.

    • This API is suitable for retrieving future inventory data and calculating net revenue. You can group the data either by Room Type, Market Code, or Guarantee Code (Reservation Type) or you can gather data per date for the entire hotel.

    Module: Blocks

    startBlockAllocationSummaryProcess (POST)

    getBlockAllocationSummaryProcessStatus (HEAD) 

    getBlockAllocationSummary (GET)

    • Enables you to retrieve Block Allocation Summary

    • You can use this API to fetch Block allocation information for a hotel and specified date range. The block allocated inventory, rates, and room type statistics, including revenue, are returned as part of the response.

    • Every identical request (employing the same query parameters) necessitates a mandatory 30-minute interval between submissions. Please note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    • The maximum date range allowed per request is 94 days.

    • When requesting data with startLastModifiedDate/endLastModifiedDate, subsequent identical requests (with the same query parameters) must be spaced 3 hours apart. Note that this limit only applies to identical POST requests made without completing the entire POST, HEAD, and GET cycle.

     

    • With the OPERA Cloud versions 21.5 and higher, the getBlockAllocationSummary API response will include values for ownerCode, cutOffDays, cutOffDate, blockType, all status blocks, cancellationDate, and extraPerson values. 

    • With the OPERA Cloud versions 22.1 and higher, the getBlockAllocationSummary API response has been enhanced to include block daily and total revenue statistics.

    • With the OPERA Cloud versions 22.4 and higher, a new search filter lastModifiedDate has been added to the startBlockAllocationSummaryProcess API operation to get the data modified after the previous fetch request.

    • With the OPERA Cloud versions 22.4 and higher, when requesting data with startLastModifiedDate/endLastModifiedDate, subsequent identical requests (with the same query parameters) must be spaced 3 hours apart. Note that this limit only applies to identical POST requests made without completing the entire POST, HEAD, and GET cycle.

    • With the OPERA Cloud versions 22.5 and higher, every identical request (employing the same query parameters) necessitates a mandatory 30-minute interval between submissions. Please note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    • With OPERA Cloud versions 23.3 and higher, the getblockAllocationSummary API response will include origin code.

    • With OPERA Cloud versions 24.2 and higher, the getBlockAllocationSummary includes the "hotelId" field, indicating the corresponding resorts.

    • With OPERA Cloud versions 24.2 and higher, every identical request (employing the same query parameters) for the  getBlockAllocationSummary operation when requesting data with startLastModifiedDate/endLastModifiedDate, necessitates a mandatory 30-minute interval between submissions. Please note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    • With OPERA Cloud versions 24.2 and higher, the getBlockAllocationSummary returns the Profile Name for the Company profile and/or Travel Agent Profile on the Block in the response.

     

    Module: Reservations

    startReservationsDailySummaryProcess (POST)

    getReservationsProcessStatus (HEAD)

    getReservationsDailySummary (GET)

    • Enables you to retrieve Reservation Daily Summary

    • This API allows external systems to retrieve a summary of reservations for a specified hotel and date range.

    • Every identical request (employing the same query parameters) necessitates a mandatory 30-minute interval between submissions. Please note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    • The maximum date range allowed per request is 94 days (whether it is in the past or the future).

    • When requesting data with startLastModifiedDate/endLastModifiedDate, subsequent identical requests (with same query parameters) will have to be spaced 3 hours apart. Note that this limit only applies to identical POST requests made without completing the entire POST, HEAD, and GET cycle. 

    • With the OPERA Cloud versions 22.4 and higher, every identical request (employing the same query parameters) necessitates a mandatory 30-minute interval between submissions. Please note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    • With the OPERA Cloud versions 22.4 and higher, a new search filter lastModifiedDate has been added to the startReservationsDailySummaryProcess operation to get the data modified after the previous fetch request.

    • With the OPERA Cloud versions 22.4 and higher, when requesting data with startLastModifiedDate/endLastModifiedDate, subsequent identical requests (with same query parameters) will have to be spaced 3 hours apart. Note that this limit only applies to identical POST requests made without completing the entire POST, HEAD, and GET cycle. 

    • With the OPERA Cloud versions 22.4 and higher, the getReservationdailySummary API response will include a reservation's net room rate amount.

    • With the OPERA Cloud versions 24.1 and higher, the getReservationDailySummary async operation in the RSV Async API includes the reservation external reference in the response should a reservation have an external reference on it in OPERA Cloud.

    • With OPERA Cloud versions 24.2 and higher, the getBlockAllocationSummary includes the "hotelId" field, indicating the corresponding resorts.

    • With OPERA Cloud versions 24.2 and higher, every identical request (employing the same query parameters) for the getReservationsDailySummary operation when requesting data with startLastModifiedDate/endLastModifiedDate, necessitates a mandatory 30-minute interval between submissions. Please note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    • This API is suitable to get a summary of all reservations at a hotel when onboarding a new property with your integration.

    • Data can be requested using either startDate/endDate or startLastModifiedDate/endLastModifiedDate. It is recommended to use the startLastModifiedDate and endLastModifiedDate parameters to retrieve incremental updates since the last call.

    • When requesting data with startLastModifiedDate/endLastModifiedDate, it is recommended to complete all sets of calls (POST, HEAD, and GET) before making new data requests. 

    • Note that if there are no reservations that match the specified criteria for the date range (fixed dates or last modified), it is possible to receive an empty response, indicating no reservations found.
  2. Operations that POST Data to OPERA Cloud. This is applicable to the following operations along with the limits specified below:
    Operation ID  Functionality Limit OPERA Cloud Version Dependencies (if any) Recommendations

    Module: Rate Plan

    startSetDailyRatePlanSchedulesProcess (POST)

    getDailyRatePlanSchedulesProcessStatus (HEAD)

    getDailyRatePlanSchedules (GET)

     

    • Enables you to create Daily Rate Plan Schedules

    • You can use this API to add and/or update the rate price schedule to existing OPERA Daily Rate plans.

    • Every identical request (employing the same query parameters) necessitates a mandatory 30-minute interval between submissions. Note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    • While you can update multiple Daily Rate Plan schedules for a given property, you can only update rates for only one property at a time. Refer to About Rate Codes in the OPERA Cloud Services User Guide for more information on rate structures.

    • You can update rates up to 180 days into the future. 

    • The primary and only limitation in this process is related to the payload size that the API user intends to upload.  

    • Optimal payload size: 2 MB

     

    • With the OPERA Cloud versions 22.5 and higher, every identical request (employing the same query parameters) necessitates a mandatory 30-minute interval between submissions. Note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    • Operate on a first-come, first-served basis. Data submissions are processed in the order they are received, and the only constraint lies in ensuring that the payload adheres to the specified size guidelines.

     

    startSetBestAvailableRatePlansProcess (POST)

    getBestAvailableRatePlansProcessStatus (HEAD)

    getBestAvailableRatePlans (GET)

    • Enables you to create Best Available Rate Plans by Length of Stay or by Day.

    • You can use this API to post new or update existing Best Available Rate by Length Of Stay or by DAY to OPERA Cloud.

    • Every identical request (employing the same query parameters) necessitates a mandatory 30-minute interval between submissions. Note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    • The primary and only limitation in this process is related to the payload size that the API user intends to upload.  

    • Optimal payload size: 100 KB

    • With the OPERA Cloud versions 22.5 and higher, every identical request (employing the same query parameters) necessitates a mandatory 30-minute interval between submissions. Please note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    Operate on a first-come, first-served basis. Data submissions are processed in the order they are received, and the only constraint lies in ensuring that the payload adheres to the specified size guidelines.

    startHurdleRatesProcess (POST)

    getHurdleRatesProcessStatus (HEAD)

    getHurdleRates (GET)

     

    • Enables you to create Hurdle Rates.

    • You can use this API to create Hurdle Rates in OPERA Cloud by date.

    • Every identical request (employing the same query parameters) necessitates a mandatory 30-minute interval between submissions. Please note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    • The primary and only limitation in this process is related to the payload size that the API user intends to upload.   

    • Optimal payload size: 100 KB

    • With the OPERA Cloud versions 22.5 and higher, every identical request (employing the same query parameters) necessitates a mandatory 30-minute interval between submissions. Note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    Operate on a first-come, first-served basis. Data submissions are processed in the order they are received, and the only constraint lies in ensuring that the payload adheres to the specified size guidelines.

    Module: Availability

    postRestrictionsProcess (POST)

    getRestrictionsProcessStatus (HEAD)

    getRestrictions (GET)

    • Enables you to create Restrictions.

    • A user can send various restrictions to OPERA Cloud by specifying restriction details in the request. You can set restrictions for a whole year and have multiple restrictions on a given day.  However, there can be a hierarchy of restrictions. 

    • Refer to Managing Restrictions in the OPERA Cloud Services User Guide for more information.

    • Every identical request (employing the same query parameters) necessitates a mandatory 30-minute interval between submissions. Note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    • The primary and only limitation in this process is related to the payload size that the API user intends to upload.   

    • Optimal payload size: 2 MB

    • With the OPERA Cloud versions 22.5 and higher, every identical request (employing the same query parameters) necessitates a mandatory 30-minute interval between submissions. Note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    • Operate on a first-come, first-served basis. Data submissions are processed in the order they are received, and the only constraint lies in ensuring that the payload adheres to the specified size guidelines.

    Module: Inventory

    postSellLimitsProcess (POST)

    getSellLimitsProcessStatus (HEAD)

    getSellLimits (GET)

    • Enables you to create Sell Limits

    • You can use this API to create sell limits in OPERA Cloud by date. Refer to Sell Limits in the OPERA Cloud Services User Guide for more information.

    • Every identical request (employing the same query parameters) necessitates a mandatory 30-minute interval between submissions. Note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    • The primary and only limitation in this process is related to the payload size that the API user intends to upload. 

    • Optimal payload size: 2 MB 

    • With the OPERA Cloud versions 22.5 and higher, every identical request (employing the same query parameters) necessitates a mandatory 30-minute interval between submissions. Note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    • Operate on a first-come, first-served basis. Data submissions are processed in the order they are received, and the only constraint lies in ensuring that the payload adheres to the specified size guidelines.

    Module: Blocks

    startShiftBlockProcess (POST)

    getShiftBlockProcessStatus (HEAD)

    getShiftBlockProcessInfo (GET)

    Provides the ability to shift block dates for a business block with rooms inventory or events or both.

    • Every identical request (employing the same query parameters) necessitates a mandatory 30-minute interval between submissions. Please note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    • The primary and only limitation in this process is related to the payload size that the API user intends to upload. Optimal payload size: 2 MB. 

    This operation has been introduced with OPERA Cloud versions 24.2 and higher.

    • Operate on a first-come, first-served basis. Data submissions are processed in the order they are received, and the only constraint lies in ensuring that the payload adheres to the specified size guidelines.

    Module: Reservation

    startRoomingListValidationProcess (POST)

    getRoomingListValidationProcessStatus(HEAD)

    getRoomingListValidationProcessResults(GET)

    Enables you to create multiple block reservations in OPERA Cloud for a specific block as well as match the associated names with existing profiles.

    • Every identical request (employing the same query parameters) necessitates a mandatory 30-minute interval between submissions. Please note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    • The primary and only limitation in this process is related to the payload size that the API user intends to upload. Optimal payload size: 2 MB. 

    This operation has been introduced with OPERA Cloud versions 24.1 and higher.

    • Operate on a first-come, first-served basis. Data submissions are processed in the order they are received, and the only constraint lies in ensuring that the payload adheres to the specified size guidelines.

    Module: Profiles

    stayRecords (POST)

    getStayRecordsProcessStatus (HEAD)

    getStayRecordsProcess (GET)

    Allows you to import Stay Records for a profile.

    • Every identical request (employing the same query parameters) necessitates a mandatory 30-minute interval between submissions. Please note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed.

    • The primary and only limitation in this process is related to the payload size that the API user intends to upload. Optimal payload size: 2 MB. 

    This operation has been introduced with OPERA Cloud versions 24.2 and higher.

    • Operate on a first-come, first-served basis. Data submissions are processed in the order they are received, and the only constraint lies in ensuring that the payload adheres to the specified size guidelines.

Parent topic: Workflow