Oracle Hospitality Block API

openapi: 3.2.0
info:
  title: OPERA Cloud Block API
  description: APIs to cater for Business Block functionality in OPERA Cloud. <br /><br /> A block is a group of rooms held for guests who are attending an event, meeting, or function. You can create blocks for family reunions, business conferences, weddings, and so on. You can also set aside rooms for the event (block).<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: /blk/v1
tags:
- name: Block
  description: These APIs will allow you to completely create and manage your block in OPERA Cloud - including all related functionalities of a block such as manage Room allocation, Status update, block reservations.You can search for a block, get a Block, update and create new Blocks.
paths:
  /allocation:
    post:
      summary: Create Sub allocation
      description: Use this API to create sub allocation. <p><strong>OperationId:</strong>postSubAllocation</p>
      operationId: postSubAllocation
      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:
        '201':
          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})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: HATEOAS links which help the consumer to navigate to resources
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '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:
      - Block
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/subAllocation'
        description: Request object for creation of Sub Allocation. This object contains sub allocation details with unique identifiers for each sub allocation along with Master Allocation information. The standard optional Opera Context element is also included.
        required: true
  /blockActivityLog:
    get:
      summary: Get the Block activity log
      description: Use this API to facilitate retrieving the block activity log. <p><strong>OperationId:</strong>getBlockActivityLog</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: getBlockActivityLog
      parameters:
      - 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: hotelId
        in: query
        required: false
        description: Hotel code.
        schema:
          type: string
      - name: module
        in: query
        required: false
        description: Activity module.
        schema:
          type: string
          enum:
          - Reservation
          - Contract
          - Allotment
          - Outlookview
          - Profile
          - Accountreceivables
          - GdsConvRateCodes
          - RateCode
          - Billing
          - Activity
          uniqueItems: true
      - name: moduleParamsParameterName
        in: query
        description: Name of the parameter.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: moduleParamsParameterValue
        in: query
        description: Value of the parameter.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: activityGroup
        in: query
        required: false
        schema:
          type: string
      - name: activityType
        in: query
        required: false
        schema:
          type: string
      - name: activityParamsFromDate
        in: query
        required: false
        description: Search from date for the user activity log.
        schema:
          type: string
          format: date
      - name: activityParamsToDate
        in: query
        required: false
        description: Search to date for the user activity log.
        schema:
          type: string
          format: date
      - name: activityParamsSearchText
        in: query
        required: false
        description: Search text for the user activity log.
        schema:
          type: string
      - name: userByIDsUserId
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
          maxItems: 4000
      - name: userForIDsUserId
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
          maxItems: 4000
      - $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 fetching block activity log. This object contains collection of user activity log for the block, Success, Warnings and Errors related to this operation
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/blockActivityLog'
        '204':
          description: BlockActivityLog 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:
      - Block
  /blockWash:
    put:
      summary: Update Block Allocation Wash
      description: This API removes block allocation to a range of dates for a set of room types. <p><strong>OperationId:</strong>putBlockAllocationWash</p>
      operationId: putBlockAllocationWash
      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})*'
            Location:
              description: Location of newly created resource
              schema:
                type: string
          description: Response Body.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/status'
        '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:
      - Block
      requestBody:
        content:
          application/json;charset=UTF-8:
            schema:
              allOf:
              - $ref: '#/components/schemas/blockAllocationWash'
        description: Request object for block wash operation.
        required: true
    get:
      summary: Get Block Wash Information
      description: This API retrieves block information needed to perform block wash operation. <p><strong>OperationId:</strong>getBlockWashInfo</p>
      operationId: getBlockWashInfo
      parameters:
      - name: hotelId
        in: query
        required: false
        description: Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
        schema:
          type: string
      - name: blockId
        in: query
        required: false
        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.
        schema:
          type: string
      - name: blockIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: genericRoomType
        in: query
        required: false
        description: Indicates if the Allocation objects refer to Generic Room Types (Room Pools).
        schema:
          type: boolean
      - $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: Block information required for performing a wash operation on a block.
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/blockWashInfo'
        '204':
          description: BlockWashInfo 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:
      - Block
  /blocks:
    get:
      summary: Get Blocks
      description: Use this API to retrieve a list of blocks for requested query parameters. A wide range of query parameters is available to support various persona requirements, so it is recommended to include, at least, the hotel block date range, stay date range, and/or number of days as query parameters. You can use more query parameters to narrow your results. This API is not designed to support sync between two systems or initial upload of data. If x-hubid is used as a header, it returns matching data from multiple hotels within the same chain. <p><strong>OperationId:</strong>getBlocks</p> <p>The maximum allowable limit for this API is <strong>200</strong>.</p>
      operationId: getBlocks
      deprecated: true
      parameters:
      - name: hotelId
        in: query
        required: false
        schema:
          type: string
      - name: markAsRecentlyAccessed
        in: query
        required: false
        description: Mark this block as recently accessed.
        schema:
          type: boolean
      - name: limit
        in: query
        required: false
        description: Indicates maximum number of records a Web Service should return.
        schema:
          type: integer
          maximum: 200
      - 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: multipleHotelsSearchHotelIds
        in: query
        description: Hotel code.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: superSearch
        in: query
        required: false
        description: Free form text field for searching block fields
        schema:
          type: string
      - name: blockIdList
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: blockIdType
        in: query
        description: A reference to the type of object defined by the UniqueID element.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: externalReferenceIds
        in: query
        description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: externalSystemCodes
        in: query
        description: Used to identify the source of the identifier (e.g., IATA, ABTA).
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: blockCode
        in: query
        required: false
        description: Block code
        schema:
          type: string
      - name: blockName
        in: query
        required: false
        description: Block Name
        schema:
          type: string
      - name: blockOwner
        in: query
        description: Block Owner.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: blockStatus
        in: query
        description: Block Status.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: cateringStatus
        in: query
        description: Catering Status.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: reservationMethod
        in: query
        description: Mode of reservation (e.g. EML, TEL, FRTDSK ).
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            maxLength: 20
          maxItems: 50
      - name: createdByUser
        in: query
        required: false
        description: user who created the Block(s).
        schema:
          type: string
      - name: blockStartEndDate
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: blockStartStartDate
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: blockEndEndDate
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: blockEndStartDate
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: reservationArrival
        in: query
        required: false
        description: Date when guests plan to arrive(first night stay date).
        schema:
          type: string
          format: date
      - name: reservationDeparture
        in: query
        required: false
        description: Date when guests plan to leave(last stay day date).
        schema:
          type: string
          format: date
      - name: includeShoulderDates
        in: query
        required: false
        description: Whether to include shoulder dates when considering stay date.
        schema:
          type: boolean
      - name: stayDate
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: blockCreatedOnEndDate
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: blockCreatedOnStartDate
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: decisionEndDate
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: decisionStartDate
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: cutOffEndDate
        in: query
        required: false
        description: The ending value of the date range.
        schema:
          type: string
          format: date
      - name: cutOffStartDate
        in: query
        required: false
        description: The starting value of the date range.
        schema:
          type: string
          format: date
      - name: category
        in: query
        description: Simple type for block instructions to be used in requests for fetching blocks. Valid status values are Group, Source, TravelAgent, Contact, Company.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Group
            - Source
            - Agent
            - Contact
            - Company
            - Account
          uniqueItems: true
      - name: name
        in: query
        description: Attached profile name
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: attachedProfileId
        in: query
        required: false
        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.
        schema:
          type: string
      - name: attachedProfileIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: leads
        in: query
        required: false
        description: Show Leads in the search result.
        schema:
          type: boolean
      - name: tourSeries
        in: query
        required: false
        description: Show tour series in the search result.
        schema:
          type: boolean
      - name: onlyPickupBlocks
        in: query
        required: false
        description: Fetch only blocks which are open for pickup, if true. If the value is false, fetch all block statuses.
        schema:
          type: boolean
      - name: onlyOpportunities
        in: query
        required: false
        description: Indicates that only Opportunity blocks will be fetched.
        schema:
          type: boolean
      - name: excludeMasterBlocks
        in: query
        required: false
        description: Indicates that all master blocks will be excluded from the results. (Master Blocks, Master Allocations, Master Tours, and Master Itineraries).
        schema:
          type: boolean
      - name: ratePlanCode
        in: query
        description: Rate Plan Code.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: tourCode
        in: query
        required: false
        description: Tour code for the block.
        schema:
          type: string
      - name: attributeName
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: orderType
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Asc
            - Desc
          uniqueItems: true
      - name: returnEligibleMasterAllocations
        in: query
        description: Return only master allocations that are eligible to be the master for the business block to be converted to sub allocation specified in `targetSubAllocationBlockId`.
        required: false
        schema:
          type: boolean
      - name: targetSubAllocationBlockId
        in: query
        description: The ID of the regular business block that is being converted to sub allocation.
        required: false
        schema:
          type: string
      - name: returnEligibleMasterTours
        in: query
        description: Return only master tours or master itineraries that are eligible to be the master for the business block being converted to either a sub tour or a sub itinerary.
        required: false
        schema:
          type: boolean
      - name: fetchInstructions
        in: query
        description: Type for block instructions that can be used in requests for partial operations.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - AccessExclusions
            - Aliases
            - AlternateDates
            - Attachments
            - Block
            - BlockNextStatuses
            - BlockStatusHistory
            - CatNextStatuses
            - CatStatusHistory
            - CentralSalesLeads
            - Comments
            - DateProtect
            - ExternalReferences
            - GenericRateGrid
            - Header
            - Indicators
            - InventoryItems
            - Owners
            - Packages
            - Policies
            - PrimaryOwners
            - PrimaryProfiles
            - PrimaryRates
            - Profiles
            - RateGrid
            - RateProgram
            - Rates
            - Restrictions
            - SellMessages
            - Statistics
            - SummaryStatistics
            - Traces
            - WashSchedules
            - IncludeSubBlocks
          uniqueItems: true
      - name: fetchAllocatedRoomTypes
        in: query
        required: false
        description: Indicates whether to fetch only those room types that have rooms allocated. If this flag is true then only those room types with rooms allocated for the block are fetched. Only applicable to fetch instruction RateGrid.
        schema:
          type: boolean
      - name: additionalCriteriaStartDate
        in: query
        required: false
        description: Start Date for the rate grid data. Only applicable to fetch instruction RateGrid.
        schema:
          type: string
          format: date
      - name: numberOfDays
        in: query
        required: false
        description: Number of days to fetch for the rate grid data. Only applicable to fetch instruction RateGrid.
        schema:
          type: number
      - name: adults
        in: query
        required: false
        description: Defines the number of Adults.
        schema:
          type: integer
      - name: children
        in: query
        required: false
        description: Defines the number of Children.
        schema:
          type: integer
      - name: childAge
        in: query
        description: Age of a child in years.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
      - name: bucket1Count
        in: query
        required: false
        description: Number of children classified under the first Age Qualifying Group(Child Bucket#1).
        schema:
          type: integer
      - name: bucket2Count
        in: query
        required: false
        description: Number of children classified under the second Age Qualifying Group(Child Bucket#2).
        schema:
          type: integer
      - name: bucket3Count
        in: query
        required: false
        description: Number of children classified under the third Age Qualifying Group(Child Bucket#3).
        schema:
          type: integer
      - name: bucket4Count
        in: query
        required: false
        description: Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).
        schema:
          type: integer
      - name: bucket5Count
        in: query
        required: false
        description: Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).
        schema:
          type: integer
      - name: existingReservationId
        in: query
        required: false
        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.
        schema:
          type: string
      - name: existingReservationIdType
        in: query
        required: false
        description: A reference to the type of object defined by the UniqueID element.
        schema:
          type: string
      - name: roomAllocationCriteria
        in: query
        description: Simple type for block allocation used in room rate grid.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Initial
            - Actual
            - Rates
            - Pickup
            - Contract
            - Available
            - Pickupperc
            - Changes
            - Released
            - Houseavailability
            - SellLimit
            - AvailableSellLimit
            - MasterAllocInitial
            - Allocated
            - SubAllocResv
            - CutoffDate
          uniqueItems: true
      - name: roomType
        in: query
        description: The Room Types that need to be fetched for the rate room grid data. If these values are not provided, all room types for the block will be fetched.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 4000
      - name: additionalCriteriaRatePlanCode
        in: query
        required: false
        description: Rate Plan to use for fetching rates.
        schema:
          type: string
      - name: currencyCode
        in: query
        required: false
        description: Curency in which the grid rates should be fetched.
        schema:
          type: string
      - name: accessRestriction
        in: query
        description: Simple type for block access exclusion/restriction types.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - Availability
            - Create
            - Modify
            - Cancel
          uniqueItems: true
      - name: cateringOnly
        in: query
        required: false
        description: Filter blocks which are marked as Catering only. Only Catering only blocks are returned when true.
        schema:
          type: boolean
      - name: marketCode
        in: query
        description: Filter blocks based on market code, If not provided all the blocks will be returned.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 40
      - name: sourceCode
        in: query
        description: Filter blocks based on source code, If not provided all the blocks will be returned.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          maxItems: 40
      - $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'
   

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