openapi: 3.2.0
info:
  title: OPERA Cloud Inventory INV Stats API
  description: APIs to cater for Inventory functionality in OPERA Cloud.  This includes sell limits for date ranges, viewing and updating the properties inventory, as well as item inventory (such as rollaways, microwaves etc.).<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: /inv/v1
tags:
- name: INVStats
  description: The Inventory Statistics APIs provide the ability to fetch hotels inventory statistics or block inventory statistics for a specified date range provided in the request. It also contains operations to get block inventory statistics for multiple properties.
paths:
  /blockInventoryStatistics:
    get:
      summary: Get block inventory statistics for multiple hotel Ids
      description: You can use this API to retrieve Block inventory for multiple hotel codes. Narrow down your results using the query parameters available. <p><strong>OperationId:</strong>getBlockInventoryStatisticsMultipleHotelIds</p> <p>The maximum allowable limit for this API is <strong>100</strong>.</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: getBlockInventoryStatisticsMultipleHotelIds
      parameters:
      - name: hotelIds
        in: query
        description: Hotel code.
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
          minItems: 1
      - name: includeBlocksWithNoRoom
        in: query
        required: false
        description: If set to true, includes business blocks without rooms.
        schema:
          type: boolean
      - name: includeOverbooking
        in: query
        required: false
        description: If set to true, the house overbooking limit for each day is added to the total number of physical rooms.
        schema:
          type: boolean
      - name: includeOpportunities
        in: query
        required: false
        description: If set to true, the results will include opportunities. If this flag is not provided it will be considered false and exclude opportunities.
        schema:
          type: boolean
      - name: includeTentativeInventory
        in: query
        required: false
        description: If set to true, includes non-deduct business blocks and group reservations in the Sales Allowance Available Rooms and House Availability statistics.
        schema:
          type: boolean
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
      - name: offset
        in: query
        required: false
        description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.
        schema:
          type: integer
          default: 0
      - name: endDateRange
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: startDateRange
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: blockStatusCodes
        in: query
        description: Collection of configured Block Status Codes.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: originCodes
        in: query
        description: Collection of Origin Codes.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomOwnerCodes
        in: query
        description: Collection of Room Owners.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: blockOwners
        in: query
        description: Collection of block owners.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: availabilitySummaryBy
        in: query
        description: 'Summarize the availability based on selected criteria. If not selected, by default AvailableRooms are displayed. '
        required: false
        schema:
          type: string
          enum:
          - AvailableRooms
          - AvailableRoomsExclSellLimits
      - name: summarySortByCode
        in: query
        required: false
        description: Supported block inventory statistical sorting for summary information
        schema:
          type: string
          enum:
          - Status
          - StatusDescending
          uniqueItems: true
      - name: detailSortByCode
        in: query
        required: false
        description: Supported block inventory statistical sorting for detailed block information
        schema:
          type: string
          enum:
          - Status
          - StatusDescending
          - ArrivalDate
          - BlockAccount
          - Revenue
          - RoomsOwner
          uniqueItems: true
      - name: sunday
        in: query
        required: false
        description: If selected, Sundays are included in search result.
        schema:
          type: boolean
      - name: monday
        in: query
        required: false
        description: If selected, Mondays are included in search result.
        schema:
          type: boolean
      - name: tuesday
        in: query
        required: false
        description: If selected, Tuesdays are included in search result.
        schema:
          type: boolean
      - name: wednesday
        in: query
        required: false
        description: If selected, Wednesdays are included in search result.
        schema:
          type: boolean
      - name: thursday
        in: query
        required: false
        description: If selected, Thursdays are included in search result.
        schema:
          type: boolean
      - name: friday
        in: query
        required: false
        description: If selected, Fridays are included in search result.
        schema:
          type: boolean
      - name: saturday
        in: query
        required: false
        description: If selected, Saturdays are included in search result.
        schema:
          type: boolean
      - name: fetchInstructions
        in: query
        description: Type for block inventory statistics instructions that can be used in requests for partial operations.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - StatusSummary
            - BookingSummary
            - ForecastSummary
            - DetailSummary
            - RoomSummary
          uniqueItems: true
      - name: roomSummaryBy
        in: query
        description: 'Summarize the rooms based on selected criteria. If not selected, by default AvailableRooms are displayed. Applicable only when RoomSummary is a fetchInstruction. '
        required: false
        schema:
          type: string
          enum:
          - AvailableRooms
          - AvailableRoomsWithNonDeduct
          - AvailableRoomsExclSellLimits
          - AvailableRoomsWithNonDeductExclSellLimits
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      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 information regarding Block Inventory Statistics.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/blockInventoryStatistic'
        '204':
          description: BlockInventoryStatistics not found.
        '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'
      tags:
      - INVStats
  /hotels/{hotelId}/blockInventoryStatistics:
    get:
      summary: Get block inventory statistics
      description: You can use this API to retrieve Block inventory for a specified hotel. Narrow down your results using the query parameters available. <p><strong>OperationId:</strong>getBlockInventoryStatistics</p> <p>The maximum allowable limit for this API is <strong>100</strong>.</p> <p>This API allows a time span of <strong>90</strong> days.</p>
      operationId: getBlockInventoryStatistics
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID of the hotel where block inventory statistics are searched.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: includeBlocksWithNoRoom
        in: query
        required: false
        description: If set to true, includes business blocks without rooms.
        schema:
          type: boolean
      - name: includeOverbooking
        in: query
        required: false
        description: If set to true, the house overbooking limit for each day is added to the total number of physical rooms.
        schema:
          type: boolean
      - name: includeOpportunities
        in: query
        required: false
        description: If set to true, the results will include opportunities. If this flag is not provided it will be considered false and exclude opportunities.
        schema:
          type: boolean
      - name: includeTentativeInventory
        in: query
        required: false
        description: If set to true, includes non-deduct business blocks and group reservations in the Sales Allowance Available Rooms and House Availability statistics.
        schema:
          type: boolean
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
      - name: offset
        in: query
        required: false
        description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.
        schema:
          type: integer
          default: 0
      - name: endDateRange
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: startDateRange
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: blockStatusCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: originCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: roomOwnerCodes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: blockOwners
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: availabilitySummaryBy
        in: query
        description: 'Summarize the availability based on selected criteria. If not selected, by default AvailableRooms are displayed. '
        required: false
        schema:
          type: string
          enum:
          - AvailableRooms
          - AvailableRoomsExclSellLimits
      - name: summarySortByCode
        in: query
        required: false
        description: Supported block inventory statistical sorting.
        schema:
          type: string
          enum:
          - Status
          - StatusDescending
          - ArrivalDate
          - BlockAccount
          - Revenue
          - RoomsOwner
          uniqueItems: true
      - name: detailSortByCode
        in: query
        required: false
        description: Supported block inventory statistical sorting.
        schema:
          type: string
          enum:
          - Status
          - StatusDescending
          - ArrivalDate
          - BlockAccount
          - Revenue
          - RoomsOwner
          uniqueItems: true
      - name: friday
        in: query
        required: false
        schema:
          type: boolean
      - name: monday
        in: query
        required: false
        schema:
          type: boolean
      - name: saturday
        in: query
        required: false
        schema:
          type: boolean
      - name: sunday
        in: query
        required: false
        schema:
          type: boolean
      - name: thursday
        in: query
        required: false
        schema:
          type: boolean
      - name: tuesday
        in: query
        required: false
        schema:
          type: boolean
      - name: wednesday
        in: query
        required: false
        schema:
          type: boolean
      - name: fetchInstructions
        in: query
        description: Type for block inventory statistics instructions that can be used in requests for partial operations.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - StatusSummary
            - BookingSummary
            - ForecastSummary
            - DetailSummary
            - RoomSummary
          uniqueItems: true
      - name: roomSummaryBy
        in: query
        description: 'Summarize the rooms based on selected criteria. If not selected, by default AvailableRooms are displayed. Applicable only when RoomSummary is a fetchInstruction. '
        required: false
        schema:
          type: string
          enum:
          - AvailableRooms
          - AvailableRoomsWithNonDeduct
          - AvailableRoomsExclSellLimits
          - AvailableRoomsWithNonDeductExclSellLimits
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      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 information regarding Block Inventory Statistics.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/blockInventoryStatistic'
        '204':
          description: BlockInventoryStatistics not found.
        '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'
      tags:
      - INVStats
  /hotels/{hotelId}/inventoryStatistics:
    get:
      summary: Get a hotels Inventory Statistics
      description: This will fetch a hotel's inventory statistics for a specified date range that you provided in the request.<p> <Strong>Note:</strong> This operation does not contain or return revenue data.</p> <p><strong>OperationId:</strong> getInventoryStatistics</p> <p>This API allows a time span of <strong>62</strong> days.</p>
      operationId: getInventoryStatistics
      parameters:
      - name: hotelId
        in: path
        required: true
        description: Unique ID of the hotel where inventory statistics are searched.
        schema:
          type: string
          maxLength: 2000
          minLength: 1
      - name: dateRangeEnd
        in: query
        required: true
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: reportCode
        in: query
        required: true
        description: Identifies the type of statistics collected. Each ReportCode corresponds to a set of category summaries based upon a predetermined agreement.
        schema:
          type: string
          enum:
          - DetailedAvailabiltySummary
          - RoomCalendarStatistics
          - SellLimitSummary
          - RoomsAvailabilitySummary
      - name: dateRangeStart
        in: query
        required: true
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: parameterName
        in: query
        description: Name of the parameter.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - HouseScheduledRoomMovesYN
            - RoomScheduledRoomMoveInsYN
            - RoomScheduledRoomMoveOutsYN
            - CancelledYN
            - Channel
            - DeductRoomsYN
            - ExcludeRoomTypeCalculationYN
            - GroupBy
            - HouseArrPersonsYN
            - HouseArrRoomsYN
            - HouseExpectedArrRoomsYN
            - HouseAvailPercYN
            - HouseAvailRoomsExcludingOverbookingYN
            - HouseAvailRoomsYN
            - HouseAvailTenPercYN
            - HouseBlkDeductNpuYN
            - HouseBlkDeductPuYN
            - HouseBlkTentNpuYN
            - HouseBlkTentPuYN
            - HouseCompRoomsYN
            - HouseDayUsePersonYN
            - HouseDayUseRoomYN
            - HouseDepPersonsYN
            - HouseDepRoomsYN
            - HouseInventoryRoomsYN
            - HouseMaxAvailabilityExcludingOverbookingYN
            - HouseMaxAvailabilityYN
            - HouseMaxOccupancyYN
            - HouseMinAvailabilityExcludingOverbookingYN
            - HouseMinAvailabilityYN
            - HouseOccPercYN
            - HouseOccTenPercYN
            - HouseOccupancyYN
            - HouseOOOYN
            - HouseOOSRoomsYN
            - HouseOverBookingYN
            - HousePeopleInHouseYN
            - HousePhysicalRoomsYN
            - HouseRoomsSoldYN
            - HouseHouseUseRoomsYN
            - HouseSellLimitYN
            - HouseTentRoomsExcludingOverbookingYN
            - HouseTentRoomsSoldYN
            - HouseTentRoomsYN
            - HouseWaitlistRoomsYN
            - HouseAverageDailyRateYN
            - HouseRevPARYN
            - NonOwnerExclusiveYN
            - OutOfOrderRoomsYN
            - OwnerExclusiveYN
            - RestrictionsYN
            - RoomArrPersonsYN
            - RoomArrRoomsYN
            - RoomExpectedArrRoomsYN
            - RoomAvailRoomsExcludingOverbookingYN
            - RoomAvailRoomsYN
            - RoomBlkDeductNpuYN
            - RoomBlkDeductPuYN
            - RoomBlkTentNpuYN
            - RoomBlkTentPuYN
            - RoomCancelledYN
            - RoomClassList
            - RoomCompRoomsYN
            - RoomDayUsePersonYN
            - RoomDayUseRoomYN
            - RoomDepPersonsYN
            - RoomDepRoomsYN
            - RoomHouseUseRoomsYN
            - RoomInventoryRoomsYN
            - RoomMaxAvailabilityExcludingOverbookingYN
            - RoomMaxAvailabilityYN
            - RoomMaxOccupancyYN
            - RoomMinAvailabilityExcludingOverbookingYN
            - RoomMinAvailabilityYN
            - RoomOccupancyYN
            - RoomOOOYN
            - RoomOOSRoomsYN
            - RoomOverBookingYN
            - RoomPeopleInHouseYN
            - RoomPhysicalRoomsYN
            - RoomRestrictionsYN
            - RoomRoomsSoldYN
            - RoomSellLimitYN
            - RoomTentRoomsExcludingOverbookingYN
            - RoomTentRoomsYN
            - RoomTentYN
            - RoomTypeWildCardList
            - RoomWaitlistRoomsYN
            - HouseAdultsInHouseYN
            - HouseChildrenInHouseYN
            - HouseChildren1InHouseYN
            - HouseChildren2InHouseYN
            - HouseChildren3InHouseYN
            - HouseArrAdultsYN
            - HouseArrChildrenYN
            - HouseArr1ChildrenYN
            - HouseArr2ChildrenYN
            - HouseArr3ChildrenYN
            - RoomAdultsInHouseYN
            - RoomChildrenInHouseYN
            - RoomChildren1InHouseYN
            - RoomChildren2InHouseYN
            - RoomChildren3InHouseYN
            - RoomArrAdultsYN
            - RoomArrChildrenYN
            - RoomArr1ChildrenYN
            - RoomArr2ChildrenYN
            - RoomArr3ChildrenYN
            - CalendarEventsYN
            - RoomAverageDailyRateYN
            - RoomRevPARYN
      - name: parameterValue
        in: query
        description: Value of the parameter.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      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: Object that holds the details of inventory Statistics.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/inventoryStatistics'
        '204':
          description: InventoryStatistics not found.
        '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'
      tags:
      - INVStats
  /services/invStatsService/status:
    get:
      summary: Ping
      description: Check inventory statistics service <p><strong>OperationId:</strong>pinginvStatsService</p>
      operationId: pinginvStatsService
      parameters:
      - $ref: '#/components/parameters/authKey'
      - $ref: '#/components/parameters/externalData'
      - $ref: '#/components/parameters/x-app-key'
      - $ref: '#/components/parameters/x-request-id'
      - $ref: '#/components/parameters/x-originating-application'
      - $ref: '#/components/parameters/x-hotelid'
      - $ref: '#/components/parameters/x-externalsystem'
      - $ref: '#/components/parameters/Accept-Language'
      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 for Ping operation.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/pingDetail'
        '204':
          description: pinginvStatsService not found.
        '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'
      tags:
      - INVStats
