OperationId:getResvForBatchCCAuth
" }, { "info": { "name": "Process batch CC Auth", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/batchReservationAuthorizations", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "This API is used to process batch CC Authorization.OperationId:processBatchCCAuth
" }, { "info": { "name": "Get Reservations for billing", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/billingReservations", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." }, { "name": "searchType", "value": "", "type": "query", "description": "Represents Reservation search type Player Snapshot." }, { "name": "multipleHotelsSearchList", "value": "", "type": "query", "description": "Hotel code." }, { "name": "superSearch", "value": "", "type": "query", "description": "Free form text field for searching all reservation fields" }, { "name": "reservationId", "value": "", "type": "query", "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." }, { "name": "reservationIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "nights", "value": "", "type": "query", "description": "The number of nights on a reservation." }, { "name": "arrivalEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "arrivalStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "departureEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "departureStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "reservationProfileType", "value": "", "type": "query" }, { "name": "attachedProfileName", "value": "", "type": "query", "description": "Attached profile name" }, { "name": "attachedProfileId", "value": "", "type": "query", "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." }, { "name": "attachedProfileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "attachedProfileIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "resGuestId", "value": "", "type": "query", "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." }, { "name": "resGuestIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "resGuestIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "membershipId", "value": "", "type": "query", "description": "Membership ID criteria." }, { "name": "membershipLevelCodes", "value": "", "type": "query" }, { "name": "membershipTypeCodes", "value": "", "type": "query" }, { "name": "surname", "value": "", "type": "query", "description": "Family name, last name." }, { "name": "givenName", "value": "", "type": "query", "description": "Given name, first name or names" }, { "name": "cityName", "value": "", "type": "query", "description": "City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address)." }, { "name": "postalCode", "value": "", "type": "query", "description": "Post Office Code number." }, { "name": "state", "value": "", "type": "query", "description": "State or Province name (e.g., Texas)." }, { "name": "countryCode", "value": "", "type": "query", "description": "Code for a country or a nationality." }, { "name": "streetAddress", "value": "", "type": "query", "description": "First Line of Street Address. For profile search it matches the first Address line." }, { "name": "bookingChannelCode", "value": "", "type": "query", "description": "Booking Channel Code" }, { "name": "blockHotelId", "value": "", "type": "query", "description": "The Hotel Code of the Block." }, { "name": "blockId", "value": "", "type": "query", "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." }, { "name": "blockIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "blockIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "recordLocator", "value": "", "type": "query", "description": "GDS Record Locator for reservation." }, { "name": "orderByAttributeName", "value": "", "type": "query" }, { "name": "orderType", "value": "", "type": "query" }, { "name": "roomId", "value": "", "type": "query", "description": "Room number of the reservation to search by." }, { "name": "roomType", "value": "", "type": "query", "description": "Room Type." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Instruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction." }, { "name": "excludeNoPost", "value": "", "type": "query", "description": "Indicates that reservations with No Post flag should not be expected from the result." }, { "name": "excludePMRooms", "value": "", "type": "query", "description": "Indicates that reservations with PM room type should not be expected from the result." }, { "name": "hasOpenFolio", "value": "", "type": "query", "description": "Indicates that only reservations with open folio should be expected from the result." }, { "name": "excludedReservationIds", "value": "", "type": "query", "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." }, { "name": "excludedReservationIdsContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "excludedReservationIdsType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "advanceCheckedIn", "value": "", "type": "query", "description": "Indicates to exclude Advance Checked In Reservations from search result." }, { "name": "searchTypesSearchType", "value": "", "type": "query", "description": "Represents Reservation search type Player Snapshot." }, { "name": "reservationStatus", "value": "", "type": "query", "description": "Reservation status type for reservations search." } ] }, "docs": "You can use this API to fetch the reservations for billing.OperationId:getReservationsForBilling
This API allows a time span of 50 days.
" }, { "info": { "name": "Get Daily Docket", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/dailyDocket", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" }, { "name": "docketDate", "value": "", "type": "query", "description": "log book date." }, { "name": "department", "value": "", "type": "query", "description": "Department code the log book entries belong to." } ] }, "docs": "Use this API to fetch Daily Dockets.OperationId:getDailyDocket
" }, { "info": { "name": "Create Daily Docket ", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/dailyDocket", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "Use this API to create a Daily Docket.OperationId:postDailyDocket
" }, { "info": { "name": "Change Daily Docket ", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/dailyDocket", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "Use this API to change Daily Docket.OperationId:putDailyDocket
" }, { "info": { "name": "Delete Daily Docket ", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/dailyDocket/:docketId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "docketId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "Use this API to delete a Daily Docket.OperationId:deleteDailyDocket
" }, { "info": { "name": "Requests room key(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/externalRoomKeys", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "API that manages requests for Door Lock Room Keys. This operation is used by OPERA Cloud PMS connected to external Door Lock Systems systems via Outbound Systems configuration: \n\nOPERA Cloud utilizes this operation \n\n- to request new or additional room keys - e.g. when guest checks in, or additional keys post check in.\n\n- to request to activate new keys after check on e.g. when a room key has been lost for a room.\n\n- to request a room key which is not related to a guest reservat" }, { "info": { "name": "Get floor plans", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/floorPlans", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" }, { "name": "room", "value": "", "type": "query", "description": "Room filter." } ] }, "docs": "Use this API to get Floor Plans for a property. Floor Plans provide a graphical layout of floors, rooms, and other physical features such as stairways, HVAC closets, elevators, and moreOperationId:getFloorPlans
" }, { "info": { "name": "Get the fullfillment activity log", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/fulfillmentActivityLogs", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." }, { "name": "module", "value": "", "type": "query", "description": "Activity module." }, { "name": "parameterName", "value": "", "type": "query", "description": "Name of the parameter." }, { "name": "parameterValue", "value": "", "type": "query", "description": "Value of the parameter." }, { "name": "activityGroup", "value": "", "type": "query" }, { "name": "activityType", "value": "", "type": "query" }, { "name": "fromDate", "value": "", "type": "query", "description": "Search from date for the user activity log." }, { "name": "toDate", "value": "", "type": "query", "description": "Search to date for the user activity log." }, { "name": "searchText", "value": "", "type": "query", "description": "Search text for the user activity log." }, { "name": "userByIds", "value": "", "type": "query" }, { "name": "userForIds", "value": "", "type": "query" } ] }, "docs": "You can use this API to get the fullfillment activity log.OperationId:getFulfillmentActivityLog
This API allows a time span of 180 days.
" }, { "info": { "name": "Get room interface status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/interfaces/:interfaceId/roomStatuses", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "interfaceId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" }, { "name": "interfaceName", "value": "", "type": "query", "description": "Name of the Hotel Interface" }, { "name": "interfaceType", "value": "", "type": "query", "description": "XML Posting Interface" }, { "name": "logo", "value": "", "type": "query", "description": "Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create." }, { "name": "machineName", "value": "", "type": "query", "description": "Unique machine name of the running IFC." }, { "name": "status", "value": "", "type": "query", "description": "Status of the Hotel Interface either STOPPED or RUNNING." }, { "name": "activeFlag", "value": "", "type": "query", "description": "Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING." }, { "name": "code", "value": "", "type": "query" }, { "name": "blockId", "value": "", "type": "query", "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." }, { "name": "blockIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "blockIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "roomId", "value": "", "type": "query", "description": "Wild card search value for Room number" }, { "name": "lastName", "value": "", "type": "query", "description": "Wild card search value to lookup reservations with this last name" }, { "name": "firstName", "value": "", "type": "query", "description": "Wild card search value to lookup reservations with this first name" }, { "name": "reservationIds", "value": "", "type": "query", "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." }, { "name": "reservationIdsContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationIdsType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "arrivalEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "arrivalStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "expectedArrivalEndTime", "value": "", "type": "query", "description": "The ending value of the time span." }, { "name": "expectedArrivalStartTime", "value": "", "type": "query", "description": "The starting value of the time span." }, { "name": "specialCodes", "value": "", "type": "query" }, { "name": "floorCodes", "value": "", "type": "query" }, { "name": "roomFeatureCodes", "value": "", "type": "query" }, { "name": "roomClassCodes", "value": "", "type": "query" }, { "name": "roomStatus", "value": "", "type": "query", "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService." }, { "name": "guaranteeCode", "value": "", "type": "query", "description": "Include reservations that have Guarantee Code(Reservation Type) only." }, { "name": "reservationStatus", "value": "", "type": "query", "description": "Reservation status type for reservations search." }, { "name": "includeLinkedReservations", "value": "", "type": "query", "description": "Include linked reservations." }, { "name": "includeBlocks", "value": "", "type": "query", "description": "Include reservations attached to a block." }, { "name": "orderBy", "value": "", "type": "query", "description": "A collection of supported sorting for Room Interface Status search results." }, { "name": "orderType", "value": "", "type": "query" }, { "name": "expectedReturnEndTime", "value": "", "type": "query", "description": "The ending value of the time span." }, { "name": "expectedReturnStartTime", "value": "", "type": "query", "description": "The starting value of the time span." }, { "name": "advanceCheckedIn", "value": "", "type": "query", "description": "Shows whether reservation is in Advance CheckIn state." }, { "name": "guaranteeCodes", "value": "", "type": "query", "description": "Fetches the reservation having Guarantee Codes(Reservation Type) supplied here. Example guaranteeCodes=6PM" } ] }, "docs": "This Api will getch the room interface status.OperationId:getRoomInterfaceStatus
This API allows a time span of 90 days.
" }, { "info": { "name": "Change room interface status", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/interfaces/:interfaceId/roomStatuses", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "interfaceId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "You can use this API to change room interface status.OperationId:putRoomInterfaceStatus
" }, { "info": { "name": "Get key encoder interface configuration details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/keyInterfaces", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" }, { "name": "roomNumbersCode", "value": "", "type": "query" }, { "name": "interfaceId", "value": "", "type": "query", "description": "Unique DB internal number of a Hotel Interface record." }, { "name": "orderBy", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] }, "docs": "You can use thie API to get key encoder interface configuration details.OperationId:getRoomKeyInterfaceDetails
" }, { "info": { "name": "Get the reservation in queue", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/queuedReservations", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" }, { "name": "roomClassCodes", "value": "", "type": "query" }, { "name": "roomTypeCodes", "value": "", "type": "query" }, { "name": "roomNumberWildCard", "value": "", "type": "query", "description": "Wildcard search of reservations in queue by Room Number." }, { "name": "guestNameWildCard", "value": "", "type": "query", "description": "Wildcard search of reservations in queue by Guest Name." } ] }, "docs": "Fetch all current reservations that are Queued Reservations. These reservations are guests that have arrived at the hotel, but their room isn't ready, so they're sitting in a queue.OperationId:getReservationsInQueue
" }, { "info": { "name": "Add reservation to queue", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/queuedReservations/:reservationId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "Using this API you can assign reservations to the reservation queue if the guest's room is not ready for assignment or if there are no available rooms of the room type attached to the reservation. Housekeeping staff can use the Queue Rooms functionality to determine if there are guests waiting to check in to a particular room or type of room; if there are, the queue list can provide guidance in determining which rooms need attention first.OperationId:addReservationToQueueOperationId:deleteReservationFromQueue
" }, { "info": { "name": "Get reservation summaries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservationSummaries", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" }, { "name": "searchType", "value": "", "type": "query", "description": "Represents Reservation search type Player Snapshot." }, { "name": "reservationId", "value": "", "type": "query", "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." }, { "name": "reservationIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "blockId", "value": "", "type": "query", "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." }, { "name": "blockIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "blockIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "arrivalEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "arrivalStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "departureEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "departureStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "stayOnEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "stayOnStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "createdOnEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "createOnStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "depositDateEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "depositDateStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "dateCriteriaExpectedArrivalEndTime", "value": "", "type": "query", "description": "The ending value of the time span." }, { "name": "dateCriteriaExpectedArrivalStartTime", "value": "", "type": "query", "description": "The starting value of the time span." }, { "name": "depositDueDateEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "depositDueDateStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "expectedReturnEndTime", "value": "", "type": "query", "description": "The ending value of the time span." }, { "name": "expectedReturnStartTime", "value": "", "type": "query", "description": "The starting value of the time span." }, { "name": "membershipNumber", "value": "", "type": "query", "description": "Lookup reservations with this membership number." }, { "name": "anyVIPStatus", "value": "", "type": "query", "description": "VIP status of the customer." }, { "name": "vipStatusCodes", "value": "", "type": "query", "description": "VIP status of the customer." }, { "name": "roomId", "value": "", "type": "query", "description": "Wildcard Search value to lookup reservation with this room number." }, { "name": "lastName", "value": "", "type": "query", "description": "Wildcard Search value to lookup reservations with this Last Name." }, { "name": "firstName", "value": "", "type": "query", "description": "Wildcard Search value to lookup reservations with this First Name." }, { "name": "blockCode", "value": "", "type": "query", "description": "Wildcard Search value to lookup reservation with this block code." }, { "name": "companyName", "value": "", "type": "query", "description": "Lookup reservations with this company name." }, { "name": "travelAgentName", "value": "", "type": "query", "description": "Lookup reservations with this travel agent name." }, { "name": "creditCardNumber", "value": "", "type": "query", "description": "Lookup reservations which has this credit card attached." }, { "name": "customReference", "value": "", "type": "query", "description": "Lookup reservations with this custom reference number." }, { "name": "externalReference", "value": "", "type": "query", "description": "Lookup reservations with this external reference id." }, { "name": "attributeName", "value": "", "type": "query" }, { "name": "orderType", "value": "", "type": "query" }, { "name": "expectedArrivalEndTime", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "expectedArrivalStartTime", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "roomTypes", "value": "", "type": "query", "description": "Room Type." }, { "name": "roomStatuses", "value": "", "type": "query", "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService." }, { "name": "paymentMethod", "value": "", "type": "query", "description": "Payment Method to search the reservation." }, { "name": "indicator", "value": "", "type": "query", "description": "Simple type that corresponds to reservation indicators." }, { "name": "fetchSummaryInstructions", "value": "", "type": "query", "description": "Simple type for reservation summary instructions that can be used in requests to fetch summary." }, { "name": "allowedAction", "value": "", "type": "query", "description": "Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation." }, { "name": "keyword", "value": "", "type": "query", "description": "Wildcard search value to lookup reservation summaries with RoomId or First Name or Last Name. If both keyword and roomId/firstName/lastName is specified, keyword will take precedence." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Simple type for reservation instructions that can be used in requests to fetch necessary reservation summary details." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "Use this API to return reservation summaries for a specific hotel based on search criteria such as reservationId, blockId, rrivalStart, membershipNumber, roomId, etc..OperationId:getReservationSummaries
This API allows a time span of 30 days.
" }, { "info": { "name": "Automated Intelligence Room Assignment last run status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/ai/rooms", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "This API fetches the last run status of an Automated Intelligence Room Assignment.OperationId:getAiraLastRunStatus
" }, { "info": { "name": "AI Assign Rooms", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/ai/rooms", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "This API runs AI Room Assignment and allocates rooms to incoming reservations.OperationId:assignRoomsAI
" }, { "info": { "name": "Assign the room automatically", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/autoRoomAssignments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "This API can be used to assign the room automatically.OperationId:autoAssignRoom
" }, { "info": { "name": "Auto unassign room", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/autoRoomAssignments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "query", "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." }, { "name": "idExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "includeDepartureRooms", "value": "", "type": "query", "description": "Indicates if departure rooms are to be included in the auto unassignment." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." }, { "name": "roomNumberWildcard", "value": "", "type": "query" }, { "name": "useAIRoomAssignment", "value": "", "type": "query", "description": "If the AI ROOM ASSIGNMENT application parameter is set to Y, this flag when set to true will use the AI Room Assignment algorithm to fetch the results in order of suitability." }, { "name": "useAssociatedProfilePreferences", "value": "", "type": "query", "description": "Indicates if preferences on the profile associated to the reservation should be used to determine the room type. The preferences for FLOOR, SMOKING and ROOM FEATURES will be used." }, { "name": "hotelRoomStatus", "value": "", "type": "query", "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService." }, { "name": "hotelFORoomStatus", "value": "", "type": "query", "description": "Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied." }, { "name": "fromRoomNumber", "value": "", "type": "query" }, { "name": "toRoomNumber", "value": "", "type": "query" }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" }, { "name": "roomType", "value": "", "type": "query", "description": "The room types of hotel rooms to be fetched." }, { "name": "roomClass", "value": "", "type": "query", "description": "The room class of hotel rooms to be fetched." }, { "name": "floor", "value": "", "type": "query", "description": "The floor of room to be fetched." }, { "name": "includeDueOut", "value": "", "type": "query", "description": "This flag when set to true when include rooms assigned to due out reservations." }, { "name": "departureTime", "value": "", "type": "query", "description": "When IncludeDueOut is enable,it is the departure time before which to search." }, { "name": "code", "value": "", "type": "query", "description": "A code representing a room feature." }, { "name": "description", "value": "", "type": "query", "description": "A code representing a room feature." }, { "name": "orderSequence", "value": "", "type": "query", "description": "Display Order sequence." }, { "name": "quantity", "value": "", "type": "query", "description": "Indicates quantity." }, { "name": "smokingPreference", "value": "", "type": "query", "description": "The smoking preference of room to be fetched." }, { "name": "includeAllRoomConditions", "value": "", "type": "query", "description": "This flag when set to true will include all room conditions, when set to false then room with \"General Assignment\" condition type will be excluded from the result." }, { "name": "includeComponentRooms", "value": "", "type": "query", "description": "This flag when set to true will include all component rooms" }, { "name": "includePseudoRooms", "value": "", "type": "query", "description": "This flag when set to true will include all pseudo rooms" }, { "name": "includeOORoomCheck", "value": "", "type": "query", "description": "This flag when set to true will work for Available Rooms functionality" }, { "name": "connectingRoomsOnly", "value": "", "type": "query", "description": "This flag when set to true will include only connecting rooms." }, { "name": "reservationIdId", "value": "", "type": "query", "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." }, { "name": "reservationIdIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "pseudoRoomsOnly", "value": "", "type": "query", "description": "This flag when set to true will include only pseudo rooms" }, { "name": "includeAttendentInRoom", "value": "", "type": "query", "description": "This flag when set to true will includes attendent in Rooms" } ] }, "docs": "This API can be used to auto unassign a room.OperationId:autoUnAssignRoom
" }, { "info": { "name": "Mass Advance Check in Reservations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/massAdvanceCheckIns", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "Use this API to perform a mass advance checkin for reservations.OperationId:postMassAdvanceCheckIn
" }, { "info": { "name": "Mass checkin reservations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/massCheckIns", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "Use this API to perform a mass Checkin for reservations.OperationId:postMassCheckIn
" }, { "info": { "name": "Advance checkin a reservation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/advanceCheckIns", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "At times, when guests arrive to the property prior to a room being ready, you can flag a reservation as Advance Checked In for arrivals due in on the current business date. This enables guests to post charges to their reservation folio prior to check in, and helps the rooms management team prioritize room cleaning and assignment. Individual reservations (including Walk In reservations, Pre Registered reservations, and reservations that are in Queue) and group block reservations can be Advance Ch" }, { "info": { "name": "Reverse Advance Checkin ", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/advanceCheckIns", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "Reverse an advance check in for a reservation.OperationId:deleteAdvanceCheckIn
" }, { "info": { "name": "Checks in a guest", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/checkIns", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is being booked" } ] }, "docs": "Use this API to check in a guest reservation. The reservation needs to be 'due in' status. The API also provides an option to select an available room.OperationId:postCheckIn
" }, { "info": { "name": "Revert a checked-in Reservation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/checkIns", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" }, { "name": "roomStatus", "value": "", "type": "query", "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService." }, { "name": "unassignRoom", "value": "", "type": "query", "description": "This option is used when all reservation check-in is reversed and the user wants to choose if the room is to be blocked. If all check-ins are not reversed, this is ignored and a default value false is used." }, { "name": "sharersList", "value": "", "type": "query", "description": "List of sharers IDs linked to the reservation selected to be reverse check in." }, { "name": "backToBackResvList", "value": "", "type": "query", "description": "List of back to back reservation IDs linked to the reservation selected." } ] }, "docs": "Use this API to revert a reservation that has been checked in. This will return the reservation to a Due in/Arrival status.OperationId:deleteCheckin
" }, { "info": { "name": "Fetch the keysOptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/keyOptions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique identifier of the reservation" }, { "name": "hotelId", "value": "", "type": "path", "description": "Name of the resort." } ] }, "docs": "This API is used to retrieve the key options attached to the room, reservation and profile. These key options are preferences that correspond to the Door Lock System in use that control the access to areas with the room key. Key option preferences can be configured and saved on profiles, rooms, and reservations to be included when requesting a room key.OperationId:getKeyOptions
" }, { "info": { "name": "Get linked reservations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/linked", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" }, { "name": "additionalReservationId", "value": "", "type": "query", "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." }, { "name": "additionalReservationIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "additionalReservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "Use this API to view the reservations that are linked to the specified reservation.OperationId:getLinkedReservations
" }, { "info": { "name": "Change the reservation queue priority", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/priority", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "This API can be used to change the resrevations Queue Priority.OperationId:putReservationQueuePriority
" }, { "info": { "name": "Assign a Room to a Reservation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/roomAssignments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "This API will allow you to assign a room to a reservation in reserved status. Override instructions are available to assign a room despite warnings returned in the response message.OperationId:postRoomAssignment
" }, { "info": { "name": "Fetch the room keys", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/roomKeys", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" }, { "name": "includeInactiveRoomKeys", "value": "", "type": "query", "description": "Setting this to true will include inactive rooms keys details. This is supported when OPERA Control Multiple Guest Room Key is active." }, { "name": "interfaceId", "value": "", "type": "query", "description": "Unique DB internal number of a Hotel Interface record." } ] }, "docs": "You can use this API to retrieve any existing room key information for a reservation.OperationId:getRoomKeys
" }, { "info": { "name": "Requests room key(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/roomKeys", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "You can use this API to create a room key request for a reservation to the active Door Locking System Property Interface.OperationId:postRoomKey
" }, { "info": { "name": "Update room keys.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/roomKeys", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "When MUTIPLE_GUEST_KEY is active this methods can be used to update information on the room keys such as balance amount and keyOptions. reservationId and hotelId are required path parameters. The body parameter roomKeys includes information about the encoder, room, key type, key validity, key options and guests information for multiple keys" }, { "info": { "name": "Delete room key", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/roomKeys", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "This API will delete room keys on a reservation.OperationId:deleteRoomKey
" }, { "info": { "name": "Get room move history of a reservation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/roomMoveHistory", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" }, { "name": "reservationIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "This API will return the history of room change/room moves for a specified reservation.OperationId:getRoomMoveHistory
" }, { "info": { "name": "Remove an assigned room", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/rooms", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "This API will allow you to remove an assigned room from a reservation in reserved status.OperationId:deleteAssignRoom
" }, { "info": { "name": "Move in-house guest", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/rooms/:roomId/roomMoves", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "roomId", "value": "", "type": "path" }, { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "This API will allow you to change rooms for an in-house guest.OperationId:moveInHouseGuest
" }, { "info": { "name": "Get Suggested Rooms", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/suggestedRooms", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Unique reservation identifier for the reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Property where the reservation exists." }, { "name": "roomType", "value": "", "type": "query", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." }, { "name": "startDate", "value": "", "type": "query", "description": "Date of arrival." }, { "name": "nights", "value": "", "type": "query", "description": "Number of nights that guest will be staying." }, { "name": "suggestedRoomsInstructions", "value": "", "type": "query", "description": "Instruction to include commponent room." }, { "name": "roomFeatureCode", "value": "", "type": "query", "description": "A code representing a room feature." } ] }, "docs": "You can use this API to fetch the suggested rooms.OperationId:getSuggestedRooms
" }, { "info": { "name": "Deliver Queue rooms text message", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/textMessages/:messageType", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "messageType", "value": "", "type": "path" }, { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "This API will deliver Queue rooms text message.OperationId:deliverQueueRoomsTextMessage
" }, { "info": { "name": "Verify checkin reservation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/verifyCheckIns", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" }, { "name": "verifyCheckinInstructions", "value": "", "type": "query", "description": "Instructions for including in the request when retrieving reservation information. Voucher - indicates to generate vouchers,if reservation matches voucher rule." } ] }, "docs": "Use this API to verify checkin reservations.OperationId:verifyCheckinReservation
" }, { "info": { "name": "Get Wake Up Call", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/wakeUpCalls", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" }, { "name": "fetchCancelled", "value": "", "type": "query", "description": "Specifies whether we should fetch wake up calls with pending status." }, { "name": "fetchCompleted", "value": "", "type": "query", "description": "Specifies whether we should fetch wake up calls with pending status." }, { "name": "fetchNoAnswer", "value": "", "type": "query", "description": "Specifies whether we should fetch wake up calls with pending status." }, { "name": "fetchPending", "value": "", "type": "query", "description": "Specifies whether we should fetch wake up calls with pending status." }, { "name": "idExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "reservationIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "beginDate", "value": "", "type": "query", "description": "Begin date from which to start fetching wake up calls." }, { "name": "endDate", "value": "", "type": "query", "description": "End date from which to start fetching wake up calls." }, { "name": "beginTime", "value": "", "type": "query", "description": "Begin time from which to start fetching wake up calls." }, { "name": "endTime", "value": "", "type": "query", "description": "End time from which to start fetching wake up calls." }, { "name": "room", "value": "", "type": "query", "description": "Hotel room(s) for which wake up calls are to be fetched." }, { "name": "blockId", "value": "", "type": "query", "description": "Block code for which wake up calls are to be fetched." }, { "name": "guestName", "value": "", "type": "query", "description": "Name with which wake up call may be associated." } ] }, "docs": "Use thisAPI to get existing wake up call on an in-house reservation.OperationId:getWakeUpCall
This API allows a time span of 90 days.
" }, { "info": { "name": "Create Wake Up Call", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/wakeUpCalls", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "You can set, view, and cancel wake up call for individual reservations. The reservation must be in-house (checked-in) status to set a wake up call.OperationId:postWakeUpCall
" }, { "info": { "name": "Change Wake Up Call", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/wakeUpCalls", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "Update an existing wake up call. Wake up call can only be added to in-house reservations.OperationId:putWakeUpCall
" }, { "info": { "name": "Delete Wake Up Call", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/wakeUpCalls", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" }, { "name": "callTime", "value": "", "type": "query", "description": "Time on which wake up call is set." }, { "name": "followUpCallTime", "value": "", "type": "query", "description": "Follow up call time." }, { "name": "startDate", "value": "", "type": "query" }, { "name": "newCallTime", "value": "", "type": "query", "description": "New Time on which wake up call is set. Used to change the Followup Call time" }, { "name": "newFollowUpCallTime", "value": "", "type": "query", "description": "New Follow up call time.Used to change the Followup Call time." } ] }, "docs": "Use this API to cancel a wake up call on a reservation.OperationId:deleteWakeUpCall
" }, { "info": { "name": "Fetch keysOptions for the reservation and the guest profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservationsKeyOptions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationIdList", "value": "", "type": "query", "description": "A list of reservation ids to fetch key options for." }, { "name": "hotelId", "value": "", "type": "path", "description": "Name of the resort." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." } ] }, "docs": "This API is used to retrieve the key options attached to the room, reservation and profile for all the reservations in reservationIdList. These key options are preferences that correspond to the Door Lock System in use that control the access to areas with the room key. Key option preferences can be configured and saved on profiles, rooms, and reservations to be included when requesting a room key.OperationId:getKeyOptions
" }, { "info": { "name": "Read room key", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/roomKeysDetails", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" }, { "name": "encoderTerminal", "value": "", "type": "query" }, { "name": "interfaceId", "value": "", "type": "query", "description": "Unique DB internal number of a Hotel Interface record." }, { "name": "encoderId", "value": "", "type": "query", "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." }, { "name": "encoderIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "encoderIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "This API can be used to read the Room Key.OperationId:readRoomKey
" }, { "info": { "name": "Requests room key(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/roomKeysExternal", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "API that manages requests for Door Lock Room Keys. This operation is used by OPERA Cloud PMS connected to external Door Lock Systems systems via Outbound Systems configuration: \n\nOPERA Cloud utilizes this operation \n\n- to request new or additional room keys - e.g. when guest checks in, or additional keys post check in.\n\n- to request to activate new keys after check on e.g. when a room key has been lost for a room.\n\n- to request a room key which is not related to a guest reservat" }, { "info": { "name": "Get hotel rooms", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/rooms", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." }, { "name": "roomNumberWildcard", "value": "", "type": "query" }, { "name": "hotelRoomStatus", "value": "", "type": "query", "description": "Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService." }, { "name": "hotelFORoomStatus", "value": "", "type": "query", "description": "Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied. When sending Occupied, also send includeDueOut = true to return all Due Out rooms (occupied) along with the vacant rooms." }, { "name": "fromRoomNumber", "value": "", "type": "query" }, { "name": "toRoomNumber", "value": "", "type": "query" }, { "name": "hotelRoomStartDate", "value": "", "type": "query" }, { "name": "hotelRoomEndDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" }, { "name": "roomType", "value": "", "type": "query", "description": "The room types of hotel rooms to be fetched." }, { "name": "roomClass", "value": "", "type": "query", "description": "The room class of hotel rooms to be fetched." }, { "name": "floor", "value": "", "type": "query", "description": "The floor of room to be fetched." }, { "name": "includeDueOut", "value": "", "type": "query", "description": "This flag when set to true will include rooms assigned to due out reservations." }, { "name": "departureTime", "value": "", "type": "query", "description": "When IncludeDueOut is enable,it is the departure time before which to search." }, { "name": "roomFeatureCode", "value": "", "type": "query", "description": "A code representing a room feature." }, { "name": "description", "value": "", "type": "query", "description": "A code representing a room feature." }, { "name": "orderSequence", "value": "", "type": "query", "description": "Display Order sequence." }, { "name": "quantity", "value": "", "type": "query", "description": "Indicates quantity." }, { "name": "smokingPreference", "value": "", "type": "query", "description": "The smoking preference of room to be fetched." }, { "name": "includeAllRoomConditions", "value": "", "type": "query", "description": "This flag when set to true will include all room conditions, when set to false then room with \"General Assignment\" condition type will be excluded from the result." }, { "name": "includeComponentRooms", "value": "", "type": "query", "description": "This flag when set to true will include all component rooms" }, { "name": "includePseudoRooms", "value": "", "type": "query", "description": "This flag when set to true will include all pseudo rooms" }, { "name": "includeOORoomCheck", "value": "", "type": "query", "description": "This flag when set to true will work for Available Rooms functionality" }, { "name": "connectingRoomsOnly", "value": "", "type": "query", "description": "This flag when set to true will include only connecting rooms." }, { "name": "reservationId", "value": "", "type": "query", "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." }, { "name": "reservationIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "pseudoRoomsOnly", "value": "", "type": "query", "description": "This flag when set to true will include only pseudo rooms" }, { "name": "includeAttendentInRoom", "value": "", "type": "query", "description": "This flag when set to true will includes attendent in Rooms" }, { "name": "includeRotationRoom", "value": "", "type": "query", "description": "This flag when set to true will return the rotation room when room roation parameter is active and the room type is configured for rotation." }, { "name": "ownerRoomsOnly", "value": "", "type": "query", "description": "When this flag is set to true, this API will fetch rooms which are contracted with owner profiles. This is supported when OPERA Control Room Rotation is active." }, { "name": "ownerExclusiveRoomsOnly", "value": "", "type": "query", "description": "When this flag is set to true, this API will fetch rooms can only be used by the reservation's profile (owner) of the room. This is supported when OPERA Control Room Rotation is active." }, { "name": "eligiblePseudoRoomsOnly", "value": "", "type": "query", "description": "If set to true, only pseudo rooms that meet ALL of the following conditions are included in the results:\n- Not configured in the OPERA Control Setting for POS Accounts.\n- Not checked out on the current business day (ensures a 'clean' pseudo room).\n- Excludes rooms named 'Lost Postings Interface Room' and 'Default Deposit Tax Room'.\nA pseudo room is a room record used for non-inventory or system purposes, such as posting masters or special billing scenarios. Apply this filter to ensure only fully eligible/assignable pseudo rooms are returned." }, { "name": "perfectFitRoomsOnly", "value": "", "type": "query", "description": "When this flag is set to true, this API will fetch only those rooms that have exactly Y nights free with the reservation guest(s) points." }, { "name": "orderBy", "value": "", "type": "query", "description": "A collection of supported sorting for available rooms search results." }, { "name": "sortOrder", "value": "", "type": "query" }, { "name": "unitGradeCodes", "value": "", "type": "query", "description": "Fetches rooms that matches requested unit grade codes. Only returns when Room Rotation and Unit Grade are active." }, { "name": "ownerExclusiveRoomProfileId", "value": "", "type": "query", "description": ": This OPERA profile?s internal Id will be used with ownerExclusiveRoomOnly flag to return the room which own by this profile. This query parameter is supported when OPERA Control Room Rotation is active." }, { "name": "excludeRoomFeatures", "value": "", "type": "query", "description": "It indicates to exclude rooms with the selected Room Feature(s).It allows alphanumeric values(e.g.,TUB,BOLCONY,MV)" }, { "name": "excludeFloorPreferences", "value": "", "type": "query", "description": "It indicates to exclude rooms with the selected Floor(s) which are comma separated values.It allows alphanumeric values(e.g.,01,02,03,GROUND,five)" }, { "name": "includeScheduledMoveOutRoom", "value": "", "type": "query", "description": "This flag when set to true will include rooms assigned to move out reservations. This query parameter is supported when OPERA Control Advanced Daily Details is active." }, { "name": "scheduledRoomMoveOutTime", "value": "", "type": "query", "description": "When IncludeMoveOut is enabled, it is the move out time before which to search. It will return rooms assigned to moving reservations that have a scheduled move out time before the entered time. This query parameter is supported when OPERA Control Advanced Daily Details is active" }, { "name": "exactMatchRoomNumber", "value": "", "type": "query", "description": "When this flag is set to true, this API will fetch the exact match of the room number entered in the Move Room screen, in case the move in room is marked as Do Not Move. Do Not Move functionality is available when the Do Not Move OPERA Control is active. Scheduled Room Move functionality is available when the Advance Daily Detail OPERA Control is active." }, { "name": "includeNextStayInfo", "value": "", "type": "query", "description": "When true, the response will include 'nightsToNextStay' and 'nextStayDate' for each room inside 'roomOccupancyInfo'." } ] }, "docs": "This API will allow you to search for available rooms based on various search criteria such as hotelId, hotelRoomStatus, roomType, roomFeatureCode, etc.. This is to find suitable rooms to assign them to a reservation in the next step. This is not to search for hotel availability in order to make a reservation.OperationId:getHotelRooms
This API allows a time span of 180 days.
" }, { "info": { "name": "Place Rooms On Hold", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/rooms/onHold", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "You can use this API to place Rooms On Hold.OperationId:placeRoomsOnHold
" }, { "info": { "name": "Release Rooms On Hold", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/rooms/onHold/release", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "You can use this API to release Rooms On Hold.OperationId:releaseRoomsOnHold
" }, { "info": { "name": "Get Service Requests", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/serviceRequests", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" }, { "name": "hotelIds", "value": "", "type": "query" }, { "name": "code", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "priorityCodes", "value": "", "type": "query" }, { "name": "departmentCodes", "value": "", "type": "query" }, { "name": "reservationId", "value": "", "type": "query", "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." }, { "name": "reservationIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "profileId", "value": "", "type": "query", "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." }, { "name": "profileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "profileIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "room", "value": "", "type": "query", "description": "The room number in which the service request was created." }, { "name": "creationEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "creationStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "closedEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "closedStartDate", "value": "", "type": "query", "description": "The starting value of the date range." } ] }, "docs": "Use this API to retrieve any service requests that exist on a reservation.OperationId:getServiceRequests
This API allows a time span of 30 days.
" }, { "info": { "name": "Create Service Requests", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/serviceRequests", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "Service Request functionality provides the ability to define, track and report Service Requests on a reservation. They go through a preset flow including creating the request, completing it and then following up on the resolution with the guest.OperationId:postServiceRequests
" }, { "info": { "name": "Change Service Requests", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/serviceRequests", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "Use this API to modify any service requests that exist on a reservation.OperationId:putServiceRequests
" }, { "info": { "name": "Delete Service Requests", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/serviceRequests/:serviceRequestId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "serviceRequestId", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "Use this API to delete any service requests that exist on a reservation.OperationId:deleteServiceRequests
" }, { "info": { "name": "Operation for Shift Rooms between two reservations", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/sourceReservations/:sourceReservationId/targetReservations/:targetReservationId/shiftRooms", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" }, { "name": "sourceReservationId", "value": "", "type": "path" }, { "name": "targetReservationId", "value": "", "type": "path" }, { "name": "overrideBackToBackRoomSkip", "value": "", "type": "query", "description": "Specifies if the Swap/Shift action should continue regardless of the reservation having a Back to Back Linked Reservation assigned to the same room. Swap/Shift functionality is available when the Swap/Shift Rooms OPERA Control is active. Back to Back Reservation handling is available when the Back to Back Handling for Linked Reservations OPERA Control is active." } ] }, "docs": "This API will allow you to quickly shift rooms for two reservations.OperationId:shiftRooms
" }, { "info": { "name": "Operation for Swap/Shift Rooms between two reservations", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/sourceReservations/:sourceReservationId/targetReservations/:targetReservationId/swapRooms", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" }, { "name": "sourceReservationId", "value": "", "type": "path" }, { "name": "targetReservationId", "value": "", "type": "path" }, { "name": "overrideBackToBackRoomSkip", "value": "", "type": "query", "description": "Specifies if the Swap/Shift action should continue regardless of the reservation having a Back to Back Linked Reservation assigned to the same room. Swap/Shift functionality is available when the Swap/Shift Rooms OPERA Control is active. Back to Back Reservation handling is available when the Back to Back Handling for Linked Reservations OPERA Control is active." } ] }, "docs": "This API will allow you to quickly swap rooms for two reservations.OperationId:swapRooms
" }, { "info": { "name": "Get Queue room text message", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/textMessages/:messageType", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "messageType", "value": "", "type": "path" }, { "name": "hotelId", "value": "", "type": "path" }, { "name": "reservationId", "value": "", "type": "query", "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." }, { "name": "reservationIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "mobileNumber", "value": "", "type": "query", "description": "Mobile number that the text message will be delivered to." } ] }, "docs": "You can use this API to get Queue room text message.OperationId:getQueueRoomsTextMessage
" }, { "info": { "name": "Get Wake Up Calls", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/wakeUpCalls", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" }, { "name": "fetchCancelled", "value": "", "type": "query", "description": "Specifies whether we should fetch wake up calls with pending status." }, { "name": "fetchCompleted", "value": "", "type": "query", "description": "Specifies whether we should fetch wake up calls with pending status." }, { "name": "fetchNoAnswer", "value": "", "type": "query", "description": "Specifies whether we should fetch wake up calls with pending status." }, { "name": "fetchPending", "value": "", "type": "query", "description": "Specifies whether we should fetch wake up calls with pending status." }, { "name": "reservationId", "value": "", "type": "query", "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." }, { "name": "idExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "reservationIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "beginDate", "value": "", "type": "query", "description": "Begin date from which to start fetching wake up calls." }, { "name": "endDate", "value": "", "type": "query", "description": "End date from which to start fetching wake up calls." }, { "name": "beginTime", "value": "", "type": "query", "description": "Begin time from which to start fetching wake up calls." }, { "name": "endTime", "value": "", "type": "query", "description": "End time from which to start fetching wake up calls." }, { "name": "room", "value": "", "type": "query", "description": "Hotel room(s) for which wake up calls are to be fetched." }, { "name": "blockId", "value": "", "type": "query", "description": "Block code for which wake up calls are to be fetched." }, { "name": "guestName", "value": "", "type": "query", "description": "Name with which wake up call may be associated." } ] }, "docs": "Use thisAPI to get existing wake up calls on an in-house reservation.OperationId:getWakeUpCalls
" }, { "info": { "name": "Get Wake Up Calls", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/wakeUpCalls/searches", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "Use thisAPI to get existing wake up calls on an in-house reservation.OperationId:searchWakeUpCalls
" }, { "info": { "name": "Ping Front Desk Service", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/services/frontDeskOperations/status", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Ping front desk serviceOperationId:pingFrontDeskOperationsService
" } ] }, { "info": { "name": "Commissions", "type": "folder" }, "items": [ { "info": { "name": "Operation to fetch bank accounts.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/bankAccounts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Property of the bank accounts." }, { "name": "bankName", "value": "", "type": "query", "description": "Either full or first part of the bank name." }, { "name": "bankAccountNo", "value": "", "type": "query", "description": "Either full or first part of the bank account number." }, { "name": "currency", "value": "", "type": "query", "description": "Currency used by the bank account." } ] }, "docs": "OperationId:getBankAccounts
" }, { "info": { "name": "Operation to fetch bank accounts.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/bankAccounts/searches", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Property of the bank accounts." } ] }, "docs": "OperationId:searchBankAccounts
" }, { "info": { "name": "Operation to fetch Reservations for Commissions associated to a Travel Agent", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/bankAccounts/:bankAccountId/agents/:agentId/reservationsForCommissions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Reservations for commissions." }, { "name": "bankAccountId", "value": "", "type": "path", "description": "A unique identifying value(ID) to represent the Bank." }, { "name": "agentId", "value": "", "type": "path", "description": "A unique identifying value(ID) to represent the Travel Agent associated with the commission." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "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." }, { "name": "guestName", "value": "", "type": "query", "description": "Indicates the guest name of the reservation that is to be returned " }, { "name": "confirmationNo", "value": "", "type": "query", "description": "Indicates the confirmation number of the reservation that is to be returned " }, { "name": "reservationStatus", "value": "", "type": "query", "description": "Indicates the status of the reservations that is to be returned " }, { "name": "accountReceivableOffset", "value": "", "type": "query", "description": "When set to true only reservations flagged for account receivables are returned" }, { "name": "onHold", "value": "", "type": "query", "description": "When set to true only reservations having a commission hold code are returned" }, { "name": "commissionPaid", "value": "", "type": "query", "description": "When set to true only reservations having paid the commissions are returned" } ] }, "docs": "OperationId:getReservationsForCommissions
The maximum allowable limit for this API is 50.
" }, { "info": { "name": "Operation to fetch Reservations for Commissions associated to a Travel Agent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/bankAccounts/:bankAccountId/agents/:agentId/reservationsForCommissions/searches", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Reservations for commissions." }, { "name": "bankAccountId", "value": "", "type": "path", "description": "A unique identifying value(ID) to represent the Bank." }, { "name": "agentId", "value": "", "type": "path", "description": "A unique identifying value(ID) to represent the Travel Agent associated with the commission." } ] }, "docs": "OperationId:searchReservationsForCommissions
The maximum allowable limit for this API is 50.
" }, { "info": { "name": "Operation to change commission check.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/bankAccounts/:bankAccountId/commissionChecks", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "bankAccountId", "value": "", "type": "path", "description": "Unique id of bank account." }, { "name": "hotelId", "value": "", "type": "path", "description": "Property of the commission record." } ] }, "docs": "OperationId:changeCommissionCheck
" }, { "info": { "name": "Operation to fetch commission payments activity.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/bankAccounts/:bankAccountId/commissionPayments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "bankAccountId", "value": "", "type": "path", "description": "Unique id of bank account." }, { "name": "hotelId", "value": "", "type": "path", "description": "Property of the commission record." }, { "name": "idExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "batchId", "value": "", "type": "query", "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." }, { "name": "batchIdIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "batchIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "batchIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "fileName", "value": "", "type": "query", "description": "File name if payment method is EFT." }, { "name": "payee", "value": "", "type": "query", "description": "File name if payment method is EFT." }, { "name": "checkNo", "value": "", "type": "query", "description": "Check no of payment." }, { "name": "status", "value": "", "type": "query", "description": "Simple type for payment activity status type. Valid values are Outstanding, Reconciled, Unpresented and Void." } ] }, "docs": "OperationId:getCommissionPaymentsActivity
" }, { "info": { "name": "Operation to change commission payment activity by range.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/bankAccounts/:bankAccountId/commissionPayments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "bankAccountId", "value": "", "type": "path", "description": "Unique id of bank account." }, { "name": "hotelId", "value": "", "type": "path", "description": "Property of the commission record." } ] }, "docs": "OperationId:changeCommissionPaymentActivityByRange
" }, { "info": { "name": "Operation to reprint commission check by range.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/bankAccounts/:bankAccountId/reprintCommission", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "bankAccountId", "value": "", "type": "path", "description": "Unique id of bank account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Property of the commission record." } ] }, "docs": "OperationId:reprintCommissionCheckByRange
" }, { "info": { "name": "Operation to fetch Travel Agents associated with commissions for the given bank Account.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/bankAccounts/:bankAccountId/travelAgentsForCommissions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Property of the Travel Agent records." }, { "name": "bankAccountId", "value": "", "type": "path", "description": "A unique identifying value(ID) to represent the Bank" } ] }, "docs": "OperationId:getTravelAgentsForCommissions
" }, { "info": { "name": "Operation to associate commission agent to reservations.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/commissionAgent/:commissionAgentId/commissions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "commissionAgentId", "value": "", "type": "path", "description": "Unique Id of the Commission Agent." }, { "name": "hotelId", "value": "", "type": "path", "description": "All reservation ids in the list must belong to this property." } ] }, "docs": "OperationId:associateCommissionAgentToReservations
" }, { "info": { "name": "Operation to remove commission agent from reservations.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/commissionAgent/:commissionAgentId/commissions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "commissionAgentId", "value": "", "type": "path", "description": "Unique Id of the Commission Agent." }, { "name": "hotelId", "value": "", "type": "path", "description": "All reservation ids in the list must belong to this property." }, { "name": "commissionAgentType", "value": "", "type": "query", "description": "Simple type for commission agent type. Valid values are Agent and Source." }, { "name": "idExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "reservationId", "value": "", "type": "query", "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." }, { "name": "reservationIdIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "reservationIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "OperationId:removeCommissionAgentFromReservations
" }, { "info": { "name": "Operation to discard commission checks.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/commissionChecks", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Property of the commission record." }, { "name": "bankAccountId", "value": "", "type": "query", "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." }, { "name": "idExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "BatchId", "value": "", "type": "query", "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." }, { "name": "batchIdIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "batchIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "batchIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "fromCheck", "value": "", "type": "query", "description": "The range start value of checks to be discarded." } ] }, "docs": "OperationId:discardCommissionChecks
" }, { "info": { "name": "Operation to process commission payments.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/commissionPayments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Property of the commission record." } ] }, "docs": "OperationId:processCommissionPayments
" }, { "info": { "name": "Operation to fetch commissions. The search results are filtered based on the provided criteria, with a specific hierarchy applied when multiple parameters are specified. The filtering parameters are prioritized in the following order: batchId, resvNameId, agentId, and bankAccountId, with the highest-priority parameter being used to narrow down the results.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/commissions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Property of the commission record." }, { "name": "bankAccountId", "value": "", "type": "query", "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." }, { "name": "idExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "agentId", "value": "", "type": "query", "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." }, { "name": "agentIdIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "agentIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "agentIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "resvNameId", "value": "", "type": "query", "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." }, { "name": "resvNameIdIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "resvNameIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "resvNameIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "commissionId", "value": "", "type": "query", "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." }, { "name": "commissionIdIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "commissionIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "commissionIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "batchId", "value": "", "type": "query", "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." }, { "name": "batchIdIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "batchIdIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "batchIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "OperationId:getCommissions
" }, { "info": { "name": "Operation to calculate commissions.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/commissions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Property of the commissions to be calculated." } ] }, "docs": "OperationId:calculateCommissions
" }, { "info": { "name": "Operation to set processing instructions.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/commissions/instructions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Property from which the agent will be on hold for commission." } ] }, "docs": "OperationId:setProcessingInstructions
" }, { "info": { "name": "Operation to fetch commission.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/commissions/:commissionId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "commissionId", "value": "", "type": "path", "description": "Unique id of the commission." }, { "name": "hotelId", "value": "", "type": "path", "description": "Property of the commission record." }, { "name": "idExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "OperationId:getCommission
" }, { "info": { "name": "Operation to change commission.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/commissions/:commissionId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "commissionId", "value": "", "type": "path", "description": "Unique id of the commission." }, { "name": "hotelId", "value": "", "type": "path", "description": "Property of the commission record." } ] }, "docs": "OperationId:changeCommission
" }, { "info": { "name": "Operation to remove commission.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/commissions/:commissionId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "commissionId", "value": "", "type": "path", "description": "Unique id of the commission." }, { "name": "hotelId", "value": "", "type": "path", "description": "Property of the commission record." }, { "name": "idExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "detachDescription", "value": "", "type": "query", "description": "Used for Character Strings, length 0 to 2000." } ] }, "docs": "OperationId:removeCommission
" }, { "info": { "name": "Operation to recalculate commission on code change.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/commissions/:commissionId/commissionCodes/:commissionCode/recalculate", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "commissionCode", "value": "", "type": "path", "description": "New commission code." }, { "name": "commissionId", "value": "", "type": "path", "description": "Unique id of the commission." }, { "name": "hotelId", "value": "", "type": "path", "description": "Property of the commission record." } ] }, "docs": "OperationId:recalculateCommissionOnCodeChange
" }, { "info": { "name": "Operation to fetch commission notes.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/commissionNotes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "reservationId", "value": "", "type": "path", "description": "Reservation Id for which the commission notes are to be fetched." }, { "name": "hotelId", "value": "", "type": "path", "description": "Property code against which commissions notes are to be fetched." }, { "name": "idExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "OperationId:getCommissionNotes
" }, { "info": { "name": "Fetch Commission Payment Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/commissionPaymentDetails", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "reservationId", "value": "", "type": "path", "description": "Unique ID of the reservation" } ] }, "docs": "You can use this API to fetch commission payment details.OperationId:getCommissionPaymentDetails
" }, { "info": { "name": "Ping Commissions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/services/commissions/status", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Get the commissions service versionOperationId:pingCommissionsService
" } ] }, { "info": { "name": "FOFStats", "type": "folder" }, "items": [ { "info": { "name": "Get front office Statistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/frontOfficeStatistics/:statisticsCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "statisticsCode", "value": "", "type": "path", "description": "Below are the Statistics Code mapping for valid metric code.AdvanceCheckIn:
IndividualAdvanceCheckedInCurrent,BlockAdvanceCheckedInInhouse,BlockAdvanceCheckedInTotal,IndividualAdvanceCheckedInInhouse,IndividualAdvanceCheckedInTotal,BlockAdvanceCheckedInCurrent;AIRoomAssignment:
MaxPercentageOccupiedTonightRooms,ArrivalResvs,ArrivalVIPResvs,ArrivalMemberResvs,ArrivalUnallocResvs,ArrivalManualAssgnResvs,ArrivalAIAssgnResvs,ArrivalAIUpgResvs,ArrivalAIAssgnVIPResvs,ArrivalAIAssgnMemberResvs,ArrivalAIAssgnOverridden;AvailableRooms:
MinAvailableTonightRooms;CheckIns:
ArrivalsTotal,CheckedInsTotal,ExpectedCheckInsTotal,QueueRooms;CheckOuts:DeparturesTotal,CheckedOutsTotal,AdultsDeparted,ChildrenDeparted,ExpectedCheckOutsTotal,AdultsExpectedCheckedOut,ChildrenExpectedCheckedOut,ScheduledCheckOutsTotal;ComplimentaryOrHouseUse:
ComplimentaryArrivalRooms,ComplimentaryArrivalPersons,ComplimentaryArrivalVIP,ComplimentaryStayoverRooms,ComplimentaryStayoverPersons,ComplimentaryStayoverVIP,ComplimentaryDepartureRooms,ComplimentaryDeparturePersons,ComplimentaryDepartureVIP,HouseUseArrivalRooms,HouseUseArrivalPersons,HouseUseArrivalVIP,HouseUseStayoverRooms,HouseUseStayoverPersons,HouseUseStayoverVIP,HouseUseDepartureRooms,HouseUseDeparturePersons,HouseUseDepartureVIP;DailyProjection:
IndividualRooms,IndividualPersons,IndividualVIP,GroupAndBlockRooms,GroupAndBlockPersons,GroupAndBlockVIP,MaxOccupiedTonightRooms,MaxOccupiedTonightPersons,MaxOccupiedTonightVIP,BlocksNotPickedUp,MaxPercentageOccupiedTonightRooms,MinAvailableTonightRooms,RoomRevenue,TotalRevenue,AverageRoomRevenue,RevPar;HouseSummary:
TotalPhysicalRooms,TotalOutOfOrder,TotalOutOfService,TotalRoomsToSell,MaxOccupiedTonightRooms,PercentRoomsOccupied,RoomRevenue,TotalRevenue,RevPar,AverageRoomRevenue;HouseSummaryMonthToDate:
TotalPhysicalRooms,TotalOutOfOrder,TotalOutOfService,TotalRoomsToSell,MaxOccupiedTonightRooms,PercentRoomsOccupied,RoomRevenue,RevPar,TotalRevenue,AverageRoomRevenue;HouseSummaryYearToDate:
TotalPhysicalRooms,TotalOutOfOrder,TotalOutOfService,TotalRoomsToSell,MaxOccupiedTonightRooms,PercentRoomsOccupied,RoomRevenue,RevPar,TotalRevenue,AverageRoomRevenue;InHouse:
AdultsInHouse,ChildrenInHouse,InHouseRooms,InHouse;LastHourStatus:
ArrivalsInLastHour,DeparturesInLastHour,InspectedRooms,CleanedRooms;ReservationActivity:
StayoverRooms,StayoverPersons,StayoverVIP,DeparturesExpectedRooms,DeparturesExpectedPersons,DeparturesExpectedVIP,DeparturesActualRooms,DeparturesActualPersons,DeparturesActualVIP,ArrivalsExpectedRooms,ArrivalsExpectedPersons,ArrivalsExpectedVIP,ArrivalsActualRooms,ArrivalsActualPersons,ArrivalsActualVIP,ArrivalsExpectedRoomsMadeToday,ArrivalsExpectedPersonsMadeToday,ArrivalsExpectedVIPMadeToday,ExtendedStaysRooms,ExtendedStaysPersons,ExtendedStaysVIP,EarlyDeparturesRooms,EarlyDeparturesPersons,EarlyDeparturesVIP,DayUseRooms,DayUsePersons,DayUseVIP,WalkInRooms,WalkInPersons,WalkInVIP,CanceledOnArrivalRooms,CanceledOnArrivalPersons,CanceledOnArrivalVIP,AverageCheckInTime;ReservationActivityDaily:
AdultsInHouse,ChildrenInHouse,ArrivalsTotal,TurndownRequired,DeparturesTotal,MaxOccupancyPercentage,Stayover,TotalRoomsReserved;ReservationActivityMonthToDate:
ArrivalsActualRooms,ArrivalsActualPersons,DeparturesActualRooms,DeparturesActualPersons,ExtendedStaysRooms,ExtendedStaysPersons,EarlyDeparturesRooms,EarlyDeparturesPersons,DayUseRooms,DayUsePersons;ReservationActivityYearToDate:
ArrivalsActualRooms,ArrivalsActualPersons,DeparturesActualRooms,DeparturesActualPersons,ExtendedStaysRooms,ExtendedStaysPersons,EarlyDeparturesRooms,EarlyDeparturesPersons,DayUseRooms,DayUsePersons;ReservationsCancellationsToday:
CancellationsTotal,NewReservationsTotal;ReservationStatistics:
PreRegisteredTotal,VIPPreRegisteredTotal,TurndownTotal,VIPTurndownTotal,OpenFolioTotal,ExpectedCheckOutsTotal;RoomMaintenance:
RoomMaintenanceResolvedTotal,RoomMaintenanceUnResolvedTotal;RoomStatus:
InspectedVacant,InspectedAssigned,InspectedOccupied,CleanVacant,CleanAssigned,CleanOccupied,DirtyVacant,DirtyAssigned,DirtyOccupied,PickupVacant,PickupAssigned,PickupOccupied,OutOfOrderVacant,OutOfOrderAssigned,OutOfOrderOccupied,OutOfServiceVacant,OutOfServiceAssigned,OutOfServiceOccupied,TotalOutOfOrder,TotalOutOfService,QueueRooms,CurrentAveWaitTime,SkipRooms,SleepRooms;Turndown:
TurndownRequired,TurndownNotRequired,TurndownCompletedRequired;VIPGuests:
VIPGuestsArriving,VIPGuestsDeparting;" }, { "name": "hotelId", "value": "", "type": "path" }, { "name": "date", "value": "", "type": "query", "description": "Start date of the report." }, { "name": "metric", "value": "", "type": "query", "description": "Supported housekeeping statistical codes." }, { "name": "parameterNames", "value": "", "type": "query", "description": "Required when statisticsCode is ReservationsCancellationsToday" }, { "name": "parameterValues", "value": "", "type": "query", "description": "Required when statisticsCode is ReservationsCancellationsToday" }, { "name": "roomClasses", "value": "", "type": "query", "description": "Room Class of the Room." } ] }, "docs": "Use this API to return front office statistics for a specific hotel based on search criteria such as statisticsCode, hotelId, date, parameterNames, parameterValues, room Classes.OperationId:getFrontOfficeStatistics
" }, { "info": { "name": "Get front office Statistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/frontOfficeStatisticsRange/:statisticsCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "statisticsCode", "value": "", "type": "path", "description": "Below are the Statistics Code mapping for valid metric code.ReservationActivityDaily:
AdultsInHouse,ChildrenInHouse,ArrivalsTotal,TurndownRequired,DeparturesTotal,MaxOccupancyPercentage,Stayover,TotalRoomsReserved,PendingRoomMoves;" }, { "name": "hotelId", "value": "", "type": "path" }, { "name": "endDate", "value": "", "type": "query", "description": "End date of the report." }, { "name": "date", "value": "", "type": "query", "description": "Start date of the report." }, { "name": "metric", "value": "", "type": "query", "description": "Supported housekeeping statistical codes." }, { "name": "parameterNames", "value": "", "type": "query", "description": "Required when statisticsCode is ReservationsCancellationsToday" }, { "name": "parameterValues", "value": "", "type": "query", "description": "Required when statisticsCode is ReservationsCancellationsToday" }, { "name": "roomClasses", "value": "", "type": "query", "description": "Room Class of the Room." } ] }, "docs": "This API is useful to retrieve statistics regarding front office operationsOperationId:getFrontOfficeStatisticsWithDateRange
This API allows a time span of 7 days.
" }, { "info": { "name": "Get housekeeping statistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/houseKeepingStatistics", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" }, { "name": "includeAllAssignedTasks", "value": "", "type": "query", "description": "This flag, if true, enables fetching statistics for all the housekeeping tasks assigned." }, { "name": "includeTaskSheetsDetails", "value": "", "type": "query" }, { "name": "taskCode", "value": "", "type": "query", "description": "Task code of the task sheet." } ] }, "docs": "This Api will get the housekeeping statistics for your property.OperationId:getTaskSheetStatistics
" }, { "info": { "name": "Get reservation queue statistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/queueReservationsStatistics", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path" } ] }, "docs": "Use this API to return reservation queue statistics for a specific hotel.OperationId:getReservationQueueStatistics
" }, { "info": { "name": "Get Reservation Status Statistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservationStatusStatistics", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Hotel Code" }, { "name": "reservationStatus", "value": "", "type": "query", "description": "Reservation statuses to fetch statistics for" } ] }, "docs": "This API will fetch reservation statistics for the given status per room type.OperationId:getReservationStatusStatistics
" }, { "info": { "name": "Get counts of rooms by housekeeping status and front office status.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/roomStatusStatistics", "params": [ { "name": "hotelId", "value": "", "type": "path" }, { "name": "frontOfficeStatus", "value": "", "type": "query", "description": "Filter by frontOfficeStatus. If nothing is passed, we fetch all." } ] }, "docs": "For current business date, rooms are grouped by the roomClass and roomType to display their housekeeping roomStatus." }, { "info": { "name": "Ping FOF", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/services/fofStats/status", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Ping FOF stats serviceOperationId:pingFOFStatsService
" } ] } ], "bundled": true }