Oracle Hospitality Reservation API

openapi: 3.2.0
info:
  title: Oracle Hospitality Reservation API
  version: 26.2.0.0
  contact:
    email: hospitality_apis_ww_grp@oracle.com
  license:
    name: UPL
    url: https://opensource.org/licenses/upl
  termsOfService: https://www.oracle.com/legal/terms.html
  description: 'Operations tagged Reservation across 2 of this provider''s published API definitions: oracle-hospitality-distribution-v1-distribution.json, oracle-hospitality-property-v1-rsv.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /distribution/v1
- url: /rsv/v1
tags:
- name: Reservation
  description: Reservation API
paths:
  /hotels/{hotelId}/reservations:
    post:
      summary: Create Reservation
      description: <p>This API allows the user to Create Reservations.</p> <p><strong>OperationId:</strong>postReservation</p>
      operationId: postReservation
      tags:
      - Reservation
      parameters:
      - $ref: '#/components/parameters/hotelId'
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/Accept-Language'
      - $ref: '#/components/parameters/channelCodeHeader'
      responses:
        '200':
          description: OK
          headers:
            Content-Language:
              description: Response language
              x-example: en-US
              schema:
                type: string
            Location:
              description: Location of the newly created reservation
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/createReservationResponse'
        '400':
          description: Bad Request
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '401':
          description: Unauthorized
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '403':
          description: Forbidden
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '404':
          description: Not Found
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '405':
          description: Not supported
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '406':
          description: Not acceptable
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '413':
          description: Payload Too Large
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '414':
          description: URI Too Long
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '415':
          description: Unsupported Media Type
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '500':
          description: Internal Server Error
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '502':
          description: Bad Gateway
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '503':
          description: Service Unavailable
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/createReservation'
        required: true
    get:
      summary: Get Reservations for a hotel
      description: This API will allow a user to retrieve a list of reservations based on the search criteria specified in the request body. For example you can search for reservations using query parameters like first name, last name, arrival/departure date, external confirmation number. <p><strong>OperationId:</strong>getHotelReservations</p>
      operationId: getHotelReservations
      deprecated: true
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID of the hotel where reservation is searched based on reservation ID.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: keyTrack2
        in: query
        required: false
        description: keyTrack2 is an id which is either generated by the PMS or provided by the door lock system and which is associated to the reservation. With the keyTrack2 value a reservation can be identified.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: discrepancy
        in: query
        required: false
        schema:
          type: string
          enum:
          - Skip
          - Sleep
          uniqueItems: true
      - name: recentlyAccessed
        in: query
        required: false
        description: Mark this reservation as recently accessed.
        schema:
          type: boolean
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
      - name: offset
        in: query
        required: false
        description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.
        schema:
          type: integer
          default: 0
      - name: searchType
        in: query
        required: false
        description: Represents Reservation search type Player Snapshot.
        schema:
          type: string
          enum:
          - Any
          - DayUse
          - Arrival
          - Arrived
          - Departure
          - WaitList
          - Cancellation
          - CheckedOut
          - NoShow
          - Complimentary
          - InHouse
          - PostStayPendingBalance
          - PreRegistered
          - PostToRoom
          - OpenFolio
          - ScheduledCheckOut
          - Queued
          - MobileCheckout
          - RegisteredAndInHouse
          - ResvBlockTraces
          - GuestMessages
          - MassCancellation
          - Operator
          - Turndown
          - WalkIn
          - AdvanceCheckedIn
          - OpenBalance
          - AutoFolioSettlement
          - Routing
          - PlayerSnapshot
          - FiscalInfo
          - CorrectionPostings
          - Vouchers
          - ScheduledRoomMoves
          uniqueItems: true
      - name: text
        in: query
        required: false
        description: Free form text field for searching all reservation fields
        schema:
          type: string
      - name: reservationIdList
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: confirmationNumberList
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: cancellationNumberList
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: externalReferenceIds
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: externalSystemCodes
        in: query
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          default:
          - External
      - name: externalReferenceLegId
        in: query
        description: External reference leg number
        required: false
        schema:
          type: number
      - name: arrivalEndDate
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: arrivalStartDate
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: departureEndDate
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: departureStartDate
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: stayOnStartDate
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: createdOnStartDate
        in: query
        required: false
        description: Fetches reservations which are created on the given property business date.
        schema:
          type: string
          format: date
      - name: expectedArrivalEndTime
        in: query
        required: false
        description: The ending value of the time span. Uses the hotel's time zone.
        schema:
          type: string
          format: date-time
      - name: expectedArrivalStartTime
        in: query
        required: false
        description: The starting value of the time span. Uses the hotel's time zone.
        schema:
          type: string
          format: date-time
      - name: depositDueEndDate
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: depositDueStartDate
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: expectedReturnEndTime
        in: query
        required: false
        description: The ending value of the time span. Uses the hotel's time zone.
        schema:
          type: string
          format: date-time
      - name: expectedReturnStartTime
        in: query
        required: false
        description: The starting value of the time span. Uses the hotel's time zone.
        schema:
          type: string
          format: date-time
      - name: companyNames
        in: query
        description: Attached profile name
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: sourceNames
        in: query
        description: Attached profile name
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: travelAgentNames
        in: query
        description: Attached profile name
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: groupNames
        in: query
        description: Attached profile name
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: travelAgentIds
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. API expects CompanyName Query parameter along with the ID to obtain correct results.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: companyIds
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. API expects CompanyName Query parameter along with the ID to obtain correct results.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: sourceIds
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. API expects CompanyName Query parameter along with the ID to obtain correct results.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: contactIds
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. API expects CompanyName Query parameter along with the ID to obtain correct results.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: groupIds
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. API expects CompanyName Query parameter along with the ID to obtain correct results.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: billingContactIds
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. API expects CompanyName Query parameter along with the ID to obtain correct results.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: profileId
        in: query
        required: false
        description: Unique Identifier for a guest profile associated with the reservation(s)
        schema:
          type: string
      - name: commissionPaid
        in: query
        required: false
        description: Commission Paid criteria
        schema:
          type: boolean
      - name: vouchersGenerated
        in: query
        required: false
        description: All reservations with generated vouchers to be returned if vouchersGenerated is set to true. All reservations without the generated vouchers to be returned if it is set to false.
        schema:
          type: boolean
      - name: membershipCardNumber
        in: query
        required: false
        description: Membership ID criteria.
        schema:
          type: string
      - name: membershipLevels
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: membershipTypes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: reservationsWithMembershipType
        in: query
        required: false
        description: When set to true, only reservations with a membership belonging to the specified membership type will be returned
        schema:
          type: boolean
      - name: surname
        in: query
        required: false
        description: Family name, last name.
        schema:
          type: string
      - name: givenName
        in: query
        required: false
        description: Given name, first name or names
        schema:
          type: string
      - name: fromName
        in: query
        required: false
        description: Given name, first name or names
        schema:
          type: string
      - name: toName
        in: query
        required: false
        description: Given name, first name or names
        schema:
          type: string
      - name: anyVIPStatus
        in: query
        required: false
        description: VIP status of the customer.
        schema:
          type: boolean
      - name: vipCodes
        in: query
        description: VIP status of the customer.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: guaranteeCode
        in: query
        required: false
        description: Fetches the reservation having Guarantee Code(Reservation Type) supplied here.
        schema:
          type: string
      - name: paymentMethod
        in: query
        required: false
        description: Fetches the reservation having method of payment supplied here.
        schema:
          type: string
      - name: discountApplied
        in: query
        required: false
        description: Fetches the reservation for which discount is applied
        schema:
          type: boolean
          default: false
      - name: user
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: createdBy
        in: query
        required: false
        description: Fetches reservation created by specified user. If both CreatedByUsers and CreatedBy is specified, CreatedByUsers will take precedence.
        schema:
          type: string
      - name: cancelledByList
        in: query
        description: Fetches reservations cancelled by list of users.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: cancelledOn
        in: query
        required: false
        description: Fetches reservations which are cancelled on the given property business date.
        schema:
          type: string
          format: date
      - name: ratePlanCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: sourceCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: marketCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: excludeBlockReservations
        in: query
        required: false
        description: If true the search result will exclude the blocks reservations.
        schema:
          type: boolean
      - name: blockCriteriaHotelCode
        in: query
        required: false
        description: The Hotel Code of the Block.
        schema:
          type: string
      - name: blockName
        in: query
        required: false
        description: The Name of the block that is attached to the reservation.
        schema:
          type: string
      - name: blockIds
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: blockCodes
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: customReference
        in: query
        required: false
        description: Custom reference
        schema:
          type: string
      - name: recordLocator
        in: query
        required: false
        description: GDS Record Locator for reservation.
        schema:
          type: string
      - name: orderBy
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Nights
            - ArrivalDate
            - ArrivalDateETR
            - DepartureDate
            - GuestSurname
            - RateAmount
            - RateCode
            - Room
            - RoomType
            - QueuePriority
            - QueueDurationTime
      - name: sortOrder
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Asc
            - Desc
          default:
          - Asc
          uniqueItems: true
      - name: roomAssignedOnly
        in: query
        required: false
        description: Indicator to query reservations which have a room number assigned.
        schema:
          type: boolean
      - name: roomUnassignedOnly
        in: query
        required: false
        description: Indicator to query reservations which does not have a room number assigned.
        schema:
          type: boolean
      - name: roomId
        in: query
        required: false
        description: Room number of the reservation to search by.
        schema:
          type: string
      - name: roomType
        in: query
        required: false
        description: Room Type.
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomFeatures
        in: query
        description: A code representing a room feature.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: roomSpecials
        in: query
        description: Preference value for display purposes.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: roomSmokingPreference
        in: query
        required: false
        description: Preference value for display purposes.
        schema:
          type: string
      - name: roomFloorPreferences
        in: query
        description: Preference value for display purposes.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: housekeepingRoomStatuses
        in: query
        description: Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Clean
            - Dirty
            - Pickup
            - Inspected
            - OutOfOrder
            - OutOfService
          uniqueItems: true
      - name: roomClasses
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomRangeFrom
        in: query
        required: false
        schema:
          type: string
      - name: roomRangeTo
        in: query
        required: false
        schema:
          type: string
      - name: communication
        in: query
        required: false
        description: Any communication attached to the reservation from the primary guest's profile such as phone, fax or email address.
        schema:
          type: string
      - name: phone
        in: query
        required: false
        description: The phone number attached to the reservation from the primary guest's profile.
        schema:
          type: string
      - name: email
        in: query
        required: false
        description: The email address attached to the reservation from the primary guest's profile.
        schema:
          type: string
      - name: profileExternalReferencesToFetch
        in: query
        description: Define the external system(s) to return external reference ids for associated profiles for the reservation. A maximum of 10 different external systems can be be provided for this parameter.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 10
      - name: resvExternalReferencesToFetch
        in: query
        description: Define the external system(s) to return external reference ids for reservations. A maximum of 10 different external systems can be be provided for this parameter.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 10
      - name: fetchInstructions
        in: query
        description: Instruction on which elements of the reservation are to be fetched. Instructions are cumulative i.e. additional elements would be added, but not duplicated.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Reservation
            - ReservationID
            - Indicators
            - Deposits
            - RevenuesAndBalances
            - GuestServiceStatus
            - MasterInfo
            - CancellationInfo
            - BlockReservations
            - TaxType
            - GuestDeviceNotification
            - RoomAssignedByAI
            - SwapShiftRooms
            - ReservationPreferences
            - FiscalInfo
            - CommissionsInfo
            - DepartureReservationInfo
            - MultipleMemberships
            - FetchChildAges
            - OffshoreRates
            - PostingIntervals
            - PreArrivals
          uniqueItems: true
      - name: allowedReservationActions
        in: query
        description: Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Cancel
            - Move
            - PreCharge
            - PostCharge
            - FacilitySchedule
            - Upsell
            - PreCheckIn
            - PostToNoShowCancel
            - NoShow
            - NameChange
            - Discount
            - HouseKeeping
            - EnrollToPrimaryMembership
            - EnrollInProgress
            - MemberAwardAttached
          uniqueItems: true
      - name: allowPreRegistration
        in: query
        required: false
        description: Flag containing true or false value for reservation to be eligible for prior check in by guest using mobile device. Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile check in yes / no. Upon fetch, the current state of the flag will show true or false.
        schema:
          type: boolean
      - name: excludeNoPost
        in: query
        required: false
        description: Indicates that reservations with No Post flag should not be expected from the result.
        schema:
          type: boolean
      - name: excludePMRooms
        in: query
        required: false
        description: Indicates that reservations with PM room type should not be expected from the result.
        schema:
          type: boolean
      - name: hasDepositBalance
        in: query
        required: false
        description: Indicates that only reservations with deposit balance should be expected from the result.
        schema:
          type: boolean
      - name: hasOpenBalance
        in: query
        required: false
        description: Indicates that only reservations with open balance should be expected from the result.
        schema:
          type: boolean
      - name: hasOpenFolio
        in: query
        required: false
        description: Indicates that only reservations with open folio should be expected from the result.
        schema:
          type: boolean
      - name: includeScheduledCheckOut
        in: query
        required: false
        description: Criteria that indicates whether to scheduled checkouts or not.
        schema:
          type: boolean
      - name: linkedOnly
        in: query
        required: false
        description: Indicates that only linked reservations should be expected from the result.
        schema:
          type: boolean
      - name: unlinkedOnly
        in: query
        required: false
        description: Indicates that only unlinked reservations should be expected from the result.
        schema:
          type: boolean
      - name: actualArrivals
        in: query
        required: false
        description: Indicates if reservations which have already arrived on the Search Date is required.
        schema:
          type: boolean
      - name: actualDepartures
        in: query
        required: false
        description: Indicates if reservations which were expected to depart on the Search Date and have already checked, is required.
        schema:
          type: boolean
      - name: complimentaryReservations
        in: query
        required: false
        description: Indicates if reservations where rate codes are marked as Complimentary Rates , is required. This flag should be used in conjunction with the Arrivals, Departures or StayOvers criteria.
        schema:
          type: boolean
      - name: dayOfArrivalCancels
        in: query
        required: false
        description: Indicates if reservations which have cancelled on the Search Date which is also the day of arrival is required.
        schema:
          type: boolean
      - name: dayUse
        in: query
        required: false
        description: Indicates if reservations which are day use reservation on the Search Date, is required.
        schema:
          t

# --- truncated at 32 KB (1697 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-reservation-api-openapi.yml