APIs to cater Block Reservation related asynchronous functionality in OPERA. Compatible with OPERA Cloud release 26.2.0.0. 14 operation(s) documented; base path /blk/async/v1. Harvested verbatim from Oracle's public hospitality-api-docs repository (Swagger 2.0, release 26.2.0.0).
{
"swagger": "2.0",
"info": {
"title": "OPERA Cloud Block Reservation Asynchronous API",
"description": "APIs to cater Block Reservation related asynchronous functionality in OPERA.<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"
}
},
"schemes": [
"https"
],
"basePath": "/blk/async/v1",
"produces": [
"application/json"
],
"paths": {
"/externalSystems/{extSystemCode}/hotels/{hotelId}/blocks/allocationSummary": {
"post": {
"summary": "This API facilitates fetching block allocation summary for a Hotel.",
"description": "This API will fetch Block allocation information for a hotel, and specified date range. The block allocated inventory, rates and room type statistics are returned as part of the response. The maximum limit of date range (whether using start/endDate or startLastModifiedDate/endLastModifiedDate) is 94 days, but the recommendation is to use a date range proportionate to the size of the hotel. Every identical request (employing the same query parameters) for the getBlockAllocationSummary operation when requesting data with start/endDate or startLastModifiedDate/endLastModifiedDate, necessitates a mandatory 30-minute interval between submissions. Please note that this limit applies regardless of whether the POST, HEAD, and GET cycle has been completed. The API returns a header parameter location that can be used in the getBlockAllocationSummaryProcessStatus operation. Use event-driven APIs -(see https://docs.oracle.com/cd/F29336_01/doc.201/f27480/c_business_events.htm#OHIPU-BusinessEvents-F0AC1F1C) -to get real-time block updates. <p><strong>OperationId:</strong>startBlockAllocationSummaryProcess</p>",
"operationId": "startBlockAllocationSummaryProcess",
"x-interaction": [
"async-polling"
],
"responses": {
"202": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
},
"Location": {
"type": "string",
"description": "Location of process status resource"
}
},
"description": "HATEOAS links which help the consumer to navigate to resources",
"schema": {
"$ref": "#/definitions/links"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"405": {
"$ref": "#/responses/405"
},
"406": {
"$ref": "#/responses/406"
},
"413": {
"$ref": "#/responses/413"
},
"414": {
"$ref": "#/responses/414"
},
"415": {
"$ref": "#/responses/415"
},
"500": {
"$ref": "#/responses/500"
},
"502": {
"$ref": "#/responses/502"
},
"503": {
"$ref": "#/responses/503"
}
},
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000
},
{
"name": "extSystemCode",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000
},
{
"name": "criteria",
"in": "body",
"required": true,
"description": "Request object for fetching block allocation summary asynchronously.",
"schema": {
"$ref": "#/definitions/criteria"
}
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
}, {
"$ref": "#/parameters/x-request-id"
}, {
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/x-hotelid"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"consumes": [
"application/json;charset=UTF-8"
],
"produces": [
"application/json;charset=UTF-8"
],
"tags": [
"BlockAsync"
]
}
},
"/externalSystems/{extSystemCode}/hotels/{hotelId}/blocks/allocationSummary/{requestId}": {
"head": {
"summary": "This API returns the status of asynchronous process scheduled for given id.",
"description": " <p><strong>OperationId:</strong>getBlockAllocationSummaryProcessStatus</p>",
"operationId": "getBlockAllocationSummaryProcessStatus",
"responses": {
"200": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
},
"Status": {
"type": "string",
"description": "Status of the requested process.",
"enum": [
"Processing",
"Invalid"
]
},
"Cache-Control": {
"type": "string",
"description": "number of seconds to wait before polling again.",
"x-example": "max-age=10"
}
},
"description": "Response for status of scheduled asynchronous process."
},
"201": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
},
"Status": {
"type": "string",
"description": "Status of the requested process.",
"enum": [
"Completed"
]
},
"Location": {
"type": "string",
"description": "Location of newly created resource once the status of process run is Complete."
}
},
"description": "Response for status of scheduled asynchronous process."
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"405": {
"$ref": "#/responses/405"
},
"406": {
"$ref": "#/responses/406"
},
"413": {
"$ref": "#/responses/413"
},
"414": {
"$ref": "#/responses/414"
},
"415": {
"$ref": "#/responses/415"
},
"500": {
"$ref": "#/responses/500"
},
"502": {
"$ref": "#/responses/502"
},
"503": {
"$ref": "#/responses/503"
}
},
"parameters": [
{
"name": "requestId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000
},
{
"name": "extSystemCode",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000
},
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
}, {
"$ref": "#/parameters/x-request-id"
}, {
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/x-hotelid"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"consumes": [
"application/json;charset=UTF-8"
],
"produces": [
"application/json;charset=UTF-8"
],
"tags": [
"BlockAsync"
]
},
"get": {
"summary": "This API returns a hotel's block allocation summary for a scheduled process.",
"description": "This API will fetch Block allocation information for a hotel, and specified date range. The block allocated inventory, rates and room type statistics are returned as part of the response. <p><strong>OperationId:</strong>getBlockAllocationSummary</p>",
"operationId": "getBlockAllocationSummary",
"responses": {
"200": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
}
},
"description": "Callback request object for fetched block allocation summary.",
"schema": {
"$ref": "#/definitions/blockAllocationSummary"
}
},
"204": {
"description": "BlockAllocationSummary not found."
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"405": {
"$ref": "#/responses/405"
},
"406": {
"$ref": "#/responses/406"
},
"413": {
"$ref": "#/responses/413"
},
"414": {
"$ref": "#/responses/414"
},
"415": {
"$ref": "#/responses/415"
},
"500": {
"$ref": "#/responses/500"
},
"502": {
"$ref": "#/responses/502"
},
"503": {
"$ref": "#/responses/503"
}
},
"parameters": [
{
"name": "requestId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000
},
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000
},
{
"name": "extSystemCode",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
}, {
"$ref": "#/parameters/x-request-id"
}, {
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/x-hotelid"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"consumes": [
"application/json;charset=UTF-8"
],
"produces": [
"application/json;charset=UTF-8"
],
"tags": [
"BlockAsync"
]
}
},
"/hotels/{hotelId}/blocks/{blockId}/allocation": {
"post": {
"summary": "This API facilitates setting Block Allocations for a Hotel.",
"description": "Use this API to add block room type allocations and rates to a specified Block. <p><strong>OperationId:</strong>startBlockAllocationProcess</p>",
"operationId": "startBlockAllocationProcess",
"x-interaction": [
"async-polling"
],
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000
},
{
"name": "blockId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": "Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA."
},
{
"name": "allocation",
"in": "body",
"required": true,
"description": "A Request message that sets the room allocations as a collection of room types and dates.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/allocation"
}
]
}
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
}, {
"$ref": "#/parameters/x-request-id"
}, {
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/x-hotelid"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"responses": {
"202": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
},
"Location": {
"type": "string",
"description": "Location of process status resource"
}
},
"description": "HATEOAS links which help the consumer to navigate to resources",
"schema": {
"$ref": "#/definitions/links"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"405": {
"$ref": "#/responses/405"
},
"406": {
"$ref": "#/responses/406"
},
"413": {
"$ref": "#/responses/413"
},
"414": {
"$ref": "#/responses/414"
},
"415": {
"$ref": "#/responses/415"
},
"500": {
"$ref": "#/responses/500"
},
"502": {
"$ref": "#/responses/502"
},
"503": {
"$ref": "#/responses/503"
}
},
"consumes": [
"application/json;charset=UTF-8"
],
"produces": [
"application/json;charset=UTF-8"
],
"tags": [
"BlockAsync"
]
}
},
"/hotels/{hotelId}/blocks/{blockId}/allocation/{requestId}": {
"head": {
"summary": "This API returns the status of asynchronous process scheduled for given id.",
"description": " <p><strong>OperationId:</strong>getBlockAllocationProcessStatus</p>",
"operationId": "getBlockAllocationProcessStatus",
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000
},
{
"name": "blockId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": "Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA."
},
{
"name": "requestId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
}, {
"$ref": "#/parameters/x-request-id"
}, {
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/x-hotelid"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"responses": {
"200": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
},
"Status": {
"type": "string",
"description": "Status of the requested process.",
"enum": [
"Processing",
"Invalid"
]
},
"Cache-Control": {
"type": "string",
"description": "number of seconds to wait before polling again.",
"x-example": "max-age=10"
}
},
"description": "Response for status of scheduled asynchronous process."
},
"201": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
},
"Status": {
"type": "string",
"description": "Status of the requested process.",
"enum": [
"Completed"
]
},
"Location": {
"type": "string",
"description": "Location of newly created resource once the status of process run is Complete."
}
},
"description": "Response for status of scheduled asynchronous process."
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"405": {
"$ref": "#/responses/405"
},
"406": {
"$ref": "#/responses/406"
},
"413": {
"$ref": "#/responses/413"
},
"414": {
"$ref": "#/responses/414"
},
"415": {
"$ref": "#/responses/415"
},
"500": {
"$ref": "#/responses/500"
},
"502": {
"$ref": "#/responses/502"
},
"503": {
"$ref": "#/responses/503"
}
},
"consumes": [
"application/json;charset=UTF-8"
],
"produces": [
"application/json;charset=UTF-8"
],
"tags": [
"BlockAsync"
]
},
"get": {
"summary": "This API returns information about the set allocation process.",
"description": "This API will fetch Block allocation warnings for a hotel to allow for overbooking information to be returned as part of the response. <p><strong>OperationId:</strong>getBlockAllocationProcessInfo</p>",
"operationId": "getBlockAllocationProcessInfo",
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000
},
{
"name": "blockId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": "Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA."
},
{
"name": "requestId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
}, {
"$ref": "#/parameters/x-request-id"
}, {
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/x-hotelid"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"responses": {
"200": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
}
},
"description": "Callback request object for fetched block allocation process information.",
"schema": {
"$ref": "#/definitions/processDetails"
}
},
"204": {
"description": "BlockAllocationProcessInfo not found."
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"405": {
"$ref": "#/responses/405"
},
"406": {
"$ref": "#/responses/406"
},
"413": {
"$ref": "#/responses/413"
},
"414": {
"$ref": "#/responses/414"
},
"415": {
"$ref": "#/responses/415"
},
"500": {
"$ref": "#/responses/500"
},
"502": {
"$ref": "#/responses/502"
},
"503": {
"$ref": "#/responses/503"
}
},
"consumes": [
"application/json;charset=UTF-8"
],
"produces": [
"application/json;charset=UTF-8"
],
"tags": [
"BlockAsync"
]
}
},
"/hotels/{hotelId}/blocks/{blockId}/allocationRanges": {
"post": {
"summary": "This API facilitates setting Block Allocation Ranges for a Hotel.",
"description": "Use this API to set business block allocation for one or more date ranges, which are within business block date range, and for a list of room types. <p><strong>OperationId:</strong>startAllocationRangesProcess</p>",
"operationId": "startAllocationRangesProcess",
"x-interaction": [
"async-polling"
],
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000
},
{
"name": "blockId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": "Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA."
},
{
"name": "allocationRanges",
"in": "body",
"required": true,
"description": "Request for updating block allocations for ranges of dates and list of room types.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/allocationRanges"
}
]
}
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
}, {
"$ref": "#/parameters/x-request-id"
}, {
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/x-hotelid"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"responses": {
"202": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
},
"Location": {
"type": "string",
"description": "Location of process status resource"
}
},
"description": "HATEOAS links which help the consumer to navigate to resources",
"schema": {
"$ref": "#/definitions/links"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"405": {
"$ref": "#/responses/405"
},
"406": {
"$ref": "#/responses/406"
},
"413": {
"$ref": "#/responses/413"
},
"414": {
"$ref": "#/responses/414"
},
"415": {
"$ref": "#/responses/415"
},
"500": {
"$ref": "#/responses/500"
},
"502": {
"$ref": "#/responses/502"
},
"503": {
"$ref": "#/responses/503"
}
},
"consumes": [
"application/json;charset=UTF-8"
],
"produces": [
"application/json;charset=UTF-8"
],
"tags": [
"BlockAsync"
]
}
},
"/hotels/{hotelId}/blocks/{blockId}/allocationRanges/{requestId}": {
"head": {
"summary": "This API returns the status of asynchronous process scheduled for given id.",
"description": " <p><strong>OperationId:</strong>getAllocationRangesProcessStatus</p>",
"operationId": "getAllocationRangesProcessStatus",
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000
},
{
"name": "blockId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": "Unique OPERA Block ID which is used to find a Block from OPERA. This ID is a primary identification of a Block in OPERA."
},
{
"name": "requestId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000
},
{
"$ref": "#/parameters/authKey"
},
{
"$ref": "#/parameters/externalData"
},
{
"$ref": "#/parameters/x-app-key"
}, {
"$ref": "#/parameters/x-request-id"
}, {
"$ref": "#/parameters/x-originating-application"
},
{
"$ref": "#/parameters/x-hotelid"
},
{
"$ref": "#/parameters/Accept-Language"
}
],
"responses": {
"200": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
},
"Status": {
"type": "string",
"description": "Status of the requested process.",
"enum": [
"Processing",
"Invalid"
]
},
"Cache-Control": {
"type": "string",
"description": "number of seconds to wait before polling again.",
"x-example": "max-age=10"
}
},
"description": "Response for status of scheduled asynchronous process."
},
"201": {
"headers": {
"Content-Language": {
"type": "string",
"description": "Audience language",
"pattern": "[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*",
"x-example": "en-GB"
},
"Status": {
"type": "string",
"description": "Status of the requested process.",
"enum": [
"Completed"
]
},
"Location": {
"type": "string",
"description": "Location of newly created resource once the status of process run is Complete."
}
},
"description": "Response for status of scheduled asynchronous process."
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"405": {
"$ref": "#/responses/405"
},
"406": {
"$ref": "#/responses/406"
},
"413": {
"$ref": "#/responses/413"
},
"414": {
"$ref": "#/responses/414"
},
"415": {
"$ref": "#/responses/415"
},
"500": {
"$ref": "#/responses/500"
},
"502": {
"$ref": "#/responses/502"
},
"503": {
"$ref": "#/responses/503"
}
},
"consumes": [
"application/json;charset=UTF-8"
],
"produces": [
"application/json;charset=UTF-8"
],
"tags": [
"BlockAsync"
]
},
"get": {
"summary": "This API returns information about the set allocation ranges process.",
"description": "This API will fetch Block allocation ranges warnings for a hotel to allow for overbooking information to be returned as part of the response. <p><strong>OperationId:</strong>getAllocationRangesProcessInfo</p>",
"operationId": "getAllocationRangesProcessInfo",
"parameters": [
{
"name": "hotelId",
"in": "path",
"re
# --- truncated at 32 KB (1100 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-property-v1-blkasync.json