This API deals with the different aspect of the CustomerManagement. Compatible with OPERA Cloud release 26.2.0.0. 6 operation(s) documented; base path /cms/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 API for Customer Management Service",
"description": "This API deals with the different aspect of the CustomerManagement.<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": "/cms/v1",
"produces": [
"application/json"
],
"paths": {
"/hotels/{hotelId}/trackItems": {
"post": {
"summary": "Creates track it items",
"description": "Create a new Track It Item. Track It manages storage and delivery of guest luggage, parcels, vehicles (valet), and lost items. They can optionally be linked to a reservation if related or an arrival, in-house or departure reservation. <p><strong>OperationId:</strong>postTrackItItems</p>",
"operationId": "postTrackItItems",
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": ""
},
{
"name": "trackItItems",
"in": "body",
"required": true,
"description": "Request object to create Track It items.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/trackItItems"
}
]
}
},
{
"$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": [
"CustomerManagement"
]
},
"put": {
"summary": "Updates track it items",
"description": "Update the details of a Track It Item for a property. <p><strong>OperationId:</strong>putTrackItItems</p>",
"operationId": "putTrackItItems",
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": ""
},
{
"name": "trackItItems",
"in": "body",
"required": true,
"description": "Request object to update Track It items.",
"schema": {
"allOf": [
{
"$ref": "#/definitions/trackItItems"
}
]
}
},
{
"$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 object for updating Track It items.",
"schema": {
"$ref": "#/definitions/trackItItems"
}
},
"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": [
"CustomerManagement"
]
},
"delete": {
"summary": "Deletes track it items",
"description": "Delete a Track It Item for a property. <p><strong>OperationId:</strong>deleteTrackItItems</p>",
"operationId": "deleteTrackItItems",
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": ""
},
{
"name": "trackItId",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"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.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "trackItIdContext",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"items": {
"type": "string"
},
"required": false
},
{
"name": "trackItIdType",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "A reference to the type of object defined by the UniqueID element.",
"items": {
"type": "string"
},
"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": [
"CustomerManagement"
]
},
"get": {
"summary": "Fetches track it items",
"description": "Retrieve a list of all Track It Items for a property. <p><strong>OperationId:</strong>getTrackItItems</p>",
"operationId": "getTrackItItems",
"deprecated": true,
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": ""
},
{
"name": "ticketId",
"in": "query",
"required": false,
"description": "Complete ticket number of the Track It item.",
"type": "string"
},
{
"name": "reservationId",
"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.",
"type": "string"
},
{
"name": "reservationIdContext",
"in": "query",
"required": false,
"description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string"
},
{
"name": "reservationIdType",
"in": "query",
"required": false,
"description": "A reference to the type of object defined by the UniqueID element.",
"type": "string"
},
{
"name": "givenName",
"in": "query",
"required": false,
"description": "Given name, first name or names.",
"type": "string"
},
{
"name": "surname",
"in": "query",
"required": false,
"description": "Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name.",
"type": "string"
},
{
"name": "trackItGroups",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Group to which the Track It items belong.",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"Parcel",
"Valet",
"Baggage",
"Lost"
]
},
"required": false
},
{
"name": "types",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"description": "Track It types based on the Track It group.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "locations",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"description": "Locations for Track It location.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "actions",
"in": "query",
"type": "array",
"maxItems": 4000,
"collectionFormat": "multi",
"description": "Track It actions based on Track It groups.",
"items": {
"type": "string"
},
"required": false
},
{
"name": "actionStatuses",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Action status of the Track It item(Open, Closed).",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"Open",
"Closed"
]
},
"required": false
},
{
"name": "appUserId",
"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.",
"type": "string"
},
{
"name": "appUserIdContext",
"in": "query",
"required": false,
"description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string"
},
{
"name": "appUserIdType",
"in": "query",
"required": false,
"description": "A reference to the type of object defined by the UniqueID element.",
"type": "string"
},
{
"name": "assignedStatuses",
"in": "query",
"type": "array",
"collectionFormat": "multi",
"description": "Assignment status of the Track It item(Assigned, Unassigned).",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"Assigned",
"Unassigned"
]
},
"required": false
},
{
"name": "room",
"in": "query",
"required": false,
"description": "Guest's room number if ticket associated with a reservation.",
"type": "string"
},
{
"name": "followUpDate",
"in": "query",
"required": false,
"description": "Follow up date for the ticket.",
"type": "string",
"format": "date"
},
{
"name": "createdOn",
"in": "query",
"required": false,
"description": "Date when the ticket was created.",
"type": "string",
"format": "date"
},
{
"name": "createdByUserId",
"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.",
"type": "string"
},
{
"name": "createdByUserIdContext",
"in": "query",
"required": false,
"description": "Used to identify the source of the identifier (e.g., IATA, ABTA).",
"type": "string"
},
{
"name": "createdByUserIdType",
"in": "query",
"required": false,
"description": "A reference to the type of object defined by the UniqueID element.",
"type": "string"
},
{
"name": "description",
"in": "query",
"required": false,
"description": "Description associated with the Track It item.",
"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 that retrieves Track It items.",
"schema": {
"$ref": "#/definitions/trackItItems"
}
},
"204": {
"description": "TrackItItems 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": [
"CustomerManagement"
]
}
},
"/hotels/{hotelId}/trackItems/searches": {
"post": {
"summary": "Fetches track it items",
"description": "Retrieve a list of all Track It Items for a property. <p><strong>OperationId:</strong>searchTrackItItems</p>",
"operationId": "searchTrackItItems",
"parameters": [
{
"name": "hotelId",
"in": "path",
"required": true,
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": ""
},
{
"in": "body",
"name": "searchTrackItItemsRequest",
"required": false,
"schema": {
"$ref": "#/definitions/searchTrackItItemsRequest"
}
},
{
"$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 that retrieves Track It items.",
"schema": {
"$ref": "#/definitions/trackItItems"
}
},
"204": {
"description": "TrackItItems 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": [
"CustomerManagement"
]
}
},
"/services/customerManagement/status": {
"get": {
"summary": "Operation to ping the customer management service",
"description": " <p><strong>OperationId:</strong>pingCustomerManagementService</p>",
"operationId": "pingCustomerManagementService",
"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": "pingCustomerManagementService 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": [
"CustomerManagement"
]
}
}
},
"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 Partner's 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
},
"x-externalsystem": {
"name": "x-externalsystem",
"type": "string",
"maxLength": 40,
"description": "External system code.",
"in": "header",
"x-example": "EXTERNALSYSTEMCODE"
},
"Accept-Language": {
"name": "Accept-Language",
"type": "string",
"description": "Language code",
"in": "header"
},
"x-hubid": {
"name": "x-hubid",
"type": "string",
"description": "x-hubid is a logical grouping of multiple properties that allows api consumers to manage data from a group of properties. This x-hubid is a valid list of hub codes configured in OPERA to which the user has access. Rest APIs without hotelId in the operation path can support hub level integration using x-hubid",
"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": {
"calendarTasks": {
"type": "object",
"description": "Response for fetching calendar tasks.",
"properties": {
"taskSummary": {
"description": "",
"$ref": "#/definitions/calendarTaskListType"
},
"countSummary": {
"description": "",
"$ref": "#/definitions/calendarTaskCountListType"
},
"links": {
"$ref": "#/definitions/links"
},
"warnings": {
"$ref": "#/definitions/warningsType"
}
}
},
"calendarTaskListType": {
"type": "array",
"description": "Detailed information regarding calendar task.",
"maxItems": 4000,
"items": {
"$ref": "#/definitions/calendarTaskType"
}
},
"calendarTaskType": {
"type": "object",
"description": "Detailed information regarding calendar task.",
"properties": {
"hotelId": {
"description": "Hotel code of calendar task.",
"type": "string",
"minLength": 0,
"maxLength": 20
},
"timeSpan": {
"description": "Duration of calendar task.",
"$ref": "#/definitions/timeSpanType"
},
"status": {
"description": "Completion status of calendar task.",
"type": "object",
"properties": {
"completedBy": {
"description": "Name of person who completed the task. Ignored when task is not marked as completed.",
"type": "string"
},
"completedOn": {
"description": "Date on which the task was completed. Ignored when task is not marked as completed.",
"type": "string",
"format": "date",
"maxLength": 8
},
"completed": {
"description": "Whether the task is completed or not.",
"type": "boolean"
}
}
},
"priorityInfo": {
"description": "Priority level of calendar task.",
"$ref": "#/definitions/calendarTaskPriorityType"
},
"classCode": {
"description": "Classification of calendar task.",
"$ref": "#/definitions/calendarTaskClassType"
},
"typeCode": {
"description": "Type of calendar task based on its classification.",
"$ref": "#/definitions/codeDescriptionType"
},
"purpose": {
"description": "Brief description and purpose of calendar task.",
"type": "string",
"minLength": 0,
"maxLength": 2000
},
"notes": {
"description": "Additional notes and information regarding calendar task.",
"type": "string",
"minLength": 0,
"maxLength": 2000
},
"taskOwner": {
"description": "Owner code of the person to whom the calendar task is assigned.",
"type": "string",
"minLength": 0,
"maxLength": 20
# --- truncated at 32 KB (102 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-property-v1-cms.json