openapi: 3.2.0
info:
  title: OPERA Cloud Distribution Reservation Notification API
  description: OPERA Cloud Distribution Reservation Notifications API allows authorized channel partners to create and update reservations for any active property in Oracle Hospitality Distribution (regardless if the property is using OPERA Cloud / OPERA V5 / on-premise PMS Versions). This API is meant to transmit reservations already created and committed in the channel external system and does not perform any Pricing and Availability validation.<br /><br /> Compatible with OPERA Cloud release 26.2.0.0<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2026 Oracle and/or its affiliates.</p>
  version: 26.2.0.0
  termsOfService: https://www.oracle.com/legal/terms.html
  contact:
    email: hospitality_apis_ww_grp@oracle.com
  license:
    name: UPL
    url: https://opensource.org/licenses/upl
servers:
- url: /resnotif/v1
tags:
- name: Reservation Notification
  description: Reservation Notification API operations allow a channel to deliver, modify and cancel a reservation created and already confirmed from an external system (for example an OTA).<br/> It is usually used in conjunction with OPERA Cloud Distribution ARI Publication that allows channel partners to receive ARI information from the property.<br/> For these operations, API will perform minimal technical validations as reservation details are already committed to the guests in the originating external system.
paths:
  /hotels/{hotelCode}/reservations:
    post:
      summary: Notify of new reservation
      operationId: postReservationNotif
      description: <p>Deliver a new reservation from an external system.</p> <p><strong>OperationId:</strong>postReservationNotif</p>
      tags:
      - Reservation Notification
      parameters:
      - $ref: '#/components/parameters/hotelCodePath'
      - $ref: '#/components/parameters/x-tracing-key'
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/channelCodeHeader'
      - $ref: '#/components/parameters/appKey'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      responses:
        '200':
          description: Ok
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/Response'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/BookingNotificationType'
        required: true
  /hotels/{hotelCode}/reservations/{confirmationNum}:
    get:
      summary: Get a reservation
      operationId: getReservationNotif
      description: <p>Get a reservation</p> <p><strong>OperationId:</strong>getReservationNotif</p>
      tags:
      - Reservation Notification
      parameters:
      - $ref: '#/components/parameters/hotelCodePath'
      - $ref: '#/components/parameters/confirmationNumberPath'
      - $ref: '#/components/parameters/x-tracing-key'
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/channelCodeHeader'
      - $ref: '#/components/parameters/appKey'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      responses:
        '200':
          description: Ok
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/GetResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
    put:
      summary: Notify of modified reservation
      operationId: putReservationNotif
      description: <p>Deliver a modification of reservation from an external system.</p> <p><strong>OperationId:</strong>putReservationNotif</p>
      tags:
      - Reservation Notification
      parameters:
      - $ref: '#/components/parameters/hotelCodePath'
      - $ref: '#/components/parameters/confirmationNumberPath'
      - $ref: '#/components/parameters/x-tracing-key'
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/channelCodeHeader'
      - $ref: '#/components/parameters/appKey'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      responses:
        '200':
          description: Ok
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/Response'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/BookingNotificationType'
        required: true
  /hotels/{hotelCode}/reservations/{confirmationNum}/cancellations:
    post:
      summary: Notify of cancelled reservation
      operationId: postCancelReservationNotif
      description: <p>Deliver a cancellation of reservation from an external system.</p> <p><strong>OperationId:</strong>postCancelReservationNotif</p>
      tags:
      - Reservation Notification
      parameters:
      - $ref: '#/components/parameters/hotelCodePath'
      - $ref: '#/components/parameters/confirmationNumberPath'
      - $ref: '#/components/parameters/x-tracing-key'
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/channelCodeHeader'
      - $ref: '#/components/parameters/appKey'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      responses:
        '200':
          description: Ok
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/CancelResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '413':
          $ref: '#/components/responses/413'
        '414':
          $ref: '#/components/responses/414'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        '502':
          $ref: '#/components/responses/502'
        '503':
          $ref: '#/components/responses/503'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/CancelNotificationType'
        required: true