components:
  schemas:
    codeDescriptionType:
      type: object
      description: This contains a generic code and description information.
      properties:
        code:
          description: Code.
          type: string
          minLength: 0
          maxLength: 20
        description:
          description: description.
          type: string
          minLength: 0
          maxLength: 2000
    statusSummaryStatisticType:
      type: array
      description: Statistic summary for a particular status.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/statusStatisticType'
    rateProtectionType:
      type: string
      description: Simple type for specifying the block protection type.
      enum:
      - All
      - Selected
      - None
    usedInModuleType:
      type: string
      description: Simple type for indicating the module for which user wants to create the SellMessage. Valid module types are Look To Book Sales,Reservations,Blocks,Function Diary and Group Rooms Control.
      enum:
      - Blocks
      - Reservations
      - FunctionDiary
      - LookToBookSales
      - GroupRoomsControl
    statisticUnitsType:
      type: array
      description: Unit type to hold statistic code and value pair.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/statisticUnitType'
    statisticCodeType:
      type: object
      description: Defines the codes and corresponding categories for which the data in the other elements has been gathered.
      properties:
        statisticDate:
          description: Collection of statistic summary data.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/statisticSetType'
        statCode:
          description: Actual code used by the system to collect the statistics (e.g. CORP, RACK if category is Market Segment).
          type: string
          minLength: 0
          maxLength: 20
        statCategoryCode:
          description: Category Code category of StatCode attribute (e.g. Market Segment).
          type: string
          minLength: 0
          maxLength: 40
        statCodeClass:
          description: Class grouping of StatCode attribute.
          type: string
          minLength: 0
          maxLength: 40
        description:
          description: Statistic code description.
          type: string
          minLength: 0
          maxLength: 2000
    blockDetailStatisticType:
      type: object
      description: Information and statistic summary for a particular block.
      properties:
        blockInformation:
          description: Contains information like Block Name, Account Name, Average Room Rate of the block.
          $ref: '#/components/schemas/blockInfoType'
        blockStatistics:
          description: Statistic summary for the block.
          $ref: '#/components/schemas/blockStatusStatisticsType'
    blockNonCompeteType:
      type: object
      description: Block Non Compete code information.
      properties:
        industry:
          description: Specifies the Non-Compete Industry.>
          type: string
          minLength: 0
          maxLength: 20
        industryDescription:
          description: Specifies the Non-Compete Industry description.>
          type: string
          minLength: 0
          maxLength: 2000
        criteria:
          description: Indicates the type of Non-Compete. 'All' means all dates are Non-Compete. 'None' specifies Non-Compete is disabled. 'Selected' specifies few dates are Non-Compete.
          $ref: '#/components/schemas/rateProtectionType'
        protectedDates:
          description: Specifies all the Non-Compete dates in the selected date range.
          $ref: '#/components/schemas/datesType'
    instanceLink:
      type: object
      description: Metadata describing link description objects that MAY appear in the JSON instance representation.
      properties:
        href:
          description: URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true.
          type: string
        rel:
          description: Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.
          type: string
        templated:
          description: Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.
          type: boolean
          default: false
        method:
          description: HTTP method for requesting the target of the link.
          type: string
          enum:
          - GET
          - POST
          - PUT
          - DELETE
          - PATCH
          - OPTIONS
          - HEAD
        targetSchema:
          description: Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
          type: string
        operationId:
          description: The operationId of the path you can call to follow this link.  This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply.
          type: string
        title:
          description: Exact copy of the "summary" field on the linked operation.
          type: string
    sellMessageType:
      type: object
      description: The SellMessagesType defines the standard attributes that will be retrieved with the sell message.
      properties:
        message:
          description: This is the message text.
          type: string
          minLength: 0
          maxLength: 2000
        croCode:
          description: This is the Central Reservation office code.
          type: string
          minLength: 0
          maxLength: 20
        chainCode:
          description: This is the chain code.
          type: string
          minLength: 0
          maxLength: 20
        hotelId:
          description: This is the hotel code or resort.
          type: string
          minLength: 0
          maxLength: 20
        roomType:
          description: This represents the room type code.
          type: string
          minLength: 0
          maxLength: 20
        ratePlanCode:
          description: This represents the rate plan code of the room type.
          type: string
          minLength: 0
          maxLength: 20
        languageCode:
          description: This is the language code.
          type: string
          minLength: 0
          maxLength: 20
        stickyFlagYn:
          description: Flag which tells if this message is Sticky (Y/N).
          type: string
          minLength: 0
          maxLength: 1
        usedInModule:
          description: This represents the correct moduletype which should be used for fetching SellMessages.
          $ref: '#/components/schemas/usedInModuleType'
        beginDate:
          description: This is the Begin date for the configured SellMessage.
          type: string
          format: date
          maxLength: 8
        url:
          description: URL that identifies the location associated with the record identified by the UniqueID.
          type: string
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 20
        instance:
          description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.
          type: string
          minLength: 0
          maxLength: 80
        idContext:
          description: Used to identify the source of the identifier (e.g., IATA, ABTA).
          type: string
          minLength: 0
          maxLength: 80
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        idExtension:
          description: Additional identifying value assigned by the creating system.
          type: integer
    errorInstance:
      title: Error Instance Details
      description: Complex type that contains error instance details for a REST call.
      type: object
      properties:
        type:
          type: string
          description: Absolute URI [RFC3986] that identifies the problem type.  When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML).
        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.
        status:
          type: integer
          description: HTTP status code for this occurrence of the problem, set by the origin server.
        detail:
          type: string
          description: Human-readable description specific to this occurrence of the problem.
        instance:
          type: string
          description: Absolute URI that identifies the specific occurrence of the problem.  It may or may not provide additional information if dereferenced.
        o:errorCode:
          type: string
          description: Application error code, which is different from HTTP error code.
        o:errorPath:
          type: string
          description: Path to the problem at the resource or property level.
      required:
      - type
      - title
    blockInfoType:
      type: object
      description: Contains information of the business block .
      properties:
        hotelId:
          description: The hotel code of the business block.
          type: string
          minLength: 0
          maxLength: 20
        blockId:
          description: The unique identifier of the business block.
          $ref: '#/components/schemas/uniqueID_Type'
        blockName:
          description: Name of the business block.
          type: string
          minLength: 0
          maxLength: 2000
        blockCode:
          description: Block code for the block.
          type: string
          minLength: 0
          maxLength: 20
        startDate:
          description: Start date for this block.
          type: string
          format: date
          maxLength: 8
        endDate:
          description: End date for this block.
          type: string
          format: date
          maxLength: 8
        cutOffDate:
          description: Date after which unused block rooms should be returned to house.
          type: string
          format: date
          maxLength: 8
        blockStatus:
          description: Code and Description used to define a status e.g. (INT, TENT, DEF, CXL) (initial, tentative, definite, cancelled).
          $ref: '#/components/schemas/codeDescriptionType'
        blockStatusColor:
          description: Color from block status configuration.
          $ref: '#/components/schemas/statusColorType'
        accountId:
          description: The unique identifier of the Account Name.
          $ref: '#/components/schemas/uniqueID_Type'
        accountName:
          description: Account name attached to the business block.
          type: string
          minLength: 0
          maxLength: 200
        contactId:
          description: The unique identifier of the Contact Name.
          $ref: '#/components/schemas/uniqueID_Type'
        contactName:
          description: Contact name attached to the business block.
          type: string
          minLength: 0
          maxLength: 200
        roomSalesManager:
          description: Room Sales Manager Code and Name attached to the business block.
          $ref: '#/components/schemas/codeDescriptionType'
        currencyCode:
          description: Currency Code attached to the business block.
          type: string
          minLength: 0
          maxLength: 20
        averageRoomRate:
          description: Average room rate of the business block.
          type: number
        conversionCode:
          description: Indicates the likelihood of the block moving to the next active block status.
          type: string
          minLength: 0
          maxLength: 20
        rankingCode:
          description: Indicates the ranking of the block.
          type: string
          minLength: 0
          maxLength: 20
        guaranteeCode:
          description: Guarantee Code for the block.
          type: string
          minLength: 0
          maxLength: 20
        rateProtectionDetails:
          description: Indicates the Rate Protection details for the block.
          $ref: '#/components/schemas/blockRateProtectionType'
        nonCompeteDetails:
          description: Indicates the non-competing industry details.
          $ref: '#/components/schemas/blockNonCompeteType'
        blockClassification:
          description: Indicate Block Classification.
          $ref: '#/components/schemas/blockClassificationType'
    warningType:
      type: object
      description: Used when a message has been successfully processed to report any warnings or business errors that occurred.
      properties:
        value:
          type: string
          description: Property Value
        shortText:
          description: An abbreviated version of the error in textual format.
          type: string
          maxLength: 2000
        code:
          description: If present, this refers to a table of coded values exchanged between applications to identify errors or warnings.
          type: string
          minLength: 0
          maxLength: 20
        docURL:
          description: If present, this URL refers to an online description of the error that occurred.
          type: string
          maxLength: 2000
        status:
          description: If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.
          type: string
          maxLength: 2000
        tag:
          description: If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].
          type: string
          maxLength: 2000
        recordId:
          description: If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.
          type: string
          maxLength: 2000
        type:
          description: The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown".
          type: string
          minLength: 0
          maxLength: 20
        language:
          description: Language identification.
          type: string
          pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
        rph:
          description: Reference Place Holder used as an index for this warning.
          type: string
          minLength: 1
          maxLength: 8
    numericCategorySummaryType:
      type: object
      description: This element has count data for each count category such as number of guests, rooms occupied, etc.
      properties:
        value:
          description: The total count for the category in NumericCategoryCode.
          type: number
        code:
          description: 'The representation of a numeric category such as Guests : Number of guests, RoomsOcc : Rooms occupied.'
          type: string
          minLength: 0
          maxLength: 40
    exceptionDetailType:
      title: Error Detail
      description: Complex type that contains error details for a REST call.
      type: object
      properties:
        type:
          type: string
          description: Absolute URI [RFC3986] that identifies the problem type.  When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML).
        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.
        status:
          type: integer
          description: HTTP status code for this occurrence of the problem, set by the origin server.
        detail:
          type: string
          description: Human-readable description specific to this occurrence of the problem.
        instance:
          type: string
          description: Absolute URI that identifies the specific occurrence of the problem.  It may or may not provide additional information if dereferenced.
        o:errorCode:
          type: string
          description: Application error code, which is different from HTTP error code.
        o:errorPath:
          type: string
          description: Path to the problem at the resource or property level.
        o:errorDetails:
          description: Details of the error message, consisting of a hierarchical tree structure.
          type: array
          items:
            $ref: '#/components/schemas/errorInstance'
        links:
          $ref: '#/components/schemas/links'
      required:
      - type
      - title
    datesType:
      type: array
      description: Specifies a single date.
      maxItems: 4000
      items:
        type: string
        format: date
        maxLength: 8
    propertyStatisticUnitType:
      type: object
      description: Unit type to hold statistic code and value pair e.g. [resort - value] [BHOTEL - 20] [MHOTEL - 30] and its sub units per property wise
      properties:
        hotelId:
          description: Unique ID of the hotel.
          type: string
        value:
          description: Value of the statistic unit.
          type: integer
          format: int32
    blockStatusStatisticType:
      type: object
      description: Contains summary statistic for a block on a particular statistic date.
      properties:
        statusSummaryStatistic:
          description: Statistic summary for each status (Blocked, Pickup, Contract).
          $ref: '#/components/schemas/statisticUnitsType'
        statisticDate:
          description: Date of the statistic.
          type: string
          format: date
          maxLength: 8
    statisticUnitType:
      type: object
      description: Unit type to hold statistic code and value pair e.g. [code - value] [Definite - 20] [Sales Allowance - 30] and its sub units.
      properties:
        code:
          description: Code of the statistic unit.
          type: string
        value:
          description: Value of the statistic unit.
          type: string
        propertyBookingSummaryStatistics:
          type: array
          description: Statistic summary for a particular status for a particular property
          maxItems: 4000
          items:
            $ref: '#/components/schemas/propertyStatisticUnitType'
    revenueCategorySummaryType:
      type: object
      description: This element has revenue amount data for its revenue category such as Room Revenue, Food and Beverage Revenue.
      properties:
        code:
          description: The representation of a revenue category.
          type: string
          minLength: 0
          maxLength: 40
        amount:
          description: A monetary amount.
          type: number
        currencyCode:
          description: Provides a currency code to reflect the currency in which an amount may be expressed.
          type: string
          minLength: 3
          maxLength: 3
    blockClassificationType:
      type: string
      description: Simple type for block instructions to be used in requests for fetching blocks. Valid status values are MASTER_BLOCK, MASTER_TOUR, FIT_MASTER, MASTER_ALLOCATION, MASTER_ITINERARY, LEAD_MASTER, REGULAR_BOOKING, SUB_BLOCK, SUB_TOUR, FIT_CONTRACT, SUB_ALLOCATION, SUB_ITINERARY, LEAD.
      enum:
      - MasterBlock
      - MasterTour
      - MasterAllocation
      - MasterItinerary
      - LeadMaster
      - RegularBooking
      - SubBlock
      - SubTour
      - FitContract
      - SubAllocation
      - SubItinerary
      - Lead
      - FitMaster
      - Opportunity
    sellMessagesType:
      type: object
      description: The SellMessagesType is the list of message and attributes returned by web service.
      properties:
        sellMessage:
          description: This is the message text.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/sellMessageType'
        hasMore:
          description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
          type: boolean
        totalResults:
          description: Total number of rows queried
          type: integer
        count:
          description: Total number of rows returned
          type: integer
    blockSummaryStatisticsType:
      type: array
      description: Statistic units group by status, booking and daily targets.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/blockSummaryStatisticType'
    blockInventoryStatistic:
      type: object
      description: Response object for information regarding Block Inventory Statistics.
      properties:
        blockInventoryStatistics:
          description: List of block inventory statistics that is grouped by statistic date.
          type: object
          properties:
            blockInventoryStatistic:
              description: Summary and Detail statistic for block inventory that is group by statistic date.
              type: array
              items:
                $ref: '#/components/schemas/blockInventoryStatisticType'
            totalPages:
              description: Evaluated total page count based on the requested max fetch count.
              type: integer
            offset:
              description: Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned.
              type: integer
            limit:
              description: Indicates maximum number of records a Web Service should return.
              type: integer
            allRowsFetched:
              description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.
              type: boolean
            totalRows:
              description: Total number of rows queried
              type: integer
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    statisticSetType:
      type: object
      description: An instance of a statistic, which is a set containing revenue category and number category summaries.
      properties:
        revenue:
          description: Collection of RevenueCategorySummary elements. Used if revenue values reported.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/revenueCategorySummaryType'
        inventory:
          description: Collection of CountCategorySummary elements. Used if count values reported.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/numericCategorySummaryType'
        statisticDate:
          description: Date of the statistic.
          type: string
          format: date
          maxLength: 8
        weekendDate:
          description: Determines whether statistic date is a weekend date.
          type: boolean
    blockRateProtectionType:
      type: object
      description: Block Rate Protection code information.
      properties:
        criteria:
          description: Indicates the type of rate protection. 'All' means all dates are rate protected. 'None' specifies no rate protection. 'Selected' specifies few dates are rate protected.
          $ref: '#/components/schemas/rateProtectionType'
        protectedDates:
          description: Specifies all the Rate protected dates in the selected range.
          $ref: '#/components/schemas/datesType'
    statusStatisticType:
      type: object
      description: List of statistic units for a particular status.
      properties:
        statisticUnit:
          description: Unit type to hold statistic code and value pair.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/statisticUnitType'
        status:
          description: Status type of statistic, e.g. Definite.
          type: string
    warningsType:
      type: array
      description: Used in conjunction with the Success element to define a business error.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/warningType'
    inventoryStatistics:
      type: array
      description: List of inventory statistics that is grouped by statistic date.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/statisticType'
    links:
      type: array
      items:
        $ref: '#/components/schemas/instanceLink'
    operaVersionNumberType:
      type: string
      description: Current Opera Version Number
      minLength: 0
      maxLength: 40
    statisticType:
      type: object
      description: Defines all details needed to create a statistical report.
      properties:
        statistics:
          description: Statistic Codes.
          type: array
          maxItems: 4000
          items:
            $ref: '#/components/schemas/statisticCodeType'
        hotelName:
          description: A text field used to communicate the proper name of the hotel.
          type: string
          minLength: 0
          maxLength: 80
        reportCode:
          description: Identifies the type of statistics collected. Each ReportCode corresponds to a set of category summaries based upon a predetermined agreement.
          type: string
          minLength: 0
          maxLength: 100
        description:
          description: This element has revenue amount data for its revenue category such as Room Revenue, Food and Beverage Revenue.
          type: string
          minLength: 0
          maxLength: 2000
    blockDetailStatisticsType:
      type: array
      description: Compose of block information and statistic summary for a particular block.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/blockDetailStatisticType'
    blockStatusStatisticsType:
      type: array
      description: Summary statistics of a block for each date.
      maxItems: 4000
      items:
        $ref: '#/components/schemas/blockStatusStatisticType'
    uniqueID_Type:
      type: object
      description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).
      properties:
        id:
          description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
          type: string
          minLength: 0
          maxLength: 80
        type:
          description: A reference to the type of object defined by the UniqueID element.
          type: string
          minLength: 0
          maxLength: 40
    statusColorType:
      type: string
      description: Status code color configuration type.
      enum:
      - White
      - Red
      - Blue
      - Cyan
      - Magenta
      - Green
      - Brown
      - Black
      - Yellow
      - Gray
    blockSummaryStatisticType:
      type: object
      description: Statistic units group by status, booking and daily targets.
      properties:
        statusSummaryStatistic:
          description: List of Statistic Units for Status Types e.g. Definite, Inquiry, Actual.
          $ref: '#/components/schemas/statusSummaryStatisticType'
        bookingSummaryStatistic:
          description: List of Statistic Units for Booking types e.g. Sales Allowance, Total House Availability.
          $ref: '#/components/schemas/statisticUnitsType'
        dailyTargetsSummaryStatistic:
          description: List of Statistic Units for Daily Targets types e.g. Room Nights, Room Rates, Room Revenue.
          $ref: '#/components/schemas/statisticUnitsType'
        statisticDate:
          description: Date of the block inventory statistic.
          type: string
          format: date
          maxLength: 8
    pingDetail:
      type: object
      description: Response for Ping operation.
      properties:
        operaVersion:
          description: Opera version number.
          $ref: '#/components/schemas/operaVersionNumberType'
        links:
          $ref: '#/components/schemas/links'
        warnings:
          $ref: '#/components/schemas/warningsType'
    blockInventoryStatisticType:
      type: object
      description: Summary and Detail statistics for block inventory.
      properties:
        blockSummaryStatistics:
          description: Summary statistic for all blocks.
          $ref: '#/components/schemas/blockSummaryStatisticsType'
        blockDetailStatistics:
          description: Detailed summary statistics for each block.
          $ref: '#/components/schemas/blockDetailStatisticsType'
        sellMessages:
          description: Group Rooms Control Sell Messages configured for a particular date range.
          $ref: '#/components/schemas/sellMessagesType'
  responses:
    '406':
      description: Not acceptable.
    '414':
      description: Request URI Too Large
    '400':
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '403':
      description: Forbidden
    '413':
      description: Request Entity Too Large
    '415':
      description: Unsupported Media Type
    '404':
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '502':
      description: Bad Gateway
    '500':
      description: System Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/exceptionDetailType'
    '503':
      description: Service Unavailable
    '401':
      description: Unauthorized
    '405':
      description: Method not allowed
  parameters:
    x-hotelid:
      name: x-hotelid
      description: Mandatory parameter to identify the hotel code where the endDate user is logged in
      in: header
      required: true
      schema:
        type: string
    x-app-key:
      name: x-app-key
      description: Client or Partner's Application Key
      in: header
      required: true
      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}$
    authKey:
      name: authorization
      description: Bearer token that needs to be passed which is generated post user authentication
      in: header
      required: true
      schema:
        type: string
    x-externalsystem:
      name: x-externalsystem
      description: External system code.
      in: header
      x-example: EXTERNALSYSTEMCODE
      schema:
        type: string
        maxLength: 40
    externalData:
      name: externalData
      description: Pass this header as true, if payload needs DVM
      in: header
      schema:
        type: string
    x-originating-application:
      name: x-originating-application
      description: Customer's Integration Application Id
      in: header
      schema:
        type: string
    Accept-Language:
      name: Accept-Language
      description: Language code
      in: header
      schema:
        type: string
    x-request-id:
      name: x-request-id
      description: Request Id of an incoming request
      in: header
      schema:
        type: string
        pattern: ~*[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
externalDocs:
  description: Find out more about Oracle Hospitality
  url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html