APIs to insert Stay Records related asynchronous functionality in OPERA. Compatible with OPERA Cloud release 26.2.0.0. 4 operation(s) documented; base path /crm/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 CRM Asynchronous API",
"description": "APIs to insert Stay Records 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": "/crm/async/v1",
"produces": [
"application/json"
],
"paths": {
"/stayRecords": {
"post": {
"summary": "This API facilitates uploading stage records to LCS.",
"description": "A user can upload various stay records to OPERA by specifying stay record column details in the request.<p><strong>OperationId:</strong>stayRecords</p>",
"operationId": "stayRecords",
"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": "criteria",
"in": "body",
"required": true,
"description": "Request object for uploading stage records to LCS asynchronously.",
"schema": {
"$ref": "#/definitions/stayRecords"
}
},
{
"$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": [
"CRMAsync"
]
}
},
"/stayRecords/{requestId}": {
"head": {
"summary": "This API returns the status of asynchronous process scheduled for given id.",
"description": "Use this to check whether the request sent have been processed. <p><strong>OperationId:</strong>getStayRecordsProcessStatus</p>",
"operationId": "getStayRecordsProcessStatus",
"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
},
{
"$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": [
"CRMAsync"
]
},
"get": {
"summary": "This API facilitates fetching the status for stay records uploaded.",
"description": "Use this to check whether the request sent have been processed. <p><strong>OperationId:</strong>getStayRecordsProcess</p>",
"operationId": "getStayRecordsProcess",
"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 for stay records uploaded",
"schema": {
"$ref": "#/definitions/stayRecordStatus"
}
},
"204": {
"description": "Stay Record 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
},
{
"$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": [
"CRMAsync"
]
}
},
"/deleteSuspendedStays": {
"delete": {
"summary": "This API facilitates deleting multiple suspended stay records based on criteria.",
"description": "This API can be used to delete multiple suspended stay records based on the available criteria. <p><strong>OperationId:</strong>deleteSuspendedStays</p>",
"operationId": "deleteSuspendedStays",
"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"
}
}
},
"parameters": [
{
"name": "hotelId",
"in": "query",
"required": false,
"description": "Hotel code.",
"type": "string",
"minLength": 1,
"maxLength": 20
}, {
"name": "reservationStatus",
"in": "query",
"required": false,
"type": "string",
"description": "Status of reservation.",
"minLength": 1,
"maxLength": 20
}, {
"name": "importDate",
"in": "query",
"required": false,
"description": "Date of creation or import of stay.",
"type": "string",
"format": "date"
}, {
"name" : "importDateFrom",
"in" : "query",
"required" : false,
"description" : "From date of creation or import of stay.",
"type" : "string",
"format" : "date"
},{
"name" : "importDateTo",
"in" : "query",
"required" : false,
"description" : "To date of creation or import of stay.",
"type" : "string",
"format" : "date"
},{
"name" : "arrivalDateFrom",
"in" : "query",
"required" : false,
"description" : "From date of arrival of reservation.",
"type" : "string",
"format" : "date"
},{
"name" : "arrivalDateTo",
"in" : "query",
"required" : false,
"description" : "To date of arrival of reservation.",
"type" : "string",
"format" : "date"
},{
"name" : "departureDateFrom",
"in" : "query",
"required" : false,
"description" : "From date of departure of reservation.",
"type" : "string",
"format" : "date"
},{
"name" : "departureDateTo",
"in" : "query",
"required" : false,
"description" : "To date of departure of reservation.",
"type" : "string",
"format" : "date"
},{
"name" : "pmsResvConfNo",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "Reservation confirmation number in PMS.",
"minLength": 1,
"maxLength": 50
},{
"name" : "clientID",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "Client ID/Corp/IATA of the profile in central.",
"minLength": 1,
"maxLength": 20
},{
"name" : "pmsNameID",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "Profile number in PMS.",
"minLength": 1,
"maxLength": 20
},{
"name" : "membershipType",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "Membership type of the profile.",
"minLength": 1,
"maxLength": 20
},{
"name" : "membershipNo",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "Membership number of the profile.",
"minLength": 1,
"maxLength": 50
},{
"name" : "errorDescription",
"in" : "query",
"required" : false,
"type" : "string",
"description" : "Suspended reason description.",
"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": ["CRMAsync"]
}
},
"/deleteSuspendedStays/{requestId}": {
"head": {
"summary": "This API retrieves the status of the delete suspended stays asynchronous process based on unique request id.",
"description": "Use the API to retrieve the status of the delete suspended stays process job associated with the unique request ID obtained from the 'Location' header in the deleteSuspendedStays API response. <p><strong>OperationId:</strong>getSuspendedStaysDeleteStatus</p>",
"operationId": "getSuspendedStaysDeleteStatus",
"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."
}
},
"parameters": [ {
"name": "requestId",
"in": "path",
"description": "Request Id for polling.",
"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": [ "CRMAsync" ]
},
"get": {
"summary": "This API facilitates fetching the status for suspended stay records deleted.",
"description": "Use this to check whether the request sent has been processed. <p><strong>OperationId:</strong>getSuspendedStaysDelete</p>",
"operationId": "getSuspendedStaysDelete",
"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 for suspended stay records deleted.",
"schema": {
"$ref": "#/definitions/suspendedStayDeleteStatus"
}
},
"204": {
"description": "Resource not found."
}
},
"parameters": [ {
"name": "requestId",
"in": "path",
"description": "Request Id for polling.",
"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": [ "CRMAsync" ]
}
}
},
"parameters": {
"externalData": {
"name": "externalData",
"type": "string",
"description": "Pass this header as true, if payload needs DVM",
"in": "header"
},
"authKey": {
"name": "authorization",
"description": "Bearer token that needs to be passed which is generated post user authentication",
"type": "string",
"in": "header",
"required": true
},
"x-app-key": {
"name": "x-app-key",
"description": "Client or PartnerAC/AAs Application Key",
"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}$",
"in": "header",
"required": true
},
"x-request-id" : {
"name" : "x-request-id",
"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}",
"description" : "Request Id of an incoming request",
"in" : "header"
},
"x-originating-application" : {
"name" : "x-originating-application",
"type" : "string",
"description" : "Customer's Integration Application Id",
"in" : "header"
},
"x-hotelid": {
"name": "x-hotelid",
"type": "string",
"description": "Mandatory parameter to identify the hotel code where the end user is logged in",
"in": "header",
"required": true
},
"Accept-Language": {
"name": "Accept-Language",
"type": "string",
"description": "Language code",
"in": "header"
}
},
"responses": {
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/exceptionDetailType"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Resource not found",
"schema": {
"$ref": "#/definitions/exceptionDetailType"
}
},
"405": {
"description": "Method not allowed"
},
"406": {
"description": "Not acceptable."
},
"413": {
"description": "Request Entity Too Large"
},
"414": {
"description": "Request URI Too Large"
},
"415": {
"description": "Unsupported Media Type"
},
"500": {
"description": "System Error",
"schema": {
"$ref": "#/definitions/exceptionDetailType"
}
},
"502": {
"description": "Bad Gateway"
},
"503": {
"description": "Service Unavailable"
}
},
"definitions": {
"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": "#/definitions/errorInstance"
}
},
"links": {
"$ref": "#/definitions/links"
}
}
},
"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"
}
}
},
"links": {
"type": "array",
"items": {
"$ref": "#/definitions/instanceLink"
}
},
"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."
}
}
},
"warningType": {
"type": "object",
"description": "Used when a stay record is successfully processed to repory any warnings or business error.",
"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
}
}
},
"stayDailyRatesType": {
"type": "object",
"properties": {
"transactionDate": {
"description": "Date on which the transaction was done.",
"type": "string",
"format": "date"
},
"bookedRoomType": {
"description": "Specifies the type of room booked.",
"type": "string"
},
"currencyCode": {
"description": "Specifies the code assigned to the currency.",
"type": "string"
},
"pseudoRoom": {
"description": "Specifies if the room is a pseudo room.",
"type": "boolean"
},
"marketCode": {
"description": "Specifies the market code.",
"type": "string"
},
"rateCode": {
"description": "Specifies the rate code.",
"type": "string"
},
"rateAmount": {
"description": "Specifies the amount added to a particular rate code.",
"type": "number"
},
"roomNumber": {
"description": "Describes the number assigned to a room.",
"type": "string"
},
"roomType": {
"description": "Describes the type of the room.",
"type": "string"
}
},
"required": [
"transactionDate",
# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-property-v1-crmasync.json