APIs catering to Integration Configuration in OPERA Cloud. Operations such as get Hotel Interface Types, or get UDF mappings can be found in this module. Compatible with OPERA Cloud release 26.2.0.0. 50 operation(s) documented; base path /int/config/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 Integration Configuration API",
"description": "APIs catering to Integration Configuration in OPERA Cloud. Operations such as get Hotel Interface Types, or get UDF mappings can be found in this module.<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": "/int/config/v1",
"produces": [
"application/json"
],
"paths": {
"/config/oxi/services/beProcessor/status": {
"get": {
"summary": "Operation to ping.",
"description": " <p><strong>OperationId:</strong>pingBeProcessor</p>",
"operationId": "pingBeProcessor",
"parameters": [
{
"$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 for Ping operation.",
"schema": {
"$ref": "#/definitions/operaVersion"
}
},
"204": {
"description": "pingBeProcessor 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": [
"BEProcessor"
]
}
},
"/configuredExternalDevices": {
"get": {
"summary": "Operation to fetch configured external devices.",
"description": " <p><strong>OperationId:</strong>getConfiguredExternalDevices</p>",
"operationId": "getConfiguredExternalDevices",
"parameters": [
{
"name": "hotelId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "active",
"in": "query",
"required": false,
"description": "Flag that indicates whether the device is active.",
"type": "boolean"
},
{
"name": "id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "idEditable",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "label",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "deviceType",
"in": "query",
"required": false,
"type": "string",
"uniqueItems": true,
"enum": [
"Scanner",
"CreditCard",
"Fiscal",
"Device"
]
},
{
"name": "deviceCode",
"in": "query",
"required": false,
"type": "string",
"uniqueItems": true,
"enum": [
"TtiScannerMobile",
"TtiScannerDesktop",
"SamsotechScanner",
"GenScannerDesktop",
"GenScannerMobile",
"ChipAndPin",
"FiscalTerminal",
"Device"
]
},
{
"name": "deviceArea",
"in": "query",
"required": false,
"description": "The area where the device is installed",
"type": "string"
},
{
"name": "displayName",
"in": "query",
"required": false,
"description": "External device display name.",
"type": "string"
},
{
"name": "mobileYN",
"in": "query",
"required": false,
"description": "Indicator if device type is mobile or desktop.",
"type": "boolean"
},
{
"name": "desktopYN",
"in": "query",
"required": false,
"description": "Indicator if device type is mobile or desktop.",
"type": "boolean"
},
{
"name": "registerAddress",
"in": "query",
"required": false,
"description": "The address which the Cash Register ID ( Device ID ) is associated with.",
"type": "string"
},
{
"name": "deviceValue",
"in": "query",
"required": false,
"description": "External device Value.",
"type": "string"
},
{
"name": "parameterName",
"in": "query",
"required": false,
"description": "Name of the parameter.",
"type": "string"
},
{
"name": "parameterValue",
"in": "query",
"required": false,
"description": "Value of the parameter.",
"type": "string"
},
{
"name": "includeInactive",
"in": "query",
"required": false,
"description": "Flag to choose to include inactive external devices or not.",
"type": "boolean"
},
{
"name": "fiscalPartnerCode",
"in": "query",
"required": false,
"type": "string",
"description": "Used for fiscal partner codes. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X."
},
{
"name": "partnerCode",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Used for fiscal partner codes. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "fetchInstruction",
"in": "query",
"required": false,
"type": "string",
"description": "Fetch instructions that can be used for all or partner specific.",
"uniqueItems": true,
"enum": [
"Default",
"Partner"
]
},
{
"name": "partnerPayloadType",
"in": "query",
"required": false,
"type": "string",
"description": "Used for searching a partner code configured with the specified fiscal payload type.",
"uniqueItems": true,
"enum": [
"CheckOut",
"FolioGeneration"
]
},
{
"$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 for Ping operation.",
"schema": {
"$ref": "#/definitions/fetchedConfiguredExternalDevices"
}
},
"204": {
"description": "ConfiguredExternalDevices 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": [
"ExternalSystemsConfig"
]
}
},
"/deliveryMethods": {
"get": {
"summary": "Operation to fetch delivery methods.",
"description": " <p><strong>OperationId:</strong>getDeliveryMethods</p>",
"operationId": "getDeliveryMethods",
"parameters": [
{
"name": "hotelId",
"in": "query",
"required": false,
"description": "Property code.",
"type": "string"
},
{
"name": "croCode",
"in": "query",
"required": false,
"description": "CRO code.",
"type": "string"
},
{
"name": "usages",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Settings for Text Message Delivery of Queue Reservation status",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"General",
"QueueReservation",
"Confirmation",
"GuestMessage",
"BillingFolio",
"QueueRush",
"AR",
"OtherFolio",
"PayByLink"
]
},
"required": false
},
{
"name": "includeInactive",
"in": "query",
"required": false,
"description": "If true this will include inactive records(This is only applicable for general SMTP delivery method ).",
"type": "boolean"
},
{
"$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 to request to fetch the delivery method for a property/HUB/Chain and its configurations.",
"schema": {
"$ref": "#/definitions/fetchedDeliveryMethods"
}
},
"204": {
"description": "DeliveryMethods 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": [
"ExternalSystemsConfig"
]
},
"put": {
"summary": "Operation to change delivery methods.",
"description": " <p><strong>OperationId:</strong>putDeliveryMethods</p>",
"operationId": "putDeliveryMethods",
"parameters": [
{
"name": "changeDeliveryMethods",
"in": "body",
"required": true,
"description": "Request to change the delivery method for a property/HUB/Chain and its configurations.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/changeDeliveryMethods"
}
]
}
},
{
"$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"
},
"Location": {
"type": "string",
"description": "Location of newly created resource"
}
},
"description": "Response Body.",
"schema": {
"$ref": "#/definitions/changedDeliveryMethods"
}
},
"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": [
"ExternalSystemsConfig"
]
},
"delete": {
"summary": "Operation to remove delivery methods.",
"description": " <p><strong>OperationId:</strong>deleteDeliveryMethods</p>",
"operationId": "deleteDeliveryMethods",
"parameters": [
{
"name": "hotelId",
"in": "query",
"required": false,
"type": "string",
"description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X."
},
{
"name": "type",
"in": "query",
"required": false,
"type": "string",
"description": "Settings for Text Message Delivery of Queue Reservation status",
"uniqueItems": true,
"enum": [
"General",
"QueueReservation",
"Confirmation",
"GuestMessage",
"BillingFolio",
"QueueRush",
"AR",
"OtherFolio"
]
},
{
"name": "options",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "SFTP delivery configurations",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"Email",
"Fax",
"TextMessage",
"Sftp"
]
},
"required": false
},
{
"name": "configurationId",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Unique id associated with this configuration",
"items": {
"type": "integer"
},
"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"
},
"Location": {
"type": "string",
"description": "Location of newly created resource"
}
},
"description": "HATEOAS links which help the consumer to navigate to resources",
"schema": {
"$ref": "#/definitions/status"
}
},
"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": [
"ExternalSystemsConfig"
]
},
"post": {
"summary": "Operation to create delivery methods.",
"description": " <p><strong>OperationId:</strong>postDeliveryMethods</p>",
"operationId": "postDeliveryMethods",
"parameters": [
{
"name": "createDeliveryMethods",
"in": "body",
"required": true,
"description": "Request to create the delivery method for a property/HUB/Chain and its configurations.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/createDeliveryMethods"
}
]
}
},
{
"$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": {
"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"
},
"Location": {
"type": "string",
"description": "Location of newly created resource"
}
},
"description": "HATEOAS links which help the consumer to navigate to resources",
"schema": {
"$ref": "#/definitions/status"
}
},
"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": [
"ExternalSystemsConfig"
]
}
},
"/deviceLocations": {
"get": {
"summary": "Get the template device locations",
"description": "Use this API to get the template device locations. <p><strong>OperationId:</strong>getTemplateDeviceLocations</p>",
"operationId": "getTemplateDeviceLocations",
"parameters": [
{
"name": "fetchInactive",
"in": "query",
"default": "false",
"required": false,
"description": "Determines wether to fetch inactive records or not.",
"type": "boolean"
},
{
"name": "codes",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"description": "Codes to be searched.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "wildCard",
"in": "query",
"required": false,
"description": "Wildcard search on the code.",
"type": "string"
},
{
"name": "description",
"in": "query",
"required": false,
"description": "Description of the code.",
"type": "string"
},
{
"$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 fetching template Device locations.",
"schema": {
"$ref": "#/definitions/templateDeviceLocationsDetails"
}
},
"204": {
"description": "TemplateDeviceLocations 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": [
"ChainConfig"
]
},
"post": {
"summary": "Create the template device locations",
"description": "Use this API to create the template device locations. <p><strong>OperationId:</strong>postTemplateDeviceLocations</p>",
"operationId": "postTemplateDeviceLocations",
"parameters": [
{
"name": "templateDeviceLocationsCriteria",
"in": "body",
"required": true,
"description": "Request object for creating template Device locations.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/templateDeviceLocationsCriteria"
}
]
}
},
{
"$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": {
"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"
},
"Location": {
"type": "string",
"description": "Location of newly created resource"
}
},
"description": "HATEOAS links which help the consumer to navigate to resources",
"schema": {
"$ref": "#/definitions/status"
}
},
"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": [
"ChainConfig"
]
}
},
"/deviceLocations/{deviceLocationId}": {
"put": {
"summary": "Change the template device locations",
"description": "Use this API to update the template device locations. <p><strong>OperationId:</strong>changeTemplateDeviceLocations</p>",
"operationId": "changeTemplateDeviceLocations",
"parameters": [
{
"name": "deviceLocationId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": "Unique ID of device location."
},
{
"name": "templateDeviceLocationsToBeChanged",
"in": "body",
"required": true,
"description": "Request object for changing template Device locations.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/templateDeviceLocationsToBeChanged"
}
]
}
},
{
"$ref": "#/parameters/authKey"
},
# --- truncated at 32 KB (318 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-property-v1-intcfg.json