openapi: 3.2.0
info:
  title: OPERA Cloud Distribution Content API
  description: Oracle Hospitality Distribution Content is for distribution partners to retrieve property Channel content information.<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
  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
servers:
- url: /content/v1
tags:
- name: Content
paths:
  /hotels:
    get:
      summary: Properties Summary
      description: Retrieve list of property information for all properties actively mapped to a single channel code.  <p><strong>OperationId:</strong>getPropertiesSummary</p>
      operationId: getPropertiesSummary
      tags:
      - Content
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-channelCode'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/connectionStatusLastChangedFrom'
      - $ref: '#/components/parameters/connectionStatusLastChangedTo'
      - $ref: '#/components/parameters/connectionStatus'
      - $ref: '#/components/parameters/fetchInstructions'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/x-originating-application'
      responses:
        '200':
          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})*'
          description: Response object for property info
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/PropertyInfoSummaryResponse'
        '400':
          description: Request data provided is invalid
          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 Allowed
          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'
  /hotels/{hotelCode}:
    get:
      summary: Property Information
      description: Retrieve property information for a single property. <p><strong>OperationId:</strong>getPropertyInfo</p>
      operationId: getPropertyInfo
      tags:
      - Content
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-channelCode'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/HotelCode'
      - $ref: '#/components/parameters/x-originating-application'
      responses:
        '200':
          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})*'
          description: Response object for property info
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/PropertyInfoResponse'
        '400':
          description: Request data provided is invalid
          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 Allowed
          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'
  /hotels/{hotelCode}/roomTypes:
    get:
      summary: Room Types Information
      description: Retrieve room types information for a single property. <p><strong>OperationId:</strong>getRoomTypesInfo</p>
      operationId: getRoomTypesInfo
      tags:
      - Content
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-channelCode'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/HotelCode'
      - $ref: '#/components/parameters/includeRoomAmenities'
      - $ref: '#/components/parameters/roomType'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/x-originating-application'
      responses:
        '200':
          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})*'
          description: Response object for roomTypes info
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/RoomTypesResponse'
        '400':
          description: Request data provided is invalid
          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 Allowed
          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'
  /hotels/{hotelCode}/ratePlans:
    get:
      summary: Rate Plans Information
      description: Retrieve rate plans information for a single property. <p><strong>OperationId:</strong>getRatePlans</p>
      operationId: getRatePlansInfo
      tags:
      - Content
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-channelCode'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/HotelCode'
      - $ref: '#/components/parameters/includeNegotiatedRates'
      - $ref: '#/components/parameters/ratePlanCode'
      - $ref: '#/components/parameters/fetchInstructionsRatePlans'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/x-originating-application'
      responses:
        '200':
          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})*'
          description: Response object for property info
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/RatePlansResponse'
        '400':
          description: Request data provided is invalid
          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 Allowed
          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'
  /hotels/{hotelCode}/rateRooms:
    get:
      summary: Rate Rooms Information
      description: Retrieve rate plan and room type mapping information for a single property. <p><strong>OperationId:</strong>getRateRooms</p>
      operationId: getRateRooms
      tags:
      - Content
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-channelCode'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/HotelCode'
      - $ref: '#/components/parameters/includeInactive'
      - $ref: '#/components/parameters/roomType'
      - $ref: '#/components/parameters/ratePlanCode'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/x-originating-application'
      responses:
        '200':
          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})*'
          description: Response object for property info
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/RateRoomsResponse'
        '400':
          description: Request data provided is invalid
          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 Allowed
          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'