components:
  schemas:
    ProfileType:
      type: string
      enum:
      - Guest
      - TravelAgent
      - Source
      - Company
      example: Guest
      description: The type of profile being sent
    ReservationMembership:
      type: object
      description: Details of the membership added to the reservation.
      properties:
        membershipLevel:
          type: string
          example: ENTRY
          description: Code that designates this membership level.
        membershipId:
          type: string
          example: O12345F
          description: The guest's membership ID number
        membershipType:
          type: string
          example: MF
          description: The membership type belonging to the program the guest is enrolled with
      required:
      - membershipId
    ReservationGuestRequest:
      type: object
      description: Reservation Guest Information
      properties:
        profileInfo:
          type: object
          properties:
            profileIdList:
              $ref: '#/components/schemas/ProfileIdListRequest'
            profile:
              $ref: '#/components/schemas/Profile'
          required:
          - profile
        primary:
          type: boolean
          example: true
          description: Indicates if the profile is primary if multiple profiles of the same type are being sent. Should be true by default if only one profile of same type is sent
        arrivalTransport:
          description: Arrival Transport details of the Guest
          $ref: '#/components/schemas/ReservationTransport'
        departureTransport:
          description: Departure Transport details of the Guest
          $ref: '#/components/schemas/ReservationTransport'
      required:
      - profileInfo
    ReservationIdResponse:
      type: object
      properties:
        id:
          type: string
          description: Global reservation number from external channel. Maximum length is 50 alphanumeric characters without spaces.
          example: '5030863'
        type:
          type: string
          description: Type of id
          enum:
          - Others
          - Confirmation
          - Reservation
          example: Others
        idContext:
          type: string
          description: Context of the Id.
          example: CH1
        idExtension:
          type: string
          description: This is the index number for multi leg reservations. Numeric values only.
          example: '1'
    ReservationPayload:
      type: object
      properties:
        lastModifyDateTime:
          type: string
          format: date-time
          description: 'Date and time when this reservation was last updated, including time zone information. Timestamp as defined in ISO 8601 format and always be in the following format: YYYY-MM-DDThh:mm:ssZ (time is UTC).'
          example: '2023-11-17T12:21:00Z'
        roomStay:
          description: List of room stay information including Room Rates, Promotion, Guest Counts and Guarantee
          $ref: '#/components/schemas/RoomStayResponse'
        reservationGuests:
          type: array
          items:
            $ref: '#/components/schemas/ReservationGuestResponse'
          example:
          - profileInfo:
              profile:
                customer:
                  personName:
                  - surname: Smith
                    givenName: Mary
                    middleName: Angel
                    nameTitle: Mr and Mrs
                    nameType: Primary
                    email: customer@example.com
                    phoneNumber: 415.555.0100
                    address:
                      addressLine:
                      - Street 7031 Columbia Gateway Dr.
                      cityName: Columbia
                      postalCode: '21046'
                      country:
                        code: US
                      state: MD
                  language: en-us
                profileType: Guest
            primary: true
            arrivalTransport:
              comments: Comments Area
              type: adf
              transportCode: XXXX
              carrierCode: XXXX
              stationCode: XXXX
              dateTime: '2023-09-17T12:21:00.000Z'
              transportationReqd: true
            departureTransport:
              comments: Comments Area
              type: adf
              transportCode: XXXX
              carrierCode: XXXX
              stationCode: XXXX
              dateTime: '2023-09-17T12:21:00.000Z'
              transportationReqd: true
          - profileInfo:
              profileIdList:
              - id: '12345671'
                idContext: Central
                type: TravelAgent
              profile:
                profileType: TravelAgent
                companyInfo:
                  companyName: Smith Travel
                  email: customer@example.com
                  phoneNumber: 415.555.0100
                  address:
                    addressLine:
                    - Street 7031 Columbia Gateway Dr.
                    cityName: Columbia
                    postalCode: '21046'
                    country:
                      code: US
                    state: MD
            primary: true
          - profileInfo:
              profileIdList:
              - id: '12345672'
                idContext: Central
                type: Source
              profile:
                profileType: Source
                companyInfo:
                  companyName: Smith Travel POS
                  email: customer@example.com
                  phoneNumber: 415.555.0100
                  address:
                    addressLine:
                    - Street 7031 Columbia Gateway Dr.
                    cityName: Columbia
                    postalCode: '21046'
                    country:
                      code: US
                    state: MD
            primary: true
          - profileInfo:
              profileIdList:
              - id: ''
                idContext: Central
                type: Company
              profile:
                profileType: Company
                companyInfo:
                  companyName: Oracle Corporation
                  email: customer@example.com
                  phoneNumber: 415.555.0100
                  address:
                    addressLine:
                    - Street 7031 Columbia Gateway Dr.
                    cityName: Columbia
                    postalCode: '21046'
                    country:
                      code: US
                    state: MD
              primary: true
        reservationPaymentMethods:
          description: Reservation Payment Method details including payment Card details.
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/PaymentMethod'
        reservationSpecialRequests:
          type: array
          items:
            $ref: '#/components/schemas/ReservationSpecialRequestsResponse'
        reservationPackages:
          description: Details of the Packages added to the reservation.
          type: array
          items:
            $ref: '#/components/schemas/ReservationPackages'
        reservationMemberships:
          type: array
          items:
            $ref: '#/components/schemas/ReservationMembership'
        hotelCode:
          description: The unique identifier of the Property in Channel system.
          type: string
          example: XUSXXYY99
        comments:
          description: Comments associated to the Reservation
          type: array
          items:
            type: object
            properties:
              comment:
                $ref: '#/components/schemas/CommentType'
        reservationStatus:
          type: string
          enum:
          - Reserved
          - ReservedChanged
          - Cancelled
          - OnHold
          example: Reserved
        printRate:
          type: boolean
          description: Defines if the rate is printed on various correspondence. Possible values are 'true' or 'false'.
          example: false
        optedForCommunication:
          type: boolean
          description: Defines if guest agreed to receive correspondence from the property via email, phone, letter, etc. Possible values are 'true' or 'false'.
          example: false
        travelPurpose:
          description: Indicates the purpose of Guest Stay
          type: string
          enum:
          - Leisure
          - Business
      required:
      - roomStay
      - reservationGuests
      - reservationPaymentMethods
    RoomRateResponseGet:
      type: object
      description: The room rate response object for get
      allOf:
      - $ref: '#/components/schemas/InfoRoomRateResponse'
      - type: object
        properties:
          ratePlanInfo:
            type: object
            properties:
              ratePlanType:
                type: string
                description: The rate plan type associated with the rate plan.
                example: 12
              ratePlanName:
                type: string
                description: The name of the rate plan.
                example: Flexible Room Only Rate
              ratePlanLevel:
                type: string
                description: The rate level the rate plan is associated to.
              ratePlanCategory:
                type: string
                description: The rate category the rate plan is associated to.
              identificationRequired:
                type: boolean
                description: Indicates if an ID is required during the Check-In for this rate booking
              gdsDescription:
                $ref: '#/components/schemas/GdsDescription'
              mealPlan:
                description: Type of meal plan the rate plan includes
                type: object
                $ref: '#/components/schemas/MealPlan'
    CancelReservationNotification:
      type: object
      properties:
        reservationIdList:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/ReservationIdNotification'
        lastModifyDateTime:
          type: string
          format: date-time
          description: 'Date and time when this reservation was last updated, including time zone information. Timestamp as defined in ISO 8601 format and always be in the following format: YYYY-MM-DDThh:mm:ssZ (time is UTC).'
          example: '2023-11-17T12:21:00Z'
        hotelCode:
          description: The unique identifier of the Property in Channel system.
          type: string
          example: XUSXXYY99
        messageId:
          description: Reservation Message Number generated by the requester.
          type: string
          example: '22922909'
      required:
      - reservationIdList
    PaymentCard:
      type: object
      properties:
        cardType:
          description: Type of the Credit Card
          type: string
          example: MC
        cardNumber:
          description: Full Card Number or the Card Token
          type: string
          example: '5105105105105100'
        expirationDate:
          description: Expiration date in format MM/YY
          type: string
          pattern: ^((?:0[1-9]|1[0-2])\/([0-9][0-9])|(?:\d{4})-(?:0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]))$
          example: 06/23
        cardHolderName:
          description: Credit card holder name
          type: string
          example: Mary Smith
        cardNumberMasked:
          description: Masked card number.
          example: XXXXXXXXXXXX0005
          type: string
          minLength: 0
          maxLength: 80
        cardOrToken:
          description: This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates cardNumber holds token value and 'CardNumber' indicates cardNumber holds credit card number.
          type: string
          enum:
          - CardNumber
          - Token
        citId:
          type: string
          description: Customer Initiated Transaction(CIT) Id for Credit Cards. This is only used when PAYMENT SERVICES DIRECTIVE (PSD2) Opera Control is active.
          minLength: 0
          maxLength: 16
          example: 654321ABC1234578
      required:
      - cardType
      - cardNumber
      - expirationDate
      - cardHolderName
    ReservationPayloadGet:
      type: object
      properties:
        lastModifyDateTime:
          type: string
          format: date-time
          description: 'Date and time when this reservation was last updated, including time zone information. Timestamp as defined in ISO 8601 format and always be in the following format: YYYY-MM-DDThh:mm:ssZ (time is UTC).'
          example: '2023-11-17T12:21:00Z'
        roomStay:
          description: List of room stay information including Room Rates, Promotion, Guest Counts and Guarantee
          $ref: '#/components/schemas/RoomStayResponseGet'
        reservationGuests:
          type: array
          items:
            $ref: '#/components/schemas/ReservationGuestResponse'
          example:
          - profileInfo:
              profile:
                customer:
                  personName:
                  - surname: Smith
                    givenName: Mary
                    nameTitle: Mr and Mrs
                    middleName: Angel
                    nameType: Primary
                    email: customer@example.com
                    phoneNumber: 415.555.0100
                    address:
                      addressLine:
                      - Street 7031 Columbia Gateway Dr.
                      cityName: Columbia
                      postalCode: '21046'
                      country:
                        code: US
                      state: MD
                  language: en-us
                profileType: Guest
            primary: true
            arrivalTransport:
              comments: Comments Area
              type: adf
              transportCode: XXXX
              carrierCode: XXXX
              stationCode: XXXX
              dateTime: '2023-09-17T12:21:00.000Z'
              transportationReqd: true
            departureTransport:
              comments: Comments Area
              type: adf
              transportCode: XXXX
              carrierCode: XXXX
              stationCode: XXXX
              dateTime: '2023-09-17T12:21:00.000Z'
              transportationReqd: true
          - profileInfo:
              profileIdList:
              - id: '12345671'
                idContext: Central
                type: TravelAgent
              profile:
                profileType: TravelAgent
                companyInfo:
                  companyName: Smith Travel
                  email: customer@example.com
                  phoneNumber: 415.555.0100
                  address:
                    addressLine:
                    - Street 7031 Columbia Gateway Dr.
                    cityName: Columbia
                    postalCode: '21046'
                    country:
                      code: US
                    state: MD
            primary: true
          - profileInfo:
              profileIdList:
              - id: '12345672'
                idContext: Central
                type: Source
              profile:
                profileType: Source
                companyInfo:
                  companyName: Smith Travel POS
                  email: customer@example.com
                  phoneNumber: 415.555.0100
                  address:
                    addressLine:
                    - Street 7031 Columbia Gateway Dr.
                    cityName: Columbia
                    postalCode: '21046'
                    country:
                      code: US
                    state: MD
            primary: true
          - profileInfo:
              profileIdList:
              - id: ''
                idContext: Central
                type: Company
              profile:
                profileType: Company
                companyInfo:
                  companyName: Oracle Corporation
                  email: customer@example.com
                  phoneNumber: 415.555.0100
                  address:
                    addressLine:
                    - Street 7031 Columbia Gateway Dr.
                    cityName: Columbia
                    postalCode: '21046'
                    country:
                      code: US
                    state: MD
              primary: true
        reservationPaymentMethods:
          description: Reservation Payment Method details including payment Card details.
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/PaymentMethod'
        reservationSpecialRequests:
          type: array
          items:
            $ref: '#/components/schemas/ReservationSpecialRequestsResponse'
        reservationPackages:
          description: Details of the Packages added to the reservation.
          type: array
          items:
            $ref: '#/components/schemas/ReservationPackages'
        reservationMemberships:
          type: array
          items:
            $ref: '#/components/schemas/ReservationMembership'
        hotelCode:
          description: The unique identifier of the Property in Channel system.
          type: string
          example: XUSXXYY99
        comments:
          type: array
          description: Comments associated to the Reservation
          items:
            type: object
            properties:
              comment:
                $ref: '#/components/schemas/CommentType'
        reservationStatus:
          type: string
          enum:
          - Reserved
          - ReservedChanged
          - Cancelled
          - OnHold
          example: Reserved
        printRate:
          type: boolean
          description: Defines if the rate is printed on various correspondence. Possible values are 'true' or 'false'.
          example: false
        optedForCommunication:
          type: boolean
          description: Defines if guest agreed to receive correspondence from the property via email, phone, letter, etc. Possible values are 'true' or 'false'.
          example: false
        travelPurpose:
          description: Indicates the purpose of Guest Stay
          type: string
          enum:
          - Leisure
          - Business
      required:
      - roomStay
      - reservationGuests
      - reservationPaymentMethods
    GetResponseItem:
      type: object
      properties:
        reservationIds:
          type: array
          items:
            $ref: '#/components/schemas/CancelReservationIdResponse'
          example:
          - id: '5030863'
            type: Others
            idContext: CH1
            idExtension: '1'
          - id: LZDI6496738895
            type: Confirmation
            idContext: Central
            idExtension: '1'
          - id: '2342342'
            type: Reservation
            idContext: Central
            idExtension: '1'
        reservationPayload:
          $ref: '#/components/schemas/ReservationPayloadGet'
        creationDate:
          type: string
          description: 'Date and time when this reservation was created, including time zone information. Timestamp as defined in ISO 8601 format and always be in the following format: YYYY-MM-DDThh:mm:ssZ (time is UTC).'
          format: date-time
          example: '2023-11-17T12:21:00Z'
      required:
      - reservationIds
      - reservationPayload
    GuestCount:
      type: object
      description: Reservation Guest Count details in room Stay level
      properties:
        childAges:
          description: Ages of children
          type: array
          items:
            type: integer
            format: int32
          example:
          - 4
          - 9
          - 17
        adults:
          description: Number of adults
          type: integer
          format: int32
          example: 2
        children:
          description: Number of children
          type: integer
          format: int32
          example: 3
      required:
      - adults
    BlockIdList:
      type: object
      properties:
        id:
          description: Unique OPERA Block ID which is a primary identification of a Block in OPERA.
          type: string
          maxLength: 40
          example: ABCEVENT0523
        type:
          description: Type of the Block Id. Valid value 'BlockCode'
          type: string
          enum:
          - BlockCode
    ProfileIdListRequest:
      type: array
      items:
        type: object
        properties:
          id:
            type: string
            description: The unique ID associated with that profile
          idContext:
            type: string
            example: Central
            description: 'The Context of the ID sent above. Possible Values : Central'
          type:
            type: string
            description: 'The type of profile being sent Possible Values : Guest, TravelAgent, Source, Company'
    CancelResponseItem:
      type: object
      properties:
        reservationIds:
          type: array
          items:
            $ref: '#/components/schemas/CancelReservationIdResponse'
          example:
          - id: '5030863'
            type: Others
            idContext: CH1
            idExtension: '1'
          - id: LZDI6496738895
            type: Confirmation
            idContext: Central
            idExtension: '1'
          - id: '2342342'
            type: Reservation
            idContext: Central
            idExtension: '1'
          - id: YMWSGD-1631707751742-8812771
            type: Cancellation
            idContext: Central
            idExtension: '1'
        reservationPayload:
          type: object
          properties:
            lastModifyDateTime:
              type: string
              format: date-time
              description: 'Date and time when this reservation was last updated, including time zone information. Timestamp as defined in ISO 8601 format and always be in the following format: YYYY-MM-DDThh:mm:ssZ (time is UTC).'
              example: '2023-11-17T12:21:00Z'
            hotelCode:
              description: The unique identifier of the Property in Channel system.
              type: string
              example: XUSXXYY99
            reservationStatus:
              type: string
              enum:
              - Reserved
              - ReservedChanged
              - Cancelled
              - OnHold
              example: Cancelled
          required:
          - reservationStatus
      required:
      - reservationIds
      - reservationPayload
    ExceptionObj:
      type: object
      properties:
        logId:
          type: integer
          example: 884366973
        title:
          type: string
          description: Short, human-readable summary of the problem.  The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization.
          example: Error Occurred During Reservation Processing
        status:
          type: integer
          description: HTTP status code for this occurrence of the problem, set by the origin server.
          example: 400
        o.errorCode:
          type: string
          description: HDP error code, which is different from HTTP error code.
          example: DRSC10000
        type:
          type: string
          description: Absolute URI [RFC3986] that identifies the problem type.  When dereferenced, it SHOULD provide a human-readable summary of the problem.
          example: http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.x
        timestamp:
          type: string
          example: '2023-09-17T08:17:18.321Z'
          format: date-time
        o.errorDetails:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetailsObj'
      required:
      - logId
      - title
      - status
    RequestCodesResponse:
      type: object
      properties:
        requestCodeValue:
          description: Special request code from OHD configuration
          example: PILLOW
          type: string
          minLength: 0
          maxLength: 200
        requestCodeDescription:
          description: Special request's description or name.
          example: Additional Pillows
          type: string
          minLength: 0
          maxLength: 2000
    ReservationTransport:
      type: object
      properties:
        comments:
          type: string
          minLength: 0
          maxLength: 2000
          description: Any additional info regarding the travel can be sent here
        type:
          type: string
          minLength: 0
          maxLength: 20
          description: 'Method of conveyance of the guest. For Ex : Air, Rail, Bus, Private Auto, Boat, Other'
        transportCode:
          type: string
          minLength: 0
          maxLength: 20
          description: Enter the transportation Code such as the airline flight number/city of origin applicable to the guest mode of transportation upon arrival. For example Flight 1660
        carrierCode:
          type: string
          minLength: 0
          maxLength: 20
          description: Enter the code associated with the air, rail, bus or car rental transport company being used by this guest at arrival; for example, Delta, Amtrak, Greyhound, Avis.
        stationCode:
          type: string
          minLength: 0
          maxLength: 20
          description: Enter the code for the airport, bus station or other location of the guest arrival; for example, JFK International, Penn Station, Port Authority Bus Terminal.
        dateTime:
          type: string
          format: date-time
          description: Enter the expected time here
        transportationReqd:
          type: boolean
          description: Indicates if transportation is required or not
    RoomStayResponse:
      type: object
      description: List of room stay information including Room Rates, Promotion, Guest Counts and Guarantee
      properties:
        arrivalDate:
          type: string
          format: date
          description: Arrival Date of the Reservation. Value must be of format YYYY-MM-DD
          example: '2024-05-16'
        departureDate:
          type: string
          format: date
          description: Departure Date of the Reservation. Value must be of format YYYY-MM-DD
          example: '2024-05-17'
        roomRates:
          type: array
          description: Room Rate Information
          minItems: 1
          items:
            $ref: '#/components/schemas/InfoRoomRateResponse'
        promotion:
          $ref: '#/components/schemas/Promotion'
        guestCounts:
          type: object
          description: Guest Counts details of the reservation.
          properties:
            adults:
              type: integer
              format: int32
              description: Adults count
              example: 2
            children:
              type: integer
              format: int32
              description: Children count
              example: 3
            childAges:
              description: Ages of children
              type: array
              items:
                type: integer
                format: int32
              example:
              - 4
              - 9
              - 17
          required:
          - adults
        total:
          type: object
          description: 'Reservation Total Rate Information

            * If the rate plan is configured as Tax Inclusive, Amount After Tax is returned.

            * If the rate Plan is configured as Tax Exclusive, Amount Before Tax is returned.

            '
          properties:
            taxes:
              type: object
              description: Total Tax details applicable for this reservation
              $ref: '#/components/schemas/Taxes'
            currencySymbol:
              type: string
              description: Symbol of Rate Currency.
              example: $
            decimalPlaces:
              type: integer
              format: int32
              description: Rate Amount decimal Places.
              example: 1
            rateOverride:
              type: boolean
              description: Indicated if the rate is overridden or not.
              example: true
            amountAfterTax:
              type: number
              example: 214.5
              description: Reservation Total Rate including all known taxes, fees and surcharges.
            amountBeforeTax:
              type: number
              description: Reservation Total Rate excluding all known taxes, fees and surcharges.
              example: 200
            currencyCode:
              $ref: '#/components/schemas/CurrencyCode'
        guarantee:
          type: object
          description: Reservation guarantee details.
          properties:
            guaranteeCode:
              type: string
              example: CC
              description: 'Accepts Property Guarantee Code.

                Either of guaranteeCode or guaranteeType should be provided.

                If no guaranteeCode and no guaranteeType is provided the reservation will be created as Non Guaranteed (OTA Code : 38). Both guaranteeType and guaranteeCode should not be sent in a single reservation request; if sent the reservation would be rejected.

                '
            guaranteeType:
              type: string
              example: '5'
              description: 'Accepts OTA Standard Guarantee Type.

                Possible Values : (5, 8, 19, 22, 38) where 5 = Credit Card, 8 = Deposit, 19 = Travel agency IATA number, 22 = Frequent guest, 30 = Corporate ID/CD Number, 38 = None.

                Either of guaranteeCode or guaranteeType should be provided.

                If no guaranteeType and no guaranteeCode is provided the reservation will be created as Non Guaranteed (OTA Code : 38). Both guaranteeType and guaranteeCode should not be sent in a single reservation request; if sent the reservation would be rejected.

                '
            onHold:
              type: boolean
              example: false
              description: If true indicates this Guarantee Code is used only to hold the inventory during reservation process.
        printRate:
          type: boolean
          description: Defines if the rate is printed on various correspondence. Possible values are 'true' or 'false'.
          example: false
        expectedTimes:
          description: Expected Arrival and Departure Time information.
          $ref: '#/components/schemas/ExpectedTimesType'
        bookingMedium:
          description: Indicates the Origin of the reservation
          type: string
          minLength: 1
          maxLength: 20
          example: OTA
      required:
      - arrivalDate
      - departureDate
      - roomRates
    CommentType:
      type: object
      properties:
        text:
          type: object
          description: Comment Free Text
          properties:
            value:
              type: string
              example: Room away from the elevator.
        commentTitle:
          description: Title of the Comment
          type: string
          example: Notes from Channel
        internal:
          description: When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer. Possible values are 'true' or 'false'. Default value is false
          type: boolean
          example: false
    Promotion:
      type: object
      description: Details of Promotion attached to the reservation.
      properties:
        promotionCode:
          type: string
          minLength: 0
          maxLength: 20
          description: Promotion code associated with the promotional offers.
          example: CASINO
        promotionName:
          type: string
          minLength: 0
          maxLength: 20
          description: Descriptive name of promotion code.
          example: Casino Promotion
    ScheduleList:
      type: object
      properties:
        consumptionDate:
          description: The date the package was used or can be used.
          type: string
          format: date
          maxLength: 8
          example: '2023-12-17'
        unitPrice:
          description: The price per unit of the package.
          type: number
          example: 50
        totalQuantity:
          description: The total quantity of the package for this date, calculated based on the calculation rule as defined in the PackageHeaderType
          type: integer
          format: int32
          example: 1
        reservationDate:
          description: The date of the Reservation when this package is applicable. This can be different from the date the package will be consumed. Example are next day packages. Reservation date is when the package is applied to the guest and Consumption date is when the guest can consume the package.
          type: string
          format: date
          maxLength: 8
          example: '2023-12-17'
    Country:
      type: object
      properties:
        code:
          type: string
          description: Supported codes for countries are ISO 3166-1 Alpha-2 values only, ie. US, not USA.
          example: US
    BookingNotificationType:
      type: object
      properties:
        reservations:
          type: array
          items:
            $ref: '#/components/schemas/SingleReservationNotification'
          minItems: 1
      required:
      - reservations
    RatePlanMealPlanType:
      type: string
      enum:
      - Breakfast
      - Lunch
      - Dinner
      - AllInclusive
      description: Type of meal plan the rate plan includes
    Response:
      type: array
      items:
        $ref: '#/components/schemas/BookingResponse'
    ErrorDetailsObj:
      type: object
      properties:
        logId:
          type: integer
          example: 443265783
        title:
          type: string
          description: Short, human-readable summary of the problem.  The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization.
          example: Reservation Id was not found
        status:
          type: integer
          description: HTTP status code for this occurrence of the problem, set by the origin server.
          example: 400
        o.errorCode:
          type: string
          description: HDP error code, which is different from HTTP error code.
          example: DRSV30007
        type:
          type: string
          description: Absolute URI [RFC3986] that identifies the problem type.  When dereferenced, it SHOULD provide a human-readable summary of the problem.
          example: http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.x
        timestamp:
          type: string
          example: '2023-09-17T08:17:18.321Z'
          format: date-time
    ReservationPackages:
      type: object
      properties:
        scheduleList:
          description: A HotelPackageSchedule type.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/ScheduleList'
        packageCode:
          type: string
          minLength: 0
          maxLength: 20
          example: SUMPKG1
          description: Package code. This is the unique code used for the package and is a required element.
        startDate:
          type: string
          format: date
          maxLength: 8
          example: '2023-06-12'
          description: Required value when changing a reservation package. If the original start date was null, then null is required.
        endDate:
          type: string
          format: date
          maxLength: 8
          example: '2023-06-14'
          description: Required value when changing a reservation package. If the original end date was null, then null is required.
        source:
          type: string
          example: Reservation
          description: Sources of Products.
    RoomRate:
      type: object
      properties:
        base:
          type: object
          description: 'Base Rate Details

            * If the rate plan is configured as Tax Inclusive, Amount After Tax is expected in reservation requests.

            * If the rate Plan is configured as Tax exclusive, Amount Before Tax is expected in reservation requests.

            '
          properties:
            amountAfterTax:
              type: number
              example: 214.5
              description: Room Rate including all known taxes, fees and surcharges.
            amountBeforeTax:
              type: number
              description: Room Rate excluding all known taxes, fees and surcharges.
              example: 200
            currencyCode:
              $ref: '#/components/schemas/CurrencyCode'
        start:
          description: 'Effective Start Date of the room rate.

            * Value must be of format ''date''

            '
          type: string
          format: date
          example: '2024-05-16'
        end:
          description: 'Effective End Date of the room rate.

            * Value must be of format ''date''

            '
          type: string
          format: date
          example: '2024-05-16'
      required:
      - start
      - end
    Profile:
      type: object
      properties:
        customer:
          type: object
          properties:
            personName:
              type: array
              minItems: 1
              items:
                $ref: '#/components/schemas/PersonName'
            language:
              type: string
              description: Reservation Language Code
              example: en-us
          required:
          - personName
        profileType:
          $ref: '#/components/schemas/ProfileType'
        companyInfo:
          type: object
          properties:
            companyName:
              type: string
              description: Name of the associated Company, Source or Travel Agent
            email:
              type: string
              description: Email of Guest
              example: customer@example.com
            phoneNumber:
              type: string
              description: Phone number of Guest
              example: 415.555.0100
            address:
              $ref: '#/components/schemas/Address'
    Taxes:
      type: object
      description: Tax details.
      properties:
        tax:
          type: array
          description: List of taxes applicable for this reservation
          minItems: 1
          items:
            $ref: '#/components/schemas/Tax'
        totalTax:
          type: number
          description: Total Taxes applicable for the reservation
          example: 23.79
        totalFees:
          type: number
          description: Total Fees applicable for the reservation
          example: 25
        amount:
          type: number
          description: Total Tax amount applicable for the reservation.
          example: 20.3
        currencyCode:
          $ref: '#/components/schemas/CurrencyCode'
        hotelTaxFeeDescriptions:
          type: array
          description: Hotel Tax / Fee Descriptions
          items:
            type: object
            properties:
              description:
                type: string
                example: 9% City Occupancy Tax
    ReservationIdNotification:
      type: object
      properties:
        id:
          type: string
          description: Global reservation number from external channel. Maximum length is 50 alphanumeric characters without spaces.
          example: '5030863'
        type:
          type: string
          description: Type of id
          enum:
          - Others
          - Confirmation
          - Reservation
          example: Others
        idContext:
          type: string
          description: Context of the Id.
          example: CH1
        idExtension:
          type: string
          description: This is the index number for multi leg reservations. Numeric values only.
          example: '1'
      required:
      - id
    Tax:
      type: object
      properties:
        description:
          type: string
          description: OTA Standard Fee Tax Type description
          example: VAT (Value Added Tax)
        type:
          type: string
          description: Indicates if this tax is included or excluded in rate.
          enum:
          - Inclusive
          - Exclusive
          example: Exclusive
        code:
          type: string
          description: OTA Standard Fee Tax Type
          example: '36'
        amount:
          type: number
          description: Total tax amount of given Fee Tax type.
          example: 10
        currencyCode:
          $ref: '#/components/schemas/CurrencyCode'
        codeType:
          type: string
          description: Classification of the code:Tax or Fee
          enum:
          - Tax
          - Fee
          example: Tax
    GdsDescription:
      type: object
      description: Multi line description of the rate plan.
      properties:
        line1:
          description: First line of rate plan description.
          type: string
          example: Room Only Rate with free wifi
        line2:
          description: Second line of rate plan description.
          type: string
          example: Continental Breakfast for additional fee
        line3:
          description: Third line of rate plan description.
          type: string
          example: Cancel anytime
        detailedDescription:
          description: Detailed information about the rate plan.
          type: string
          example: An outdoor pool is also available for guests staying at the lodge during the summertime.
    CancelResponse:
      type: array
      items:
        $ref: '#/components/schemas/CancelResponseItem'
    GetResponse:
      type: array
      items:
        $ref: '#/components/schemas/GetResponseItem'
    InfoRoomRateResponse:
      type: object
      properties:
        rates:
          type: object
          properties:
            rate:
              type: array
              minItems: 1
              items:
                $ref: '#/components/schemas/RoomRate'
          required:
          - rate
        guestCounts:
          $ref: '#/components/schemas/GuestCount'
        reservationBlock:
          type: object
          description: Block related information
          properties:
            blockIdList:
              description: List of Block Ids
              type: array
              items:
                $ref: '#/components/schemas/BlockIdList'
            blockName:
              description: Name of the Block
              type: string
              maxLength: 2000
              example: ABC Annual Meet
        roomType:
          type: string
          description: Room Type Code for which the reservation is requested for.
          example: XA1K
        ratePlanCode:
          type: string
          description: '* Rate Plan Code for which the reservation is requested.

            * Rate plan code is mandatory for Transient ( non Block) reservation requests.

            * Rate Plan Code is optional if the reservation is for a Business Block.

            '
          example: XDAILY
        roomId:
          type: string
          minLength: 0
          maxLength: 20
          description: Room Number to be assigned to the reservation.
          example: '301'
        suppressRate:
          type: boolean
          description: Used to suppress the display of the room rate in various correspondence. Possible values are 'true' or 'false'.
          example: true
        numberOfUnits:
          type: integer
          format: int32
          description: Number of rooms to be booked for this reservation
          example: 1
        marketCode:
          type: string
          description: The code that relates to the market being sold to (e.g., the corporate market, packages).
          example: BR
        sourceCode:
          type: string
          description: To specify where the business came from e.g.radio, newspaper ad, etc.
          example: OTA
        start:
          description: 'Effective Start Date of the room rate.

            * Value must be of format ''date''

            '
          type: string
          format: date
          example: '2024-05-16'
        end:
          description: 'Effective End Date of the room rate.

            * Value must be of format ''date''

            '
          type: string
          format: date
          example: '2024-05-16'
      required:
      - rates
      - guestCounts
      - roomType
      - start
      - end
    CancelNotificationType:
      type: object
      properties:
        reservations:
          type: array
          items:
            $ref: '#/components/schemas/CancelReservationNotification'
          minItems: 1
      required:
      - reservations
    PaymentMethod:
      type: object
      properties:
        paymentMethod:
          type: string
          description: 'Indicates how the payment would be done.  Possible Values : 5 (Credit Card), 1 (Cash), 2 ( Direct Bill), 3 (Voucher).'
          example: '1'
        folioView:
          type: string
          description: 'folio number for payment method (example: use 1 for guest guarantee, 2 for company/travel agent guarantee)'
          example: '1'
        paymentCard:
          $ref: '#/components/schemas/PaymentCard'
      required:
      - paymentMethod
    PersonName:
      type: object
      properties:
        givenName:
          type: string
          description: Given Name of Guest
          example: Mary
        surname:
          type: string
          description: Last Name of Guest
          minLength: 2
          example: Smith
        middleName:
          type: string
          description: Indicates the Middle Name of the Guest
          example: Mathew
        nameTitle:
          type: string
          description: Title of Guest
          example: Mr and Mrs
        nameType:
          type: string
          description: Name Type. Valid value 'Primary'
          example: Primary
        email:
          type: string
          description: Email of Guest
          example: customer@example.com
        phoneNumber:
          type: string
          description: Phone number of Guest
          example: 415.555.0100
        address:
          $ref: '#/components/schemas/Address'
      required:
      - surname
    SingleReservationNotification:
      type: object
      properties:
        reservationIdList:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/ReservationIdNotification'
        lastModifyDateTime:
          type: string
          format: date-time
          description: 'Date and time when this reservation was last updated, including time zone information. Timestamp as defined in ISO 8601 format and always be in the following format: YYYY-MM-DDThh:mm:ssZ (time is UTC).'
          example: '2023-11-17T12:21:00Z'
        roomStay:
          description: List of room stay information including Room Rates, Promotion, Guest Counts and Guarantee
          $ref: '#/components/schemas/RoomStayRequest'
        reservationGuests:
          type: array
          items:
            $ref: '#/components/schemas/ReservationGuestRequest'
          example:
          - profileInfo:
              profile:
                customer:
                  personName:
                  - surname: Smith
                    givenName: Mary
                    middleName: Angel
                    nameTitle: Mr and Mrs
                    nameType: Primary
                    email: customer@example.com
                    phoneNumber: 415.555.0100
                    address:
                      addressLine:
                      - Street 7031 Columbia Gateway Dr.
                      cityName: Columbia
                      postalCode: '21046'
                      country:
                        code: US
                      state: MD
                  language: en-us
                profileType: Guest
            primary: true
            arrivalTransport:
              comments: Comments Area
              type: adf
              transportCode: XXXX
              carrierCode: XXXX
              stationCode: XXXX
              dateTime: '2023-09-17T12:21:00.000Z'
              transportationReqd: true
            departureTransport:
              comments: Comments Area
              type: adf
              transportCode: XXXX
              carrierCode: XXXX
              stationCode: XXXX
              dateTime: '2023-09-17T12:21:00.000Z'
              transportationReqd: true
          - profileInfo:
              profileIdList:
              - id: '12345671'
                idContext: Central
                type: TravelAgent
              profile:
                profileType: TravelAgent
                companyInfo:
                  companyName: Smith Travel
                  email: customer@example.com
                  phoneNumber: 415.555.0100
                  address:
                    addressLine:
                    - Street 7031 Columbia Gateway Dr.
                    cityName: Columbia
                    postalCode: '21046'
                    country:
                      code: US
                    state: MD
            primary: true
          - profileInfo:
              profileIdList:
              - id: '12345672'
                idContext: Central
                type: Source
              profile:
                profileType: Source
                companyInfo:
                  companyName: Smith Travel POS
                  email: customer@example.com
                  phoneNumber: 415.555.0100
                  address:
                    addressLine:
                    - Street 7031 Columbia Gateway Dr.
                    cityName: Columbia
                    postalCode: '21046'
                    country:
                      code: US
                    state: MD
            primary: true
          - profileInfo:
              profileIdList:
              - id: ''
                idContext: Central
                type: Company
              profile:
                profileType: Company
                companyInfo:
                  companyName: Oracle Corporation
                  email: customer@example.com
                  phoneNumber: 415.555.0100
                  address:
                    addressLine:
                    - Street 7031 Columbia Gateway Dr.
                    cityName: Columbia
                    postalCode: '21046'
                    country:
                      code: US
                    state: MD
              primary: true
        reservationPaymentMethods:
          description: Reservation Payment Method details including payment Card details.
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/PaymentMethod'
        reservationSpecialRequests:
          type: array
          items:
            type: object
            properties:
              requestCodes:
                description: Collection of special requests such as Preferences for a reservation guest
                type: array
                items:
                  $ref: '#/components/schemas/RequestCodes'
              requestCodeType:
                type: string
                minLength: 0
                maxLength: 20
                example: SPECIALS
                description: Group code of special request such as specials, feature, bed feature, etc.
              requestCodeTypeContext:
                type: string
                description: It represents request code and request type are OHD configured values.
                enum:
                - Central
        reservationPackages:
          description: Details of the Packages added to the reservation.
          type: array
          items:
            $ref: '#/components/schemas/ReservationPackages'
        reservationMemberships:
          type: array
          items:
            $ref: '#/components/schemas/ReservationMembership'
        hotelCode:
          description: The unique identifier of the Property in Channel system.
          type: string
          example: XUSXXYY99
        messageId:
          description: Reservation Message Number generated by the requester.
          type: string
          example: '22922909'
        comments:
          description: Comments associated to the Reservation
          type: array
          items:
            type: object
            properties:
              comment:
                $ref: '#/components/schemas/CommentType'
        printRate:
          type: boolean
          description: Defines if the rate is printed on various correspondence. Possible values are 'true' or 'false'.
          example: false
        optedForCommunication:
          type: boolean
          description: Defines if guest agreed to receive correspondence from the property via email, phone, letter, etc. Possible values are 'true' or 'false'.
          example: false
        travelPurpose:
          description: Indicates the purpose of Guest Stay
          type: string
          enum:
          - Leisure
          - Business
      required:
      - reservationIdList
      - roomStay
      - reservationGuests
      - reservationPaymentMethods
    Address:
      type: object
      properties:
        addressLine:
          description: Guest Address Details
          type: array
          minItems: 1
          items:
            type: string
          example:
          - Street 7031 Columbia Gateway Dr.
        cityName:
          description: Name of the City
          type: string
          example: Columbia
        postalCode:
          description: Postal Code of the Guest Address
          type: string
          example: Z23457A9
        country:
          $ref: '#/components/schemas/Country'
        state:
          description: State Code.
          type: string
          example: MD
    CurrencyCode:
      type: string
      description: "The rate currency code. This should be ISO currency code.\n  *  Matches regex pattern: [A-Z]{3}\n  *  Length of string must be less than, or equal to 3\n  *  Length of string must be greater than, or equal to 3\n"
      example: USD
    MealPlan:
      type: object
      properties:
        mealPlanIncluded:
          description: Type of meal plan
          type: object
          $ref: '#/components/schemas/RatePlanMealPlanType'
        mealPlanCode:
          description: The meal plan code
          type: string
          example: '1'
        mealPlanDescription:
          description: The meal plan description
          type: string
          example: All inclusive meal plan
        mealsIncluded:
          description: Type of meal plan the rate plan includes
          type: array
          items:
            type: string
          example:
          - Breakfast
          - Lunch
          - Dinner
    BookingResponse:
      type: object
      properties:
        reservationIds:
          type: array
          items:
            $ref: '#/components/schemas/ReservationIdResponse'
          example:
          - id: '5030863'
            type: Others
            idContext: CH1
            idExtension: '1'
          - id: LZDI6496738895
            type: Confirmation
            idContext: Central
            idExtension: '1'
          - id: '2342342'
            type: Reservation
            idContext: Central
            idExtension: '1'
        reservationPayload:
          $ref: '#/components/schemas/ReservationPayload'
      required:
      - reservationIds
      - reservationPayload
    ExpectedTimesType:
      type: object
      description: Expected Arrival and Departure Time information.
      properties:
        reservationExpectedArrivalTime:
          description: Indicates the expected Arrival Time of the reservation guest.
          type: string
          format: date-time
          example: '2026-11-17T12:21:00.000Z'
        reservationExpectedDepartureTime:
          description: Indicates the expected Departure Time of the reservation guest.
          type: string
          format: date-time
          example: '2026-11-20T12:21:00.000Z'
    ReservationSpecialRequestsResponse:
      type: object
      properties:
        requestCodes:
          description: Collection of special requests such as Preferences for a reservation guest
          type: array
          items:
            $ref: '#/components/schemas/RequestCodesResponse'
        requestCodeType:
          type: string
          minLength: 0
          maxLength: 20
          example: SPECIALS
          description: Group code of special request such as specials, feature, bed feature, etc.
        requestCodeTypeContext:
          type: string
          description: It represents request code and request type are OHD configured values.
          enum:
          - Central
    InfoRoomRate:
      type: object
      properties:
        rates:
          type: object
          properties:
            rate:
              type: array
              minItems: 1
              items:
                $ref: '#/components/schemas/RoomRate'
          required:
          - rate
        guestCounts:
          $ref: '#/components/schemas/GuestCount'
        reservationBlock:
          type: object
          description: Block related information
          properties:
            blockIdList:
              description: List of Block Ids
              type: array
              items:
                $ref: '#/components/schemas/BlockIdList'
        roomType:
          type: string
          description: Room Type Code for which the reservation is requested for.
          example: XA1K
        ratePlanCode:
          type: string
          description: '* Rate Plan Code for which the reservation is requested.

            * Rate plan code is mandatory for Transient ( non Block) reservation requests.

            * Rate Plan Code is optional if the reservation is for a Business Block.

            '
          example: XDAILY
        roomId:
          type: string
          minLength: 0
          maxLength: 20
          description: Room Number to be assigned to the reservation.
          example: '301'
        suppressRate:
          type: boolean
          description: Used to suppress the display of the room rate in various correspondence. Possible values are 'true' or 'false'.
          example: true
        numberOfUnits:
          type: integer
          format: int32
          description: Number of rooms to be booked for this reservation
          example: 1
        marketCode:
          type: string
          description: The code that relates to the market being sold to (e.g., the corporate market, packages).
          example: BR
        sourceCode:
          type: string
          description: To specify where the business came from e.g.radio, newspaper ad, etc.
          example: OTA
        start:
          description: 'Effective Start Date of the room rate.

            * Value must be of format ''date''

            '
          type: string
          format: date
          example: '2024-05-16'
        end:
          description: 'Effective End Date of the room rate.

            * Value must be of format ''date''

            '
          type: string
          format: date
          example: '2024-05-16'
      required:
      - rates
      - guestCounts
      - roomType
      - start
      - end
    ReservationGuestResponse:
      type: object
      description: Reservation Guest Information
      properties:
        profileInfo:
          type: object
          properties:
            profileIdList:
              $ref: '#/components/schemas/ProfileIdListResponse'
            profile:
              $ref: '#/components/schemas/Profile'
          required:
          - profile
        primary:
          type: boolean
          example: true
          description: Indicates if the profile is primary if multiple profiles of the same type are being sent. Should be true by default if only one profile of same type is sent
        arrivalTransport:
          description: Arrival Transport details of the Guest
          $ref: '#/components/schemas/ReservationTransport'
        departureTransport:
          description: Departure Transport details of the Guest
          $ref: '#/components/schemas/ReservationTransport'
      required:
      - profileInfo
    RequestCodes:
      type: object
      properties:
        requestCodeValue:
          description: Special request code from OHD configuration
          example: PILLOW
          type: string
          minLength: 0
          maxLength: 200
    CancelReservationIdResponse:
      type: object
      properties:
        id:
          type: string
          description: Global reservation number from external channel. Maximum length is 50 alphanumeric characters without spaces.
          example: '5030863'
        type:
          type: string
          description: Type of id
          enum:
          - Others
          - Confirmation
          - Reservation
          - Cancellation
          example: Others
        idContext:
          type: string
          description: Context of the Id.
          example: CH1
        idExtension:
          type: string
          description: This is the index number for multi leg reservations. Numeric values only.
          example: '1'
    ProfileIdListResponse:
      type: array
      items:
        type: object
        properties:
          id:
            type: string
            description: The unique ID associated with that profile
          idContext:
            type: string
            example: Central
            description: 'The Context of the ID sent above. Possible Values : Central'
          type:
            type: string
            description: 'The type of profile being sent Possible Values : Guest, TravelAgent, Source, Company and Profile'
    RoomStayRequest:
      type: object
      description: List of room stay information including Room Rates, Promotion, Guest Counts and Guarantee
      properties:
        arrivalDate:
          type: string
          format: date
          description: Arrival Date of the Reservation. Value must be of format YYYY-MM-DD
          example: '2024-05-16'
        departureDate:
          type: string
          format: date
          description: Departure Date of the Reservation. Value must be of format YYYY-MM-DD
          example: '2024-05-17'
        roomRates:
          type: array
          description: Room Rate Information
          minItems: 1
          items:
            $ref: '#/components/schemas/InfoRoomRate'
        promotion:
          description: Details of Promotion attached to the reservation.
          type: object
          properties:
            promotionCode:
              type: string
              minLength: 0
              maxLength: 20
              description: Promotion code associated with the promotional offers.
              example: CASINO
        guestCounts:
          type: object
          description: Guest Counts details of the reservation.
          properties:
            adults:
              type: integer
              format: int32
              description: Adults count
              example: 2
            children:
              type: integer
              format: int32
              description: Children count
              example: 3
            childAges:
              description: Ages of children
              type: array
              items:
                type: integer
                format: int32
              example:
              - 4
              - 9
              - 17
          required:
          - adults
        total:
          type: object
          description: 'Reservation Total Rate Information

            * If the rate plan is configured as Tax Inclusive, Amount After Tax is returned.

            * If the rate Plan is configured as Tax Exclusive, Amount Before Tax is returned.

            '
          properties:
            taxes:
              type: object
              description: Total Tax details applicable for this reservation
              $ref: '#/components/schemas/Taxes'
            currencySymbol:
              type: string
              description: Symbol of Rate Currency.
              example: $
            decimalPlaces:
              type: integer
              format: int32
              description: Rate Amount decimal Places.
              example: 1
            rateOverride:
              type: boolean
              description: Indicated if the rate is overridden or not.
              example: true
            amountAfterTax:
              type: number
              example: 214.5
              description: Reservation Total Rate including all known taxes, fees and surcharges.
            amountBeforeTax:
              type: number
              description: Reservation Total Rate excluding all known taxes, fees and surcharges.
              example: 200
            currencyCode:
              $ref: '#/components/schemas/CurrencyCode'
        guarantee:
          type: object
          description: Reservation guarantee details.
          properties:
            guaranteeCode:
              type: string
              example: CC
              description: 'Accepts Property Guarantee Code.

                Either of guaranteeCode or guaranteeType should be provided.

                If no guaranteeCode and no guaranteeType is provided the reservation will be created as Non Guaranteed (OTA Code : 38). Both guaranteeType and guaranteeCode should not be sent in a single reservation request; if sent the reservation would be rejected.

                '
            guaranteeType:
              type: string
              example: '5'
              description: 'Accepts OTA Standard Guarantee Type.

                Possible Values : (5, 8, 19, 22, 38) where 5 = Credit Card, 8 = Deposit, 19 = Travel agency IATA number, 22 = Frequent guest, 30 = Corporate ID/CD Number, 38 = None.

                Either of guaranteeCode or guaranteeType should be provided.

                If no guaranteeType and no guaranteeCode is provided the reservation will be created as Non Guaranteed (OTA Code : 38). Both guaranteeType and guaranteeCode should not be sent in a single reservation request; if sent the reservation would be rejected.

                '
            onHold:
              type: boolean
              example: false
              description: If true indicates this Guarantee Code is used only to hold the inventory during reservation process.
        printRate:
          type: boolean
          description: Defines if the rate is printed on various correspondence. Possible values are 'true' or 'false'.
          example: false
        expectedTimes:
          description: Expected Arrival and Departure Time information.
          $ref: '#/components/schemas/ExpectedTimesType'
        bookingMedium:
          description: Indicates the Origin of the reservation
          type: string
          minLength: 1
          maxLength: 20
          example: OTA
      required:
      - arrivalDate
      - departureDate
      - roomRates
    RoomStayResponseGet:
      type: object
      description: List of room stay information including Room Rates, Promotion, Guest Counts and Guarantee
      properties:
        arrivalDate:
          type: string
          format: date
          description: Arrival Date of the Reservation. Value must be of format YYYY-MM-DD
          example: '2024-05-16'
        departureDate:
          type: string
          format: date
          description: Departure Date of the Reservation. Value must be of format YYYY-MM-DD
          example: '2024-05-17'
        roomRates:
          type: array
          description: Room Rate Information
          minItems: 1
          items:
            $ref: '#/components/schemas/RoomRateResponseGet'
        promotion:
          $ref: '#/components/schemas/Promotion'
        guestCounts:
          type: object
          description: Guest Counts details of the reservation.
          properties:
            adults:
              type: integer
              format: int32
              description: Adults count
              example: 2
            children:
              type: integer
              format: int32
              description: Children count
              example: 3
            childAges:
              description: Ages of children
              type: array
              items:
                type: integer
                format: int32
              example:
              - 4
              - 9
              - 17
          required:
          - adults
        total:
          type: object
          description: 'Reservation Total Rate Information

            * If the rate plan is configured as Tax Inclusive, Amount After Tax is returned.

            * If the rate Plan is configured as Tax Exclusive, Amount Before Tax is returned.

            '
          properties:
            taxes:
              type: object
              description: Total Tax details applicable for this reservation
              $ref: '#/components/schemas/Taxes'
            currencySymbol:
              type: string
              description: Symbol of Rate Currency.
              example: $
            decimalPlaces:
              type: integer
              format: int32
              description: Rate Amount decimal Places.
              example: 1
            rateOverride:
              type: boolean
              description: Indicated if the rate is overridden or not.
              example: true
            amountAfterTax:
              type: number
              example: 214.5
              description: Reservation Total Rate including all known taxes, fees and surcharges.
            amountBeforeTax:
              type: number
              description: Reservation Total Rate excluding all known taxes, fees and surcharges.
              example: 200
            currencyCode:
              $ref: '#/components/schemas/CurrencyCode'
        guarantee:
          type: object
          description: Reservation guarantee details.
          properties:
            guaranteeCode:
              type: string
              example: CC
              description: 'Accepts Property Guarantee Code.

                Either of guaranteeCode or guaranteeType should be provided.

                If no guaranteeCode and no guaranteeType is provided the reservation will be created as Non Guaranteed (OTA Code : 38). Both guaranteeType and guaranteeCode should not be sent in a single reservation request; if sent the reservation would be rejected.

                '
            guaranteeType:
              type: string
              example: '5'
              description: 'Accepts OTA Standard Guarantee Type.

                Possible Values : (5, 8, 19, 22, 38) where 5 = Credit Card, 8 = Deposit, 19 = Travel agency IATA number, 22 = Frequent guest, 30 = Corporate ID/CD Number, 38 = None.

                Either of guaranteeCode or guaranteeType should be provided.

                If no guaranteeType and no guaranteeCode is provided the reservation will be created as Non Guaranteed (OTA Code : 38). Both guaranteeType and guaranteeCode should not be sent in a single reservation request; if sent the reservation would be rejected.

                '
            onHold:
              type: boolean
              example: false
              description: If true indicates this Guarantee Code is used only to hold the inventory during reservation process.
        printRate:
          type: boolean
          description: Defines if the rate is printed on various correspondence. Possible values are 'true' or 'false'.
          example: false
        expectedTimes:
          description: Expected Arrival and Departure Time information.
          $ref: '#/components/schemas/ExpectedTimesType'
        bookingMedium:
          description: Indicates the Origin of the reservation
          type: string
          minLength: 1
          maxLength: 20
          example: OTA
      required:
      - arrivalDate
      - departureDate
      - roomRates
  responses:
    '406':
      description: Not acceptable.
    '414':
      description: Request URI Too Large
    '400':
      description: Bad Request
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/ExceptionObj'
    '403':
      description: Forbidden
    '413':
      description: Request Entity Too Large
    '415':
      description: Unsupported Media Type
    '404':
      description: Resource not found
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/ExceptionObj'
    '502':
      description: Bad Gateway
    '500':
      description: System Error
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/ExceptionObj'
    '503':
      description: Service Unavailable
    '401':
      description: Unauthorized
    '405':
      description: Method not allowed
  parameters:
    confirmationNumberPath:
      name: confirmationNum
      description: Opera Confirmation number
      in: path
      required: true
      x-example: '89786934'
      schema:
        type: string
        minLength: 1
    x-tracing-key:
      name: x-hdp-tracing-key
      in: header
      description: Unique tracing key e.g. 4664ab3423434a45
      required: true
      x-example: 4664ab3423434a45
      schema:
        type: string
    authKey:
      name: authorization
      in: header
      description: Bearer token that needs to be passed which is generated post user authentication
      required: true
      schema:
        type: string
    x-originating-application:
      name: x-originating-application
      description: Customer's Integration Application Id
      in: header
      schema:
        type: string
    x-request-id:
      name: x-request-id
      description: Unique tracing key e.g. 4664ab3423434a45
      in: header
      x-example: 4664ab3423434a45
      schema:
        type: string
    channelCodeHeader:
      name: x-channelCode
      in: header
      description: Channel code.
      required: true
      x-example: CH1
      schema:
        type: string
        pattern: ^[a-zA-Z0-9]*$
    hotelCodePath:
      name: hotelCode
      description: The unique identifier of the Property in Channel system.
      in: path
      required: true
      x-example: XUSXXYY99
      schema:
        type: string
        minLength: 1
    appKey:
      name: x-app-key
      in: header
      description: OHIP Partner
      required: false
      schema:
        type: string
        pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$
externalDocs:
  description: Find out more about Oracle Hospitality
  url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html