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.). Compatible with OPERA Cloud release 26.2.0.0. 13 operation(s) documented; base path /inv/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 Inventory 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"
}
},
"schemes": [
"https"
],
"basePath": "/inv/v1",
"produces": [
"application/json"
],
"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",
"type": "array",
"maxItems": 4000,
"minItems": 1,
"collectionFormat": "multi",
"description": "Hotel code.",
"items": {
"type": "string"
},
"required": true
},
{
"name": "includeBlocksWithNoRoom",
"in": "query",
"required": false,
"description": "If set to true, includes business blocks without rooms.",
"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.",
"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.",
"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.",
"type": "boolean"
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "Indicates maximum number of records a Web Service should return.",
"type": "integer"
},
{
"name": "offset",
"in": "query",
"default": 0,
"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.",
"type": "integer"
},
{
"name": "endDateRange",
"in": "query",
"required": false,
"description": "The ending value of the date range.",
"type": "string",
"format": "date"
},
{
"name": "startDateRange",
"in": "query",
"required": false,
"description": "The starting value of the date range.",
"type": "string",
"format": "date"
},
{
"name": "blockStatusCodes",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"description": "Collection of configured Block Status Codes.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "originCodes",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"description": "Collection of Origin Codes.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "roomOwnerCodes",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"description": "Collection of Room Owners.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "blockOwners",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"description": "Collection of block owners.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "availabilitySummaryBy",
"in": "query",
"enum": [
"AvailableRooms",
"AvailableRoomsExclSellLimits"
],
"type": "string",
"description": "Summarize the availability based on selected criteria. If not selected, by default AvailableRooms are displayed. ",
"required": false
},
{
"name": "summarySortByCode",
"in": "query",
"required": false,
"type": "string",
"description": "Supported block inventory statistical sorting for summary information",
"uniqueItems": true,
"enum": [
"Status",
"StatusDescending"
]
},
{
"name": "detailSortByCode",
"in": "query",
"required": false,
"type": "string",
"description": "Supported block inventory statistical sorting for detailed block information",
"uniqueItems": true,
"enum": [
"Status",
"StatusDescending",
"ArrivalDate",
"BlockAccount",
"Revenue",
"RoomsOwner"
]
},
{
"name": "sunday",
"in": "query",
"required": false,
"type": "boolean",
"description": "If selected, Sundays are included in search result."
},
{
"name": "monday",
"in": "query",
"required": false,
"type": "boolean",
"description": "If selected, Mondays are included in search result."
},
{
"name": "tuesday",
"in": "query",
"required": false,
"type": "boolean",
"description": "If selected, Tuesdays are included in search result."
},
{
"name": "wednesday",
"in": "query",
"required": false,
"type": "boolean",
"description": "If selected, Wednesdays are included in search result."
},
{
"name": "thursday",
"in": "query",
"required": false,
"type": "boolean",
"description": "If selected, Thursdays are included in search result."
},
{
"name": "friday",
"in": "query",
"required": false,
"type": "boolean",
"description": "If selected, Fridays are included in search result."
},
{
"name": "saturday",
"in": "query",
"required": false,
"type": "boolean",
"description": "If selected, Saturdays are included in search result."
},
{
"name": "fetchInstructions",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Type for block inventory statistics instructions that can be used in requests for partial operations.",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"StatusSummary",
"BookingSummary",
"ForecastSummary",
"DetailSummary",
"RoomSummary"
]
},
"required": false
},
{
"name": "roomSummaryBy",
"in": "query",
"enum": [
"AvailableRooms",
"AvailableRoomsWithNonDeduct",
"AvailableRoomsExclSellLimits",
"AvailableRoomsWithNonDeductExclSellLimits"
],
"type": "string",
"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
},
{
"$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/x-externalsystem"
},
{
"$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": "Response object for information regarding Block Inventory Statistics.",
"schema": {
"$ref": "#/definitions/blockInventoryStatistic"
}
},
"204": {
"description": "BlockInventoryStatistics 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": [
"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,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": "Unique ID of the hotel where block inventory statistics are searched."
},
{
"name": "includeBlocksWithNoRoom",
"in": "query",
"required": false,
"description": "If set to true, includes business blocks without rooms.",
"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.",
"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.",
"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.",
"type": "boolean"
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "Indicates maximum number of records a Web Service should return.",
"type": "integer"
},
{
"name": "offset",
"in": "query",
"default": 0,
"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.",
"type": "integer"
},
{
"name": "endDateRange",
"in": "query",
"required": false,
"description": "The ending value of the date range.",
"type": "string",
"format": "date"
},
{
"name": "startDateRange",
"in": "query",
"required": false,
"description": "The starting value of the date range.",
"type": "string",
"format": "date"
},
{
"name": "blockStatusCodes",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "originCodes",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "roomOwnerCodes",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "blockOwners",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"items": {
"type": "string"
},
"required": false
},
{
"name": "availabilitySummaryBy",
"in": "query",
"enum": [
"AvailableRooms",
"AvailableRoomsExclSellLimits"
],
"type": "string",
"description": "Summarize the availability based on selected criteria. If not selected, by default AvailableRooms are displayed. ",
"required": false
},
{
"name": "summarySortByCode",
"in": "query",
"required": false,
"type": "string",
"description": "Supported block inventory statistical sorting.",
"uniqueItems": true,
"enum": [
"Status",
"StatusDescending",
"ArrivalDate",
"BlockAccount",
"Revenue",
"RoomsOwner"
]
},
{
"name": "detailSortByCode",
"in": "query",
"required": false,
"type": "string",
"description": "Supported block inventory statistical sorting.",
"uniqueItems": true,
"enum": [
"Status",
"StatusDescending",
"ArrivalDate",
"BlockAccount",
"Revenue",
"RoomsOwner"
]
},
{
"name": "friday",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "monday",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "saturday",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "sunday",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "thursday",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "tuesday",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "wednesday",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "fetchInstructions",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Type for block inventory statistics instructions that can be used in requests for partial operations.",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"StatusSummary",
"BookingSummary",
"ForecastSummary",
"DetailSummary",
"RoomSummary"
]
},
"required": false
},
{
"name": "roomSummaryBy",
"in": "query",
"enum": [
"AvailableRooms",
"AvailableRoomsWithNonDeduct",
"AvailableRoomsExclSellLimits",
"AvailableRoomsWithNonDeductExclSellLimits"
],
"type": "string",
"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
},
{
"$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/x-externalsystem"
},
{
"$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": "Response object for information regarding Block Inventory Statistics.",
"schema": {
"$ref": "#/definitions/blockInventoryStatistic"
}
},
"204": {
"description": "BlockInventoryStatistics 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": [
"INVStats"
]
}
},
"/hotels/{hotelId}/hotelInventory": {
"get": {
"summary": "Get hotel inventory",
"description": "You can use this API to retrieve the inventory for a specified hotel. Narrow down your results using the query parameters such as a date range, room type, room class, and/or tentative inventory included. <p><strong>OperationId:</strong>getHotelInventory</p> <p>This API allows a time span of <strong>90</strong> days.</p>",
"operationId": "getHotelInventory",
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": "Unique ID of the hotel where hotel inventory is searched."
},
{
"name": "dateRangeStart",
"in": "query",
"required": true,
"type": "string",
"format": "date"
},
{
"name": "dateRangeEnd",
"in": "query",
"required": true,
"type": "string",
"format": "date"
},
{
"name": "roomCountRequested",
"in": "query",
"required": true,
"description": "Number of rooms requested.",
"type": "integer"
},
{
"name": "includeTentativeInventory",
"in": "query",
"required": false,
"description": "If set to true, includes non-deduct/Tentative rooms for a date range.",
"type": "boolean"
},
{
"name": "dailyInventory",
"in": "query",
"required": false,
"description": "If false minimum inventory for the date range is requested, otherwise inventory is requested for every day.",
"type": "boolean"
},
{
"name": "houseLevel",
"in": "query",
"required": false,
"description": "Indicates that House level inventory is requested.",
"type": "boolean"
},
{
"name": "roomTypes",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"description": "Room Type Code.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "roomClasses",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"description": "Room Class Code.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "includeOverbooking",
"in": "query",
"required": false,
"description": "This flag indicates that include or exclude overbooking count. The default value is true.",
"type": "boolean",
"default": true
},
{
"$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/x-externalsystem"
},
{
"$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": "A response for Hotel Inventories meeting the search criteria. Returns inventory classified on room type, class and house level for a given property.",
"schema": {
"$ref": "#/definitions/hotelInventory"
}
},
"204": {
"description": "HotelInventory 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": [
"Inventory"
]
}
},
"/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,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": "Unique ID of the hotel where inventory statistics are searched."
},
{
"name": "dateRangeEnd",
"in": "query",
"required": true,
"description": "The ending value of the date range.",
"type": "string",
"format": "date"
},
{
"name": "reportCode",
"in": "query",
"enum": [
"DetailedAvailabiltySummary",
"RoomCalendarStatistics",
"SellLimitSummary",
"RoomsAvailabilitySummary"
],
"required": true,
"description": "Identifies the type of statistics collected. Each ReportCode corresponds to a set of category summaries based upon a predetermined agreement.",
"type": "string"
},
{
"name": "dateRangeStart",
"in": "query",
"required": true,
"description": "The starting value of the date range.",
"type": "string",
"format": "date"
},
{
"name": "parameterName",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Name of the parameter.",
"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",
# --- truncated at 32 KB (132 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-property-v1-inv.json