components:
  schemas:
    MessageType:
      description: Message type that is enabled. <p>AvailNotif -  Indicates enable for hotel restrictions update </p> <p>RatePlanNotif - Indicates enable for hotel rate and room pricing update </p> <p>InvCountNotif - Indicates enable for hotel inventory counts update </p> <p>GetRooms - Indicates enable to fetch rooms from the distribution partner system </p> <p>GetRatePlans - Indicates enable to fetch rates from the distribution partner system </p>
      type: string
      enum:
      - AvailNotif
      - RatePlanNotif
      - InvCountNotif
      - GetRooms
      - GetRatePlans
      example: AvailNotif
      externalDocs:
        description: Find out more about Oracle Hospitality
        url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html
    Email:
      type: object
      properties:
        emailType:
          description: The email type
          type: string
        email:
          description: The email address for the specific emailType
          type: string
    PropertyInfoSummaryResponse:
      type: object
      properties:
        hasMore:
          type: boolean
          description: Boolean value that is set to true if more resources are available on the server than the subset returned in current page.
          example: true
        totalResults:
          type: integer
          description: Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request.
          example: 100
        limit:
          type: integer
          description: Actual paging size used by the server.
          example: 100
        count:
          type: integer
          description: Number of resource instances returned in the current range.
          example: 100
        offset:
          type: integer
          description: Offset value used in the current page.
          example: 1
        hotels:
          type: array
          items:
            $ref: '#/components/schemas/OfferDetailsPropertyInfoSummary'
    ChannelRouteType:
      type: object
      allOf:
      - $ref: '#/components/schemas/ModifiableChannelRouteType'
      - properties:
          messageType:
            $ref: '#/components/schemas/MessageType'
    ConnectionInformation:
      description: Channel Connection Information for the hotel property
      type: object
      properties:
        connectionStatus:
          type: string
          description: Channel connection status
          enum:
          - TEST
          - ACTIVE
          - MAINTENANCE
        connectionStatusLastChangedOn:
          description: Channel connection status last changed on this date time
          type: string
          format: date-time
          example: '2022-01-02T11:30:22.234Z'
        defaultARIMessageFormat:
          type: string
          description: ARI message format
          enum:
          - Oracle_v1
          - AdsRateUpdate
          - AdsRateAmount
          example: Oracle_v1
        channelRoutes:
          description: The web service location (URL) of the distribution partners where Oracle Hospitality Distribution ARI service will post messages such as the property inventory, restrictions/availability, rate schedules updates, etc.
          type: array
          items:
            $ref: '#/components/schemas/ChannelRouteType'
    CancellationPolicyDeadline:
      description: The cancellation policy deadline
      type: object
      properties:
        offsetFromArrival:
          description: The number of days before arrival that allows cancellation without penalties.
          type: integer
          example: 5
        offsetDropTime:
          description: Time on offset day the cancellation penalties applies. 24-hour format, hh:mm
          type: string
          example: '22:00'
    ContentRoomType:
      type: object
      description: Room Type information
      properties:
        hotelRoomType:
          type: string
          example: A1K
          description: A room type code for a hotel.
        roomType:
          type: string
          example: XA1K
          description: A code for a room type for a requested channel.
        description:
          type: array
          items:
            type: string
            example: Deluxe King Room on my Channel
        roomName:
          type: string
          example: 102
        roomCategory:
          type: string
          example: SUITE
        roomAmenities:
          type: array
          items:
            $ref: '#/components/schemas/ContentRoomAmenity'
        roomViewCode:
          type: string
        roomViewType:
          type: string
        roomPrimaryBedType:
          type: string
        nonSmokingInd:
          type: boolean
          example: true
        occupancy:
          type: object
          $ref: '#/components/schemas/Occupancy'
        numberOfUnits:
          type: integer
          description: number of rooms requested
          example: 1
    CancellationPolicies:
      description: The list of cancellation policies attached to a rate plan
      type: array
      items:
        $ref: '#/components/schemas/CancellationPoliciesItem'
    TimeZone:
      type: object
      properties:
        timeZoneName:
          type: string
          description: Zone Name of the region
          minLength: 1
          maxLength: 50
          example: Asia/Calcutta
        offset:
          type: string
          description: Provides the current offset from UTC for the specified time zone, considering DST
          minLength: 1
          maxLength: 50
          example: UTC+05:30
    ContentRateRoom:
      type: object
      properties:
        ratePlanCode:
          type: string
          example: XDAILY
          description: A code for a rate plan for a requested channel.
        hotelRatePlanCode:
          type: string
          example: DAILY
          description: A rate plan code for a hotel.
        roomType:
          type: string
          example: XA1K
          description: A code for a room type for a requested channel.
        hotelRoomType:
          type: string
          example: A1K
          description: A room type code for a hotel.
        active:
          type: boolean
          example: true
          description: It represent if the rate room is active or inactive. Default value is true.
        occupancy:
          type: object
          description: It holds list of elements that defines room type occupancy information.
          $ref: '#/components/schemas/Occupancy'
    OfferDetailsPropertyInfoSummary:
      description: Property information
      type: object
      properties:
        hotelId:
          type: string
          description: Unique ID that identifies a single hotel property
          example: Hotel1
        hotelCode:
          type: string
          description: The external Hotel/property Id for a channel
          example: XUSXXYY99
        hotelName:
          type: string
          description: The descriptive name of a property
          example: The Palmyra Resort
        chainCode:
          type: string
          description: Channel chain code for a property
          example: CHAIN1
        brandCode:
          type: string
          description: Channel's hotel/property brand code
          example: BRAND1
        startDate:
          type: string
          description: The date this property will be active for the channel
          format: date
          example: '2023-08-03'
        endDate:
          type: string
          description: The date this property will be deactivate for the channel
          format: date
          example: '2024-09-04'
        address:
          description: Address Details such as city, state, country, postal code etc for a hotel property
          $ref: '#/components/schemas/Address'
        communications:
          description: The contact information for the property
          $ref: '#/components/schemas/Communications'
        connectionInformation:
          description: The connection information for the channel
          $ref: '#/components/schemas/ConnectionInformation'
    ContentPropertyInfo:
      description: Property information
      type: object
      properties:
        hotelId:
          type: string
          description: Unique ID that identifies a single hotel property
          example: Hotel1
        enterpriseId:
          type: string
          description: The Enterprise ID of the property it belongs to
          example: Hotel1
        hotelCode:
          type: string
          description: A channel hotel code
          example: XUSXXYY99
        hotelName:
          type: string
          description: A full name of a hotel
          example: Resort1
        hotelDescription:
          type: string
          description: Description of a hotel
        chainCode:
          type: string
          description: Channel chain code for a property
          example: CHAIN1
        clusterCode:
          type: string
          description: Code of the cluster
          minLength: 1
          maxLength: 8
          pattern: '[A-Z0-9_]*'
          example: CLU123
        address:
          type: object
          $ref: '#/components/schemas/Address'
        latitude:
          type: number
          description: Latitude of a hotel
          format: double
          example: 15
        longitude:
          type: number
          description: Longitude of a hotel
          format: double
          example: 40
        propertyAmenities:
          type: array
          items:
            $ref: '#/components/schemas/PropertyOffersHotelAmenity'
        pointOfInterest:
          type: array
          items:
            $ref: '#/components/schemas/OfferPointOfInterest'
        marketingMessage:
          type: string
          description: Property level marketing message.
          example: Thank you for choosing our property.
        currencyCode:
          type: string
          description: currency code
          pattern: '[a-zA-Z]{3}'
          example: USD
        primaryLanguage:
          description: Primary Language spoken at the property
          type: string
          example: en-us
        totalNumberOfRooms:
          description: The total number of guest rooms for the property
          type: integer
          example: 5
        petPolicy:
          type: string
          description: Hotel pet policy.
          enum:
          - Pets allowed
          - Pets not allowed
          - Assistive animals only
          - Pets by arrangement
          - Other_
        hotelChildPolicy:
          $ref: '#/components/schemas/HotelChildPolicy'
        timeZone:
          $ref: '#/components/schemas/TimeZone'
        generalInformation:
          type: object
          $ref: '#/components/schemas/GeneralInformation'
        communications:
          type: object
          $ref: '#/components/schemas/Communications'
        transportations:
          type: array
          items:
            $ref: '#/components/schemas/Transportation'
        direction:
          type: object
          $ref: '#/components/schemas/Direction'
        location:
          type: object
          $ref: '#/components/schemas/Location'
    Location:
      type: object
      properties:
        propertyLocation:
          type: string
          maxLength: 4000
          example: ABC hills
    CancellationPolicy:
      description: The cancellation policy details
      type: object
      properties:
        policyCode:
          type: string
          description: The cancellation policy code
          maxLength: 20
          example: 1 DAY
        description:
          type: string
          description: The cancellation policy description
          example: 1 Day prior to arrival, forfeit 1 night
        deadline:
          description: Cancellation policy deadline
          $ref: '#/components/schemas/CancellationPolicyDeadline'
          example:
            offsetFromArrival: 5
            offsetDropTime: '2000-01-01T22:00:00.000Z'
            offsetFromBookingDate: 3
        amountPercent:
          description: Cancellation fee expressed as a fixed amount, or percentage of/or room nights.
          $ref: '#/components/schemas/CancellationPolicyAmountPercentType'
          example:
            basisType: FlatAmount
            amount: 100
        override:
          type: boolean
          description: Does this cancellation policy override another cancellation policy
          example: true
    ContentRoomAmenity:
      type: object
      properties:
        roomAmenity:
          type: string
        description:
          type: string
        quantity:
          type: integer
        includeInRate:
          type: boolean
        confirmable:
          type: boolean
    Description:
      type: object
      properties:
        line1:
          type: string
        line2:
          type: string
        line3:
          type: string
        detailedDescription:
          type: string
    HotelChildPolicy:
      type: object
      properties:
        kidsStayFreeInd:
          type: boolean
        usualStayFreeCutoffAge:
          type: integer
          example: 5
        maxChildAge:
          type: integer
          example: 18
    ModifiableChannelRouteType:
      type: object
      properties:
        url:
          $ref: '#/components/schemas/MessageUrl'
    MessageUrl:
      description: Message URL
      type: string
      pattern: ^(http[s]?|ftp[s]?|sftp)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]
      example: https://pms-certification.profit.net/opera-cloud
    OfferRatePlanMealType:
      type: string
      enum:
      - Breakfast
      - Lunch
      - Dinner
      description: Type of meal the rate plan includes
    OfferPointOfInterest:
      type: object
      description: The point of interest for guests to get to the hotel.
      properties:
        name:
          type: string
          description: The name of the point of interest.
          example: Dallas airport, Park
        pointOfInterestType:
          type: string
          description: The point of interest type available to choose.
          example: AIRPORT
          enum:
          - AIRPORT
          - ATTRACTIONS
        description:
          description: The description of the point of interest.
          type: string
        airportCode:
          description: The unique 3 letter IATA code to identify the airport.
          type: string
          example: DAL
        distance:
          description: The distance from the point of interest to the hotel
          type: number
          format: double
          example: 6
        distanceUnit:
          description: Unit of measurement for the distance
          type: string
          example: Kilometers
        attractionDirection:
          description: The attraction direction from point of interest to the hotel.
          type: string
          example: N
          enum:
          - N
          - W
          - S
          - E
          - NW
          - NE
          - SW
          - SE
        transportation:
          description: The transportation type for the chosen point of interest.
          type: array
          items:
            type: string
          example:
          - objId
        directionDescription:
          description: The description for how to get from point of interest to the hotel.
          type: string
          example: Free text to describe route from property to attraction
        drivingTime:
          description: The driving time it will take to get from point of interest to the hotel.
          type: number
          format: double
          example: 3.5
    GeneralInformation:
      type: object
      properties:
        checkInTime:
          type: string
          pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$
          example: 04:30
        checkOutTime:
          type: string
          pattern: ^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$
          example: '14:30'
    CancellationPoliciesItem:
      description: The cancellation policy containing its schedules and policy details
      type: object
      properties:
        policy:
          type: object
          $ref: '#/components/schemas/CancellationPolicy'
        scheduleDetail:
          type: object
          $ref: '#/components/schemas/CancellationPolicyScheduleDetail'
    Address:
      type: object
      properties:
        addressLine:
          description: The property's street address
          type: array
          items:
            type: string
          minItems: 1
          maxItems: 2
          example:
          - Street 123
          - Box 1
        countryCode:
          description: The property's two letter ISO country code
          type: string
          example: US
        cityName:
          description: The city where the property is located
          type: string
          example: Miami
        stateProv:
          description: The state where the property is located
          type: string
          example: Florida
        postalCode:
          description: The property's postal (ZIP) code
          type: string
          example: '90210'
    PropertyInfoResponse:
      type: object
      properties:
        propertyInfo:
          $ref: '#/components/schemas/ContentPropertyInfo'
    ContentRatePlan:
      type: object
      properties:
        hotelRatePlanCode:
          type: string
          example: DAILY
          description: A rate plan code for a hotel.
        ratePlanCode:
          type: string
          example: XDAILY
          description: A code for a rate plan for a requested channel.
        active:
          type: boolean
          example: true
          description: It represent if the rate is active or inactive.
        taxInclusive:
          description: It represents whether rate is tax Inclusive or not.
          type: boolean
          example: true
        currencyCode:
          type: string
          description: currency code
          pattern: '[a-zA-Z]{3}'
          example: USD
        negotiated:
          description: if the rate plan is negotiated or not
          type: boolean
        ratePlanType:
          type: string
          description: Code of the Channel Rate Plan Type
          example: 10
        ratePlanName:
          description: Rate Plan Name
          type: string
        identificationRequired:
          type: boolean
          description: Indicates if an ID is required during the Check-In for this rate booking
        ratePlanLevel:
          type: string
          description: The rate level associated with the rate code
        ratePlanCategory:
          type: string
          description: The rate category associated with the rate plan code
        gdsDescription:
          type: object
          $ref: '#/components/schemas/Description'
        mealPlan:
          description: Type of meal plan the rate plan includes
          type: object
          $ref: '#/components/schemas/OfferMealPlan'
        cancellationPolicies:
          description: Cancellation policy schedule(s) and detail(s)
          type: object
          $ref: '#/components/schemas/CancellationPolicies'
    CancellationPolicyBasicAmountPercentType:
      type: object
      properties:
        nights:
          description: Number of nights of the hotel stay used to calculate the fee amount when basisType=Nights.
          type: integer
          example: 2
        percent:
          description: Percentage used to calculate the amount when basisType=Percentage
          type: number
          format: double
          example: 50
        nightPercent:
          description: Percentage used to calculate the amount when basisType=NightPercentage.
          type: number
          format: double
          example: 66.6
        amount:
          description: Monetary amount when basisType=FlatAmount.
          type: number
          format: double
          example: 540
    Direction:
      type: object
      properties:
        propertyDirection:
          type: string
          maxLength: 4000
          example: SE ABC hills
    Occupancy:
      type: object
      properties:
        minOccupancy:
          description: 'Assigned Type: ota2-0500:NonNegativeInteger'
          type: integer
          format: int32
          minimum: 0
          example: 2
        maxOccupancy:
          description: 'Assigned Type: ota2-0500:NonNegativeInteger'
          type: integer
          format: int32
          minimum: 0
          example: 8
        maxAdultOccupancy:
          description: 'Assigned Type: ota2-0500:NonNegativeInteger'
          type: integer
          format: int32
          minimum: 0
          example: 4
        maxChildOccupancy:
          description: 'Assigned Type: ota2-0500:NonNegativeInteger'
          type: integer
          format: int32
          minimum: 0
          example: 3
    OfferMealPlan:
      type: object
      properties:
        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
          type: array
          items:
            $ref: '#/components/schemas/OfferRatePlanMealType'
    RateRoomsResponse:
      description: Rate Rooms Response
      type: object
      properties:
        rateRooms:
          description: Collection of the returned RateRooms for given channel
          type: array
          items:
            $ref: '#/components/schemas/ContentRateRoom'
        count:
          type: integer
          example: 50
        hasMore:
          type: boolean
          example: true
        limit:
          type: integer
          example: 100
        offset:
          type: integer
          example: 25
        totalResults:
          type: integer
          example: 500
    CancellationPolicyBasisType:
      type: string
      description: The method to be used to compute the penalty. Nights - The penalty amount is determined by the guest's room rate plus any packages, and generates associated with the rate for this number of nights. For example, assume the guest is planning to stay 3 nights. If the Penalty Amount is 1, and the nightly room rate is $150, the cancellation charge would be $150 ($150 x 1 nights). Percentage - The penalty amount is the percentage of the entire stay's room rate, plus any packages and generates associated with the rate, that will be taken for a cancellation charge. For example, if the Penalty Amount is 50, the guest will pay a charge of 50% of the total stay room rate. If the room rate is $300 a night for 3 nights, the guest pays$450 (0.50 x $900). NightPercentage - The penalty amount is based on the percentage of the first night's room rate. Schedule the time period when this rule is effective. FlatAmount - The penalty amount is the exact amount of the cancellation charge in the property currency. NonCancelable - The reservation can't be canceled. It will be resulted in penalty of the total cost of stay.
      enum:
      - Nights
      - Percentage
      - NightPercentage
      - FlatAmount
      - NonCancelable
    RatePlansResponse:
      description: Rate Plans Response
      type: object
      properties:
        ratePlans:
          description: Collection of the returned Rate Plans for a given channel
          type: array
          items:
            $ref: '#/components/schemas/ContentRatePlan'
        count:
          type: integer
          example: 50
        hasMore:
          type: boolean
          example: true
        limit:
          type: integer
          example: 100
        offset:
          type: integer
          example: 25
        totalResults:
          type: integer
          example: 500
    CancellationPolicyScheduleDetail:
      description: The cancellation policy schedule detail
      type: object
      properties:
        start:
          type: string
          description: The start date the cancellation policy schedule is effective
          format: date
          example: '2025-11-01'
        end:
          type: string
          description: The end date the cancellation policy is no longer effective
          format: date
          example: '2025-11-07'
    RoomTypesResponse:
      description: Room Types Response
      type: object
      properties:
        roomTypes:
          description: Collection of the returned Room Types for given channel
          type: array
          items:
            $ref: '#/components/schemas/ContentRoomType'
        count:
          type: integer
          example: 50
        hasMore:
          type: boolean
          example: true
        limit:
          type: integer
          example: 100
        offset:
          type: integer
          example: 25
        totalResults:
          type: integer
          example: 500
    Transportation:
      type: object
      properties:
        transportationCode:
          type: string
          description: 'Transportation type ex: Bus, Taxi. Enum values from globalCodes TRP - Transportation Code'
          example: Metro
        description:
          type: string
          maxLength: 1024
          example: Description for a Transportation
        includeInRate:
          type: boolean
          description: Indicates whether charge rate is included or excluded
          example: false
        reservationRequired:
          type: boolean
          description: Indicates whether reservation is required for this Transportation
          example: true
    PropertyOffersHotelAmenity:
      type: object
      properties:
        hotelAmenity:
          type: string
          description: Feature available at a hotel
          example: '12'
        description:
          type: string
          description: Description of a hotel amenity
          example: Swimming Pool
        quantity:
          type: integer
          description: Quantity of a hotel amenity
          example: 1
        includeInRate:
          type: boolean
          description: Indicates if an amenity is included in a room rate
          example: true
        confirmable:
          type: boolean
          description: If a hotel amenity is confirmed to be available
          example: false
    Communications:
      description: The contact information for the property
      type: object
      properties:
        phones:
          description: List of phone numbers for the property
          type: array
          items:
            $ref: '#/components/schemas/Phone'
          minItems: 1
        emails:
          description: List of emails addresses for the property
          type: array
          items:
            $ref: '#/components/schemas/Email'
        urls:
          description: List of urls for the property
          type: array
          items:
            $ref: '#/components/schemas/Url'
    Url:
      type: object
      properties:
        url:
          description: The url or internet web address
          type: string
    Phone:
      type: object
      properties:
        phoneTechType:
          description: The type of technology associated with the telephone number
          type: string
        phoneLocationType:
          description: Describes the location of the phone
          type: string
        phoneNumber:
          description: The phone number assigned to a specific location
          type: string
    ExceptionDetail:
      description: Common Error Response format
      type: object
      properties:
        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 in Application
        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: Business specific Error code, which is different from HTTP error code.
          example: RSV-34534534
        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.4
        timestamp:
          type: string
          format: date-time
          description: The UTC Date and Time of the Error happened.
          example: '2022-01-02T11:30:22.234Z'
        o:errorDetails:
          description: Details of the error message, consisting of a hierarchical tree structure
          type: array
          items:
            $ref: '#/components/schemas/ExceptionDetail'
        logId:
          type: integer
          description: An ID for support reasons to be able identify errors better.
          example: '334543532224'
    CancellationPolicyAmountPercentType:
      type: object
      allOf:
      - $ref: '#/components/schemas/CancellationPolicyBasicAmountPercentType'
      properties:
        basisType:
          description: Cancellation policy basis type
          $ref: '#/components/schemas/CancellationPolicyBasisType'
          example: NightPercentage
  parameters:
    authorization:
      name: authorization
      description: "Bearer token that needs to be passed which is generated post user\n  authentication"
      in: header
      required: true
      schema:
        type: string
    includeRoomAmenities:
      name: includeRoomAmenities
      in: query
      description: If true include room amenities along with each room type. Default is False
      required: false
      x-example: false
      schema:
        type: boolean
        default: false
    limit:
      name: limit
      description: Integer, the maximal number of item entities to be returned
      in: query
      required: false
      x-example: 40
      schema:
        type: integer
        default: 20
        maximum: 100
        minimum: 1
    offset:
      name: offset
      description: Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection
      in: query
      required: false
      x-example: 1
      schema:
        type: integer
        default: 0
        minimum: 0
    connectionStatus:
      name: connectionStatus
      in: query
      description: Channel connection status
      required: false
      schema:
        type: string
        enum:
        - TEST
        - ACTIVE
        - MAINTENANCE
    x-app-key:
      name: x-app-key
      description: Client or Partner's Application Key
      in: header
      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}$
    fetchInstructionsRatePlans:
      name: fetchInstructions
      in: query
      description: The optional additional information to be included in the response
      required: false
      schema:
        type: string
        enum:
        - Policy
    includeInactive:
      name: includeInactive
      in: query
      description: If true include inactive rateRooms. Default is False
      required: false
      x-example: false
      schema:
        type: boolean
        default: false
    connectionStatusLastChangedFrom:
      name: connectionStatusLastChangedFrom
      in: query
      description: Channel connection status last changed after this time
      required: false
      x-example: '2022-01-02T11:30:22.234Z'
      schema:
        type: string
        format: date-time
    connectionStatusLastChangedTo:
      name: connectionStatusLastChangedTo
      in: query
      description: Channel connection status last changed before this time
      required: false
      x-example: '2022-01-02T11:30:22.234Z'
      schema:
        type: string
        format: date-time
    roomType:
      name: roomType
      in: query
      description: Room Type
      required: false
      x-example: XA1K
      schema:
        type: string
        maxLength: 20
        minLength: 1
    x-originating-application:
      name: x-originating-application
      description: Customer's Integration Application Id
      in: header
      schema:
        type: string
    includeNegotiatedRates:
      name: includeNegotiatedRates
      in: query
      description: Set this true to include Negotiated rate plans along with public rate plans. Default is False
      required: false
      x-example: false
      schema:
        type: boolean
        default: false
    x-channelCode:
      name: x-channelCode
      in: header
      description: Channel code
      required: true
      x-example: CH1
      schema:
        type: string
        maxLength: 50
        minLength: 1
    fetchInstructions:
      name: fetchInstructions
      in: query
      description: The optional summary sections to be included in the response
      required: false
      schema:
        type: string
        enum:
        - ConnectionInformation
    x-request-id:
      name: x-request-id
      description: Unique tracing key e.g. 4664ab3423434a45
      in: header
      x-example: 4664ab3423434a45
      schema:
        type: string
    HotelCode:
      name: hotelCode
      in: path
      description: Hotel Code
      required: true
      x-example: XUSXXYY99
      schema:
        type: string
        maxLength: 50
        minLength: 1
    ratePlanCode:
      name: ratePlanCode
      in: query
      description: Rate Plan code
      required: false
      x-example: XDAILY
      schema:
        type: string
        maxLength: 20
        minLength: 1
externalDocs:
  description: Find out more about Oracle Hospitality
  url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html