OperationId:getBlockReservationStatisticsByDateAndRoomPool
This API allows a time span of 90 days.
" }, { "info": { "name": "Get Reservation pace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reservations/pace", "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": "query", "description": "Hotel code from which the reservations will be fetched." }, { "name": "stayDate", "value": "", "type": "query", "description": "Target stay date for report" }, { "name": "leadDays", "value": "", "type": "query", "description": "Number of lead days from stay date" }, { "name": "channels", "value": "", "type": "query", "description": "List of Channels for which pace to be computed" } ] }, "docs": "Use this API to get Reservation pace.OperationId:getReservationPace
" }, { "info": { "name": "Get Reservation Statistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reservations/statistics", "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": "chainName", "value": "", "type": "query", "description": "The name of the hotel chain (e.g., Hilton, Marriott, Hyatt)." }, { "name": "hotelCityCode", "value": "", "type": "query", "description": "The IATA city code; for example DCA, ORD." }, { "name": "hotelId", "value": "", "type": "query", "description": "The code that uniquely identifies a single hotel property. The hotel code is decided between vendors." }, { "name": "hotelCodeContext", "value": "", "type": "query", "description": "A text field used to communicate the context (or source of - ex Sabre, Galileo, Worldspan, Amadeus) the HotelReferenceGroup codes." }, { "name": "hotelName", "value": "", "type": "query", "description": "A text field used to communicate the proper name of the hotel." }, { "name": "requestedReportsTypeEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "fiscalDate", "value": "", "type": "query", "description": "Hotel fiscal date for statistics." }, { "name": "reportCode", "value": "", "type": "query", "description": "Identifies the type of statistics collected. Each ReportCode corresponds to a set of category summaries based upon a predetermined agreement." }, { "name": "requestedReportsTypeStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "requestedReportsTypeParameterName", "value": "", "type": "query", "description": "Name of the parameter." }, { "name": "requestedReportsTypeParameterValue", "value": "", "type": "query", "description": "Value of the parameter." } ] }, "docs": "Use this API to get Reservation Statistics.OperationId:getReservationStatistics
This API allows a time span of 90 days.
" }, { "info": { "name": "Ping", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/services/rsvStats/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 version for RSV Stats serviceOperationId:pingRSVStatsService
" } ] }, { "info": { "name": "Reservation", "type": "folder" }, "items": [ { "info": { "name": "Register Call", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/calls", "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": "Register call on a reservation.OperationId:postCall
" }, { "info": { "name": "Get call statistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/calls/statistics", "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": "end", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "start", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "domain", "value": "", "type": "query" }, { "name": "appUserName", "value": "", "type": "query" } ] }, "docs": "Use this API to get call statistics.OperationId:getCallStatistics
This API allows a time span of 30 days.
" }, { "info": { "name": "Get Reservations for a hotel", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/externalSystems/:extSystemCode/reservations", "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": "extSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "externalReferenceList", "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": "recentlyAccessed", "value": "", "type": "query", "description": "Mark this reservation as recently accessed." }, { "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": "resvExternalReferencesToFetch", "value": "", "type": "query", "description": "Define the external system(s) to return external reference ids for reservations. A maximum of 10 different external systems can be be provided for this parameter." }, { "name": "searchType", "value": "", "type": "query", "description": "Represents Reservation search type Player Snapshot." }, { "name": "hotelIds", "value": "", "type": "query", "description": "List of Hotels to support searches with multiple resorts for which traces are to be fetched." }, { "name": "text", "value": "", "type": "query", "description": "Free form text field for searching all reservation fields" }, { "name": "arrivalEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "arrivalStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "departureEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "departureStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "expectedArrivalStartTime", "value": "", "type": "query", "description": "The ending value of the time span. Uses the hotel's time zone." }, { "name": "expectedArrivalEndTime", "value": "", "type": "query", "description": "The starting value of the time span. Uses the hotel's time zone." }, { "name": "expectedReturnEndTime", "value": "", "type": "query", "description": "The ending value of the time span. Uses the hotel's time zone." }, { "name": "expectedReturnStartTime", "value": "", "type": "query", "description": "The starting value of the time span. Uses the hotel's time zone." }, { "name": "companyNames", "value": "", "type": "query", "description": "Attached profile name" }, { "name": "travelAgentIds", "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": "companyIds", "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": "sourceIds", "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": "contactIds", "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": "groupIds", "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": "billingContactIds", "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": "profileIds", "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": "membershipCardNumber", "value": "", "type": "query", "description": "Membership ID criteria." }, { "name": "membershipLevels", "value": "", "type": "query" }, { "name": "membershipTypes", "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": "anyVIPStatus", "value": "", "type": "query", "description": "VIP status of the customer." }, { "name": "vipCodes", "value": "", "type": "query", "description": "VIP status of the customer." }, { "name": "guaranteeCode", "value": "", "type": "query", "description": "Fetches the reservation having Guarantee Code(Reservation Type) supplied here." }, { "name": "paymentMethod", "value": "", "type": "query", "description": "Fetches the reservation having method of payment supplied here." }, { "name": "discountApplied", "value": "", "type": "query", "description": "Fetches the reservation for which discount is applied" }, { "name": "user", "value": "", "type": "query" }, { "name": "createdBy", "value": "", "type": "query", "description": "Fetches reservation created by specified user. If both CreatedByUsers and CreatedBy is specified, CreatedByUsers will take precedence." }, { "name": "cancelledByList", "value": "", "type": "query", "description": "Fetches reservations cancelled by list of users." }, { "name": "cancelledOn", "value": "", "type": "query", "description": "Fetches the reservations which are cancelled on a specific date." }, { "name": "ratePlanCodes", "value": "", "type": "query" }, { "name": "sourceCodes", "value": "", "type": "query" }, { "name": "marketCodes", "value": "", "type": "query" }, { "name": "excludeBlockReservations", "value": "", "type": "query", "description": "If true the search result will exclude the blocks reservations." }, { "name": "blockName", "value": "", "type": "query", "description": "The Name of the block that is attached to the reservation." }, { "name": "blockIds", "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": "blockCodes", "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": "customReference", "value": "", "type": "query", "description": "Custom reference" }, { "name": "recordLocator", "value": "", "type": "query", "description": "GDS Record Locator for reservation." }, { "name": "orderBy", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" }, { "name": "roomAssignedOnly", "value": "", "type": "query", "description": "Indicator to query reservations which have a room number assigned." }, { "name": "roomUnassignedOnly", "value": "", "type": "query", "description": "Indicator to query reservations which does not have a room number assigned." }, { "name": "roomId", "value": "", "type": "query", "description": "Room number of the reservation to search by." }, { "name": "roomType", "value": "", "type": "query", "description": "Room Type." }, { "name": "roomFeatures", "value": "", "type": "query", "description": "A code representing a room feature." }, { "name": "roomSpecials", "value": "", "type": "query", "description": "Preference value for display purposes." }, { "name": "roomSmokingPreference", "value": "", "type": "query", "description": "Preference value for display purposes." }, { "name": "roomFloorPreferences", "value": "", "type": "query", "description": "Preference value for display purposes." }, { "name": "housekeepingRoomStatuses", "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": "roomClasses", "value": "", "type": "query" }, { "name": "roomRangeFrom", "value": "", "type": "query" }, { "name": "roomRangeTo", "value": "", "type": "query" }, { "name": "communication", "value": "", "type": "query", "description": "Any communication attached to the reservation from the primary guest's profile such as phone, fax or email address." }, { "name": "phone", "value": "", "type": "query", "description": "The phone number attached to the reservation from the primary guest's profile." }, { "name": "email", "value": "", "type": "query", "description": "The email address attached to the reservation from the primary guest's profile." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Instruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction." }, { "name": "allowPreRegistration", "value": "", "type": "query", "description": "Flag containing true or false value for reservation to be eligible for prior check in by guest using mobile device. Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile check in yes / no. Upon fetch, the current state of the flag will show true or false." }, { "name": "hasDepositBalance", "value": "", "type": "query", "description": "Indicates that only reservations with deposit balance should be expected from the result." }, { "name": "hasOpenBalance", "value": "", "type": "query", "description": "Indicates that only reservations with open balance should 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": "includeScheduledCheckOut", "value": "", "type": "query", "description": "Criteria that indicates whether to scheduled checkouts or not." }, { "name": "linkedOnly", "value": "", "type": "query", "description": "Indicates that only linked reservations should be expected from the result." }, { "name": "unlinkedOnly", "value": "", "type": "query", "description": "Indicates that only unlinked reservations should be expected from the result." }, { "name": "actualArrivals", "value": "", "type": "query", "description": "Indicates if reservations which have already arrived on the Search Date is required." }, { "name": "actualDepartures", "value": "", "type": "query", "description": "Indicates if reservations which were expected to depart on the Search Date and have already checked, is required." }, { "name": "complimentaryReservations", "value": "", "type": "query", "description": "Indicates if reservations where rate codes are marked as Complimentary Rates , is required. This flag should be used in conjunction with the Arrivals, Departures or StayOvers criteria." }, { "name": "dayOfArrivalCancels", "value": "", "type": "query", "description": "Indicates if reservations which have cancelled on the Search Date which is also the day of arrival is required." }, { "name": "dayUse", "value": "", "type": "query", "description": "Indicates if reservations which are day use reservation on the Search Date, is required." }, { "name": "earlyDepartures", "value": "", "type": "query", "description": "Indicates if reservations which checked out early on the Search Date, is required." }, { "name": "expectedArrivals", "value": "", "type": "query", "description": "Indicates if reservations which are expected arrivals for the Search Date and who have not yet arrived, is required." }, { "name": "expectedDepartures", "value": "", "type": "query", "description": "Indicates if reservations which are expected departures for the Search Date and who have not yet departed, is required." }, { "name": "extendedStays", "value": "", "type": "query", "description": "Indicates if reservations which have extended their stays on the Search Date, is required." }, { "name": "houseUseReservations", "value": "", "type": "query", "description": "Indicates if reservations where rate codes are marked as House Use Rates , is required. This flag should be used in conjunction with the Arrivals, Departures or StayOvers criteria." }, { "name": "stayovers", "value": "", "type": "query", "description": "Indicates if reservations which are StayOvers on the Search Date, is required." }, { "name": "stayDate", "value": "", "type": "query", "description": "Date for searching the reservations. This is the date for which the search types are applicable. If date is not available, the business date will be used by default." }, { "name": "roomRoutingId", "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": "excludePseudoRoomReservations", "value": "", "type": "query", "description": "Indicates to exclude Pseudo room reservations." }, { "name": "excludeReservationIds", "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": "excludeVIPStatusCodes", "value": "", "type": "query", "description": "VIP status of the customer." }, { "name": "excludeSpecials", "value": "", "type": "query", "description": "Preference value for display purposes." }, { "name": "excludeFloorPreferences", "value": "", "type": "query", "description": "Preference value for display purposes." }, { "name": "excludeAdvanceCheckedIn", "value": "", "type": "query", "description": "Indicates to exclude Advance Checked In Reservations from search result." }, { "name": "excludeRoomFeatures", "value": "", "type": "query", "description": "Exclude the reservation(s) with provided room features from the search result." }, { "name": "playerId", "value": "", "type": "query", "description": "Player ID associated to the reservation." }, { "name": "gamingBalanceFrom", "value": "", "type": "query", "description": "Balance from." }, { "name": "gamingBalanceTo", "value": "", "type": "query", "description": "Balance to." }, { "name": "compAccountingBalanceFrom", "value": "", "type": "query", "description": "Comp Balance From" }, { "name": "compAccountingBalanceTo", "value": "", "type": "query", "description": "Comp Balance To" }, { "name": "searchTypes", "value": "", "type": "query", "description": "Represents Reservation search type Player Snapshot." }, { "name": "reservationStatuses", "value": "", "type": "query", "description": "Reservation status type for reservations search." }, { "name": "transportationCodes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "roomReadyStatuses", "value": "", "type": "query", "description": "Enum to denote the Status of Readiness messages sent to Guest Devices." }, { "name": "checkoutMessageReceived", "value": "", "type": "query", "description": "Fetches the reservations for which Checkout Message is received." }, { "name": "optedForCommunication", "value": "", "type": "query", "description": "Fetches the reservations for which reservation communication has been opted." } ] }, "docs": "This API will allow a user to retrieve a list of reservations based on the search criteria specified in the request body. For example you can search for reservations using query parameters like first name, last name, arrival/departure date, external confirmation number.OperationId:getExternalSystemReservations
" }, { "info": { "name": "Get Reservations for a hotel from an external system", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/externalSystems/:extSystemCode/reservations/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": "extSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." } ] }, "docs": "This API allows a user to retrieve a list of reservations based on search criteria in the request body. For example you can search for reservations using criteria like first name, last name, arrival/departure date, external confirmation number.OperationId:searchExternalSystemReservations
" }, { "info": { "name": "Get Award Upgrades", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/awardUpgrades", "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 where reservation is searched based on reservation ID." }, { "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": "idContext", "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": "membershipType", "value": "", "type": "query", "description": "The type of the membership." }, { "name": "membershipCardNo", "value": "", "type": "query", "description": "The card number associated with this membership." }, { "name": "membershipPoints", "value": "", "type": "query", "description": "Current membership points available for this guest." }, { "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": "reservationTimeSpanStartDate", "value": "", "type": "query" }, { "name": "reservationTimeSpanEndDate", "value": "", "type": "query" }, { "name": "reservationTimeSpanDuration", "value": "", "type": "query" }, { "name": "numberOfRooms", "value": "", "type": "query", "description": "The number of rooms." }, { "name": "roomType", "value": "", "type": "query", "description": "Room type associated with the reservation." } ] }, "docs": "Get award upgrades for a specific property.OperationId:getAwardUpgrades
" }, { "info": { "name": "Fetch Awards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/awards", "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 where reservation is searched based on reservation ID." }, { "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." } ] }, "docs": "Get certificates and awards associated with the Reservation.OperationId:getAwards
" }, { "info": { "name": "Create Reservation for a Block", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/blocks/:blockId/reservations", "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": "blockId", "value": "", "type": "path", "description": "Unique OPERA internal ID for the block." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is created." } ] }, "docs": "Use this to create a new reservation for a block, you must know the block Code to create this reservation. In order to post a successful block reservation, please ensure you use the ListOfValues API's to know the hotel's codes; such as Address Type, Country Code, Titles, preferenceCodes etc.OperationId:postReservationByBlock
" }, { "info": { "name": "Change a Cancellation policy", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/cancellationPolicies", "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 where reservation is searched based on reservation ID." } ] }, "docs": "Change cancellation policy that is configured for a property.OperationId:putCancellationPolicy
" }, { "info": { "name": "Fetch Confirmation Letters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/confirmationLetters", "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 where reservation is searched based on reservation ID." }, { "name": "notAttached", "value": "", "type": "query", "description": "If true then the fetch result will include the reservations that do not have a letter attached to them." }, { "name": "pending", "value": "", "type": "query", "description": "If true then the result will include only the pending confirmation letters." }, { "name": "sent", "value": "", "type": "query", "description": "If true then the result will include only the confirmation letters that have been sent to the guest." }, { "name": "createdOnEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "createdOnStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "arrivalEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "arrivalStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "letterStyleId", "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": "letterStyle", "value": "", "type": "query", "description": "Name of the confirmation letter style." }, { "name": "letterStyleIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "reservationGuestId", "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": "reservationGuestIdType", "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": "membershipLevelCode", "value": "", "type": "query" }, { "name": "membershipTypeCode", "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": "blockHotelId", "value": "", "type": "query", "description": "This is the HotelCode 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": "blockIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "blockName", "value": "", "type": "query", "description": "The Name of the block that is attached to the reservation." } ] }, "docs": "Get a list of Reservations for which confirmation letters need to be sent.OperationId:getConfirmationLetters
This API allows a time span of 90 days.
" }, { "info": { "name": "Create the confirmation letters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/confirmationLetters", "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 where reservation is searched based on reservation ID." } ] }, "docs": "Create a confirmation letter for a property.OperationId:postConfirmationLetters
" }, { "info": { "name": "Change deposit policy", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/depositPolicies", "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 where reservation is searched based on reservation ID." } ] }, "docs": "Change deposit policy which already exists for a property.OperationId:putDepositPolicy
" }, { "info": { "name": "Link Reservations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/reservations/linkedReservations/:reservationExternalId", "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": "reservationExternalId", "value": "", "type": "path", "description": "External reservation ID." }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is searched based on reservation ID." } ] }, "docs": "This will allow you to link 1 or more reservations to an existing reservation.OperationId:postReservationLinksByExtId
" }, { "info": { "name": "Remove Reservation Links", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/reservations/linkedReservations/:reservationExternalId", "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": "reservationExternalId", "value": "", "type": "path", "description": "External reservation ID." }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is searched based on reservation ID." } ] }, "docs": "Use this API to unlink a reservation from its currently associated reservation.OperationId:deleteReservationLinksByExtId
" }, { "info": { "name": "Get Reservation by external ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/reservations/:reservationExternalId", "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": "reservationExternalId", "value": "", "type": "path", "description": "External reservation Id." }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is searched based on external reservation Id." }, { "name": "profileExternalReferencesToFetch", "value": "", "type": "query", "description": "Define the external system(s) to return external reference ids for associated profiles for the reservation. A maximum of 10 different external systems can be be provided for this parameter." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Instruction on which of the reservation's elements are to be returned e.g. DailySummary will return summarized information for each day of the reservation. Instructions are cumulative i.e. if multiple instructions are sent in a request, then the combined reservation elements would be returned, elements will not be duplicated in the response." }, { "name": "allowedActions", "value": "", "type": "query", "description": "Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation." } ] }, "docs": "Retrieve a reservation using the external ID.OperationId:getReservationByExtId
" }, { "info": { "name": "Update Reservation by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/reservations/:reservationExternalId", "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": "reservationExternalId", "value": "", "type": "path", "description": "External reservation ID." }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is searched based on reservation ID." } ] }, "docs": "Use this to update an existing reservation for a hotel, such as adding comments, changing the number of guests. There are many fields in putReservation defined by ListOfValues; ensure you have reviewed ListOfValues APIs in order successfully to use putReservation.OperationId:putReservationByExtId
" }, { "info": { "name": "Update Add On (Sell Separate) packages on a reservation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/reservations/:reservationExternalId/addOnReservationPackagesByExtId", "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": "reservationExternalId", "value": "", "type": "path", "description": "External reservation ID." }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is searched based on External reservation ID." }, { "name": "legNumber", "value": "", "type": "query", "description": "External system Leg Number for the reservation." } ] }, "docs": "This API will allow you to update Add On (Sell Separate) packages on a reservation's. Note: this API works as a full overlay for Reservation Add On Packages./OperationId:putAddOnReservationPackagesByExtId
" }, { "info": { "name": "Cancel Reservation by ID", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/reservations/:reservationExternalId/cancellations", "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": "reservationExternalId", "value": "", "type": "path", "description": "External reservation ID." }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is searched based on reservation ID." } ] }, "docs": "Use this if a guest would like to cancel their reservation. You will receive a cancellation number in the response.OperationId:postCancelReservationByExtId
" }, { "info": { "name": "Reinstate a Reservation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/reservations/:reservationExternalId/cancellations", "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": "reservationExternalId", "value": "", "type": "path", "description": "External reservation ID." }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is searched based on reservation ID." } ] }, "docs": "Use this API to reinstate a cancelled reservation.OperationId:putReinstateReservationByExtId
" }, { "info": { "name": "Create routing instructions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/reservations/:reservationExternalId/routingInstructions", "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": "reservationExternalId", "value": "", "type": "path", "description": "External reservation ID." }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is searched based on reservation ID." } ] }, "docs": "You can use this API to create routing instructions on a reservation.OperationId:postRoutingInstructionsByExtId
" }, { "info": { "name": "Change routing instructions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/reservations/:reservationExternalId/routingInstructions", "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": "reservationExternalId", "value": "", "type": "path", "description": "External reservation ID." }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is searched based on reservation ID." } ] }, "docs": "Change routing instructions on an existing reservation.OperationId:putRoutingInstructionsByExtId
" }, { "info": { "name": "Separate Share Reservation with the given external reservation id and apply rate amounts to separated and remaining share reservations from room rates provided by an external application on a daily basis.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/reservations/:reservationExternalId/separatedShare", "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": "reservationExternalId", "value": "", "type": "path", "description": "External reservation ID." }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is searched based on reservation ID." }, { "name": "overrideInventoryCheck", "value": "", "type": "query", "description": "Indicate to Override the Room Inventory Check if applicable." }, { "name": "overrideMaxOccupancyCheck", "value": "", "type": "query", "description": "Indicate to Override the check on Maximum Room Occupancy if applicable." }, { "name": "overrideRateAvailabilityCheck", "value": "", "type": "query", "description": "Indicate to Override the check on Maximum Room Occupancy if applicable." } ] }, "docs": "This API can be used to separate the share reservation with the given external reservation id and apply rate amounts to separated and remaining share reservations from room rates provided by an external application on a daily basis.OperationId:putSeparateShareReservationByExtId
" }, { "info": { "name": "Get share Reservations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/reservations/:reservationExternalId/shares", "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": "reservationExternalId", "value": "", "type": "path", "description": "External reservation ID." }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is searched based on external reservation ID." } ] }, "docs": "This API can be used to retrieve the share reservations that exist on a reservation.OperationId:getShareReservationsByExtId
" }, { "info": { "name": "Combine Share Reservations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/reservations/:reservationExternalId/shares", "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": "reservationExternalId", "value": "", "type": "path", "description": "External reservation ID." }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is searched based on reservation ID." } ] }, "docs": "Combine share reservation for a given reservation idOperationId:postCombineShareReservationsByExtId
" }, { "info": { "name": "Separate share Reservations", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/externalSystems/:externalSystemCode/reservations/:reservationExternalId/shares", "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": "reservationExternalId", "value": "", "type": "path", "description": "External reservation ID." }, { "name": "externalSystemCode", "value": "", "type": "path", "description": "Code to identify the external system from which the request is coming. This is the ExternalSystem ID used to exchange information between OPERA and the external system." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is searched based on reservation ID." }, { "name": "overrideInventoryCheck", "value": "", "type": "query", "description": "Indicate to Override the Room Inventory Check if applicable." }, { "name": "overrideMaxOccupancyCheck", "value": "", "type": "query", "description": "Indicate to Override the check on Maximum Room Occupancy if applicable." }, { "name": "overrideRateAvailabilityCheck", "value": "", "type": "query", "description": "Indicate to Override the check on Maximum Room Occupancy if applicable." }, { "name": "returnShareReservations", "value": "", "type": "query", "description": "After the break share operation, return the new list of Sharer Reservations." } ] }, "docs": "This API can be used to separate the share reservations.OperationId:deleteShareReservationByExtId
" }, { "info": { "name": "Get External system delivery history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/fetchExternalSystemDeliveryHistory", "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 where reservation is searched based on reservation ID." }, { "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": "reservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "Get external system delivery history.OperationId:getExternalSystemDeliveryHistory
" }, { "info": { "name": "Get guest messages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/guestMessages", "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 where reservation is searched based on reservation ID." }, { "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": "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": "retrieveDeliveredMessages", "value": "", "type": "query", "description": "Flag that specified if Delivered Guest Messages will also be retrieved." }, { "name": "room", "value": "", "type": "query", "description": "Room number attached to the reservation." }, { "name": "travelAgent", "value": "", "type": "query", "description": "Lookup guest messages with this Travel agent name." }, { "name": "company", "value": "", "type": "query", "description": "Lookup guest messages with the Company name." }, { "name": "group", "value": "", "type": "query", "description": "Lookup guest messages with the Travel agent name." }, { "name": "source", "value": "", "type": "query", "description": "Lookup guest messages with the Source name." }, { "name": "reservationStatus", "value": "", "type": "query", "description": "Represents Reservation search type Player Snapshot." }, { "name": "retrieveUndeliveredMessages", "value": "", "type": "query", "description": "Flag that specified if Undelivered Guest Messages will also be retrieved." }, { "name": "retrievePrintedMessages", "value": "", "type": "query", "description": "Flag that specified if Printed Guest Messages will also be retrieved." }, { "name": "retrieveTextedMessages", "value": "", "type": "query", "description": "Flag that specified if Texted Guest Messages will also be retrieved." }, { "name": "blockName", "value": "", "type": "query", "description": "Lookup messages using Block name." }, { "name": "recipientName", "value": "", "type": "query", "description": "Lookup guest messages with the recipient name." }, { "name": "confirmationNo", "value": "", "type": "query", "description": "Lookup guest messages using reservation confirmation no." } ] }, "docs": "Get guest messages which exist on a reservation.OperationId:getGuestMessages
The maximum allowable limit for this API is 100.
" }, { "info": { "name": "Extend Reservation Lock", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/locks/:lockHandle", "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": "lockHandle", "value": "", "type": "path", "description": "Lock handle of the lock to be extended." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is searched based on reservation ID." } ] }, "docs": "Extend Reservation Lock.OperationId:putReservationLock
" }, { "info": { "name": "Release Reservation Lock", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/locks/:lockHandle", "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": "lockHandle", "value": "", "type": "path", "description": "Lock handle of the lock to be released." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is searched based on reservation ID." } ] }, "docs": "Release Reservation Lock.OperationId:deleteReservationLock
" }, { "info": { "name": "Get preArrival Member Reservations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/preArrivalMembersReservations", "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 where reservation is searched based on reservation ID." }, { "name": "end", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "start", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "membershipType", "value": "", "type": "query", "description": "Membership Type." }, { "name": "externalReferenceType", "value": "", "type": "query", "description": "Type of the desired reservation external confirmation number." } ] }, "docs": "Get preArrival Member Reservations.OperationId:getPreArrivalMemberReservations
" }, { "info": { "name": "Get pre-Configured Routing Instructions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/preConfiguredRoutingInstructions", "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 where reservation is searched based on reservation ID." }, { "name": "rateCode", "value": "", "type": "query" }, { "name": "promotionCodes", "value": "", "type": "query", "description": "Promotion Code for ComplimentaryRouting" }, { "name": "guestName", "value": "", "type": "query", "description": "Attached profile name" }, { "name": "guestIds", "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": "companyName", "value": "", "type": "query", "description": "Attached profile name" }, { "name": "companyIds", "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": "groupName", "value": "", "type": "query", "description": "Attached profile name" }, { "name": "groupIds", "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": "travelAgentName", "value": "", "type": "query", "description": "Attached profile name" }, { "name": "travelAgentIds", "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": "sourceName", "value": "", "type": "query", "description": "Attached profile name" }, { "name": "sourceIds", "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": "contactName", "value": "", "type": "query", "description": "Attached profile name" }, { "name": "contactIds", "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": "billingContactName", "value": "", "type": "query", "description": "Attached profile name" }, { "name": "billingContactIds", "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": "addresseeName", "value": "", "type": "query", "description": "Attached profile name" }, { "name": "addresseeIds", "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": "reservationId", "value": "", "type": "query", "description": "Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA." } ] }, "docs": "Get preConfigured Routing Instructions.OperationId:getPreConfiguredRoutingInstructions
" }, { "info": { "name": "Get pre-Configured Routing Instructions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/preConfiguredRoutingInstructions/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": "Unique ID of the hotel where reservation is searched based on reservation ID." } ] }, "docs": "Get preConfigured Routing Instructions.OperationId:searchPreConfiguredRoutingInstructions
" }, { "info": { "name": "Get Reservations to share ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/profiles/:profileIdtoShare/share", "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": "profileIdtoShare", "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 searched based on reservation ID." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "superSearch", "value": "", "type": "query", "description": "Free form text field for searching all reservation fields" }, { "name": "reservationGuestId", "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": "reservationGuestIdType", "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": "membershipLevel", "value": "", "type": "query" }, { "name": "membershipType", "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": "roomId", "value": "", "type": "query", "description": "Room number" }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Instruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction." } ] }, "docs": "Get Reservations to share by profile id.OperationId:getReservationsToShareByProfileId
The maximum allowable limit for this API is 100.
" }, { "info": { "name": "Validate rate information", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/rateInfoValidation", "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 where reservation is searched based on reservation ID." } ] }, "docs": "Validate the rate plan information for a reservation.OperationId:validateRateInfo
" }, { "info": { "name": "Get Reservations for a hotel", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations", "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 where reservation is searched based on reservation ID." }, { "name": "keyTrack2", "value": "", "type": "query", "description": "keyTrack2 is an id which is either generated by the PMS or provided by the door lock system and which is associated to the reservation. With the keyTrack2 value a reservation can be identified." }, { "name": "discrepancy", "value": "", "type": "query" }, { "name": "recentlyAccessed", "value": "", "type": "query", "description": "Mark this reservation as recently accessed." }, { "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": "text", "value": "", "type": "query", "description": "Free form text field for searching all reservation fields" }, { "name": "reservationIdList", "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": "confirmationNumberList", "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": "cancellationNumberList", "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": "externalReferenceIds", "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": "externalSystemCodes", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "externalReferenceLegId", "value": "", "type": "query", "description": "External reference leg number" }, { "name": "arrivalEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "arrivalStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "departureEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "departureStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "stayOnStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "createdOnStartDate", "value": "", "type": "query", "description": "Fetches reservations which are created on the given property business date." }, { "name": "expectedArrivalEndTime", "value": "", "type": "query", "description": "The ending value of the time span. Uses the hotel's time zone." }, { "name": "expectedArrivalStartTime", "value": "", "type": "query", "description": "The starting value of the time span. Uses the hotel's time zone." }, { "name": "depositDueEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "depositDueStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "expectedReturnEndTime", "value": "", "type": "query", "description": "The ending value of the time span. Uses the hotel's time zone." }, { "name": "expectedReturnStartTime", "value": "", "type": "query", "description": "The starting value of the time span. Uses the hotel's time zone." }, { "name": "companyNames", "value": "", "type": "query", "description": "Attached profile name" }, { "name": "sourceNames", "value": "", "type": "query", "description": "Attached profile name" }, { "name": "travelAgentNames", "value": "", "type": "query", "description": "Attached profile name" }, { "name": "groupNames", "value": "", "type": "query", "description": "Attached profile name" }, { "name": "travelAgentIds", "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. API expects CompanyName Query parameter along with the ID to obtain correct results." }, { "name": "companyIds", "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. API expects CompanyName Query parameter along with the ID to obtain correct results." }, { "name": "sourceIds", "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. API expects CompanyName Query parameter along with the ID to obtain correct results." }, { "name": "contactIds", "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. API expects CompanyName Query parameter along with the ID to obtain correct results." }, { "name": "groupIds", "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. API expects CompanyName Query parameter along with the ID to obtain correct results." }, { "name": "billingContactIds", "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. API expects CompanyName Query parameter along with the ID to obtain correct results." }, { "name": "profileId", "value": "", "type": "query", "description": "Unique Identifier for a guest profile associated with the reservation(s)" }, { "name": "commissionPaid", "value": "", "type": "query", "description": "Commission Paid criteria" }, { "name": "vouchersGenerated", "value": "", "type": "query", "description": "All reservations with generated vouchers to be returned if vouchersGenerated is set to true. All reservations without the generated vouchers to be returned if it is set to false." }, { "name": "membershipCardNumber", "value": "", "type": "query", "description": "Membership ID criteria." }, { "name": "membershipLevels", "value": "", "type": "query" }, { "name": "membershipTypes", "value": "", "type": "query" }, { "name": "reservationsWithMembershipType", "value": "", "type": "query", "description": "When set to true, only reservations with a membership belonging to the specified membership type will be returned" }, { "name": "surname", "value": "", "type": "query", "description": "Family name, last name." }, { "name": "givenName", "value": "", "type": "query", "description": "Given name, first name or names" }, { "name": "fromName", "value": "", "type": "query", "description": "Given name, first name or names" }, { "name": "toName", "value": "", "type": "query", "description": "Given name, first name or names" }, { "name": "anyVIPStatus", "value": "", "type": "query", "description": "VIP status of the customer." }, { "name": "vipCodes", "value": "", "type": "query", "description": "VIP status of the customer." }, { "name": "guaranteeCode", "value": "", "type": "query", "description": "Fetches the reservation having Guarantee Code(Reservation Type) supplied here." }, { "name": "paymentMethod", "value": "", "type": "query", "description": "Fetches the reservation having method of payment supplied here." }, { "name": "discountApplied", "value": "", "type": "query", "description": "Fetches the reservation for which discount is applied" }, { "name": "user", "value": "", "type": "query" }, { "name": "createdBy", "value": "", "type": "query", "description": "Fetches reservation created by specified user. If both CreatedByUsers and CreatedBy is specified, CreatedByUsers will take precedence." }, { "name": "cancelledByList", "value": "", "type": "query", "description": "Fetches reservations cancelled by list of users." }, { "name": "cancelledOn", "value": "", "type": "query", "description": "Fetches reservations which are cancelled on the given property business date." }, { "name": "ratePlanCodes", "value": "", "type": "query" }, { "name": "sourceCodes", "value": "", "type": "query" }, { "name": "marketCodes", "value": "", "type": "query" }, { "name": "excludeBlockReservations", "value": "", "type": "query", "description": "If true the search result will exclude the blocks reservations." }, { "name": "blockCriteriaHotelCode", "value": "", "type": "query", "description": "The Hotel Code of the Block." }, { "name": "blockName", "value": "", "type": "query", "description": "The Name of the block that is attached to the reservation." }, { "name": "blockIds", "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": "blockCodes", "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": "customReference", "value": "", "type": "query", "description": "Custom reference" }, { "name": "recordLocator", "value": "", "type": "query", "description": "GDS Record Locator for reservation." }, { "name": "orderBy", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" }, { "name": "roomAssignedOnly", "value": "", "type": "query", "description": "Indicator to query reservations which have a room number assigned." }, { "name": "roomUnassignedOnly", "value": "", "type": "query", "description": "Indicator to query reservations which does not have a room number assigned." }, { "name": "roomId", "value": "", "type": "query", "description": "Room number of the reservation to search by." }, { "name": "roomType", "value": "", "type": "query", "description": "Room Type." }, { "name": "roomFeatures", "value": "", "type": "query", "description": "A code representing a room feature." }, { "name": "roomSpecials", "value": "", "type": "query", "description": "Preference value for display purposes." }, { "name": "roomSmokingPreference", "value": "", "type": "query", "description": "Preference value for display purposes." }, { "name": "roomFloorPreferences", "value": "", "type": "query", "description": "Preference value for display purposes." }, { "name": "housekeepingRoomStatuses", "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": "roomClasses", "value": "", "type": "query" }, { "name": "roomRangeFrom", "value": "", "type": "query" }, { "name": "roomRangeTo", "value": "", "type": "query" }, { "name": "communication", "value": "", "type": "query", "description": "Any communication attached to the reservation from the primary guest's profile such as phone, fax or email address." }, { "name": "phone", "value": "", "type": "query", "description": "The phone number attached to the reservation from the primary guest's profile." }, { "name": "email", "value": "", "type": "query", "description": "The email address attached to the reservation from the primary guest's profile." }, { "name": "profileExternalReferencesToFetch", "value": "", "type": "query", "description": "Define the external system(s) to return external reference ids for associated profiles for the reservation. A maximum of 10 different external systems can be be provided for this parameter." }, { "name": "resvExternalReferencesToFetch", "value": "", "type": "query", "description": "Define the external system(s) to return external reference ids for reservations. A maximum of 10 different external systems can be be provided for this parameter." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Instruction on which elements of the reservation are to be fetched. Instructions are cumulative i.e. additional elements would be added, but not duplicated." }, { "name": "allowedReservationActions", "value": "", "type": "query", "description": "Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation." }, { "name": "allowPreRegistration", "value": "", "type": "query", "description": "Flag containing true or false value for reservation to be eligible for prior check in by guest using mobile device. Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile check in yes / no. Upon fetch, the current state of the flag will show true or false." }, { "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": "hasDepositBalance", "value": "", "type": "query", "description": "Indicates that only reservations with deposit balance should be expected from the result." }, { "name": "hasOpenBalance", "value": "", "type": "query", "description": "Indicates that only reservations with open balance should 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": "includeScheduledCheckOut", "value": "", "type": "query", "description": "Criteria that indicates whether to scheduled checkouts or not." }, { "name": "linkedOnly", "value": "", "type": "query", "description": "Indicates that only linked reservations should be expected from the result." }, { "name": "unlinkedOnly", "value": "", "type": "query", "description": "Indicates that only unlinked reservations should be expected from the result." }, { "name": "actualArrivals", "value": "", "type": "query", "description": "Indicates if reservations which have already arrived on the Search Date is required." }, { "name": "actualDepartures", "value": "", "type": "query", "description": "Indicates if reservations which were expected to depart on the Search Date and have already checked, is required." }, { "name": "complimentaryReservations", "value": "", "type": "query", "description": "Indicates if reservations where rate codes are marked as Complimentary Rates , is required. This flag should be used in conjunction with the Arrivals, Departures or StayOvers criteria." }, { "name": "dayOfArrivalCancels", "value": "", "type": "query", "description": "Indicates if reservations which have cancelled on the Search Date which is also the day of arrival is required." }, { "name": "dayUse", "value": "", "type": "query", "description": "Indicates if reservations which are day use reservation on the Search Date, is required." }, { "name": "earlyDepartures", "value": "", "type": "query", "description": "Indicates if reservations which checked out early on the Search Date, is required." }, { "name": "expectedArrivals", "value": "", "type": "query", "description": "Indicates if reservations which are expected arrivals for the Search Date and who have not yet arrived, is required." }, { "name": "expectedDepartures", "value": "", "type": "query", "description": "Indicates if reservations which are expected departures for the Search Date and who have not yet departed, is required." }, { "name": "extendedStays", "value": "", "type": "query", "description": "Indicates if reservations which have extended their stays on the Search Date, is required." }, { "name": "houseUseReservations", "value": "", "type": "query", "description": "Indicates if reservations where rate codes are marked as House Use Rates , is required. This flag should be used in conjunction with the Arrivals, Departures or StayOvers criteria." }, { "name": "stayovers", "value": "", "type": "query", "description": "Indicates if reservations which are StayOvers on the Search Date, is required." }, { "name": "stayDate", "value": "", "type": "query", "description": "Date for searching the reservations. This is the date for which the search types are applicable. If date is not available, the business date will be used by default." }, { "name": "roomRoutingId", "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": "periodicFolio", "value": "", "type": "query", "description": "Periodic folio type." }, { "name": "folioSettlementTypes", "value": "", "type": "query", "description": "Comma-delimited list of Folio Settlement Type codes." }, { "name": "defaultDays", "value": "", "type": "query", "description": "Use the Number of Days For Settlement, defined for the Reservation." }, { "name": "daysSinceLastAutoSettled", "value": "", "type": "query", "description": "Use the Number of days since last auto settled." }, { "name": "dateSinceLastAutoSettled", "value": "", "type": "query", "description": "Use the Date since last auto settled." }, { "name": "excludePseudoRoomReservations", "value": "", "type": "query", "description": "Indicates to exclude Pseudo room reservations." }, { "name": "excludeReservationIds", "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": "excludeVIPStatusCodes", "value": "", "type": "query", "description": "VIP status of the customer." }, { "name": "excludeSpecials", "value": "", "type": "query", "description": "Preference value for display purposes." }, { "name": "excludeFloorPreferences", "value": "", "type": "query", "description": "Preference value for display purposes." }, { "name": "excludeAdvanceCheckedIn", "value": "", "type": "query", "description": "Indicates to exclude Advance Checked In Reservations from search result." }, { "name": "excludeRoomFeatures", "value": "", "type": "query", "description": "Exclude the reservation(s) with provided room features from the search result." }, { "name": "playerId", "value": "", "type": "query", "description": "Player ID associated to the reservation." }, { "name": "gamingBalanceFrom", "value": "", "type": "query", "description": "Balance from." }, { "name": "gamingBalanceTo", "value": "", "type": "query", "description": "Balance to." }, { "name": "compAccountingBalanceFrom", "value": "", "type": "query", "description": "Comp Balance From" }, { "name": "compAccountingBalanceTo", "value": "", "type": "query", "description": "Comp Balance To" }, { "name": "searchTypes", "value": "", "type": "query", "description": "Represents Reservation search type Player Snapshot." }, { "name": "reservationStatuses", "value": "", "type": "query", "description": "Reservation status type for reservations search." }, { "name": "transportationCodes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "roomReadyStatuses", "value": "", "type": "query", "description": "Enum to denote the Status of Readiness messages sent to Guest Devices." }, { "name": "checkoutMessageReceived", "value": "", "type": "query", "description": "Fetches the reservations for which Checkout Message is received." }, { "name": "optedForCommunication", "value": "", "type": "query", "description": "Fetches the reservations for which reservation communication has been opted." }, { "name": "swapShiftRoomReservationId", "value": "", "type": "query", "description": "Fetches the reservations for which this reservation room can be shifted or swapped." }, { "name": "roomSmokingPreferences", "value": "", "type": "query", "description": "The smoking preferences of rooms to be fetched." }, { "name": "roomFeaturePreferences", "value": "", "type": "query", "description": "The room features of the rooms. Fetches reservations with rooms that have same room features. It has to be used in conjunction with roomType, arrivalStartDate, and arrivalEndDate." }, { "name": "roomsFloorPreferences", "value": "", "type": "query", "description": "The floor of the rooms. Fetches reservations with rooms that are on the same floor. It has to be used in conjunction with roomType, arrivalStartDate, and arrivalEndDate." }, { "name": "contactNames", "value": "", "type": "query", "description": "Name of Contact Profile associated with Reservation." }, { "name": "taRecordLocatorList", "value": "", "type": "query", "description": "Travel Agent Record Locators List." }, { "name": "packageCodes", "value": "", "type": "query", "description": "Package Codes and Package Groups to be searched, can only be used when searching for reservations at a single property with a maximum date range of 90 days. It is required to populate either Arrival From/To, Departure From/To, or the Stay Date filter(s)." }, { "name": "inventoryItems", "value": "", "type": "query", "description": "Inventory Items to be searched, can only be used when searching for reservations at a single property with a maximum date range of 90 days. It is required to populate either Arrival From/To, Departure From/To, or the Stay Date filter(s)" }, { "name": "guaranteeCodes", "value": "", "type": "query", "description": "Fetches the reservation having Guarantee Codes(Reservation Type) supplied here. Example guaranteeCodes=6PM" }, { "name": "linkedName", "value": "", "type": "query", "description": "Name of the group of Linked Reservations to be searched." }, { "name": "backToBackOnly", "value": "", "type": "query", "description": "Indicates that only reservations marked as Back to Back should be expected in the result." }, { "name": "backToBackDateOn", "value": "", "type": "query", "description": "Fetches linked Back to Back reservations with the specified Back to Back Date. Fetched reservations will be marked as Back to Back and they will either depart or arrive on the specified Back to Back day." }, { "name": "scheduledRoomMoveDate", "value": "", "type": "query", "description": "Scheduled Move Rooms Date Criteria. This will parameter be mandatory when search Type is ScheduledRoomMove." }, { "name": "scheduledRoomMoveStartTime", "value": "", "type": "query", "description": "Start of Scheduled Move Room Time Range Criteria (in 24 hour time format). Applicable when Search Type is ScheduledRoomMove. Uses the hotel's time zone." }, { "name": "scheduledRoomMoveEndTime", "value": "", "type": "query", "description": "End of Scheduled Move Room Time Range Criteria (in 24 hour time format). Applicable when Search Type is ScheduledRoomMove. Uses the hotel's time zone." }, { "name": "scheduledRoomMoveStatus", "value": "", "type": "query", "description": "Scheduled Move Room Status Criteria." }, { "name": "excludeBackToBackReservations", "value": "", "type": "query", "description": "When this flag is set to true, it will exclude the linked reservations which are marked as Back to Back in the result. Marking reservations as Back to Back is available when the Back to Back Handling for Linked Reservations OPERA control is active." }, { "name": "checkInInitiatedBy", "value": "", "type": "query", "description": "This indicates who initiated the Check In/Advance Check In.Advance Check In functionality is available when the Advance Check In OPERA Control is active." }, { "name": "flexChar", "value": "", "type": "query", "description": "Search by User Defined Character Field. Available to be used when searchType = Arrival, Arrived, InHouse, Departure or CheckedOut. Format for searching by User Defined Character field is UDFCXX:OperationId:getHotelReservations
" }, { "info": { "name": "Create Reservation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations", "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 where reservation is searched based on reservation ID." } ] }, "docs": "Use this to create a new reservation for a hA12:F24otel. Generally, you would search for a hotel's availability and rates before proceeding to use postReservation. There are many fields in postReservation defined by ListOfValues; ensure you have reviewed ListOfValues APIs in order successfully to use postReservation.OperationId:postReservation
" }, { "info": { "name": "Fetch Reservation Activity Log", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/activityLog", "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 where reservation is searched based on reservation ID." }, { "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": "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": "userByIdsUserId", "value": "", "type": "query" }, { "name": "userForIdsUserId", "value": "", "type": "query" } ] }, "docs": "Get the activity log for a reservation.OperationId:getReservationActivityLog
This API allows a time span of 90 days.
" }, { "info": { "name": "Create Bulk Reservation Alerts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/alerts", "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 where reservation is searched based on reservation ID." } ] }, "docs": "Create or updates multiple alerts for multiple reservations in bulk.OperationId:postBulkReservationAlerts
" }, { "info": { "name": "Cancel Reservations ", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/cancellations", "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 where reservation is searched based on reservation ID." } ] }, "docs": "This API can be used to cancel multiple reservations.OperationId:postCancelReservations
" }, { "info": { "name": "Link Reservations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/linkedReservations/: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", "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 searched based on reservation ID." } ] }, "docs": "This will allow you to link 1 or more reservations to an existing reservation.OperationId:postReservationLinks
" }, { "info": { "name": "Update Linked Reservations Common Details.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/linkedReservations/: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": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is searched based on reservation ID." }, { "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." } ] }, "docs": "This Operation allows to update attributes common to all reservations that are linked to an existing reservation.OperationId:putReservationLinks
" }, { "info": { "name": "Remove Reservation Links", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/linkedReservations/: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", "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 searched based on reservation ID." } ] }, "docs": "Use this API to unlink a reservation from its currently associated reservation.OperationId:deleteReservationLinks
" }, { "info": { "name": "Get Reservations by pacakge and consumption date", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/packageCategoryReservations", "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is searched based on reservation ID." }, { "name": "packageCategory", "value": "", "type": "query", "description": "Package Category of the package attached to the reservation. Reserved for future development." }, { "name": "packageCode", "value": "", "type": "query", "description": "Package code of the package attached to the reservation" }, { "name": "date", "value": "", "type": "query", "description": "Forecasted package consumption date" }, { "name": "limit", "value": "", "type": "query", "description": "Indicated maximum number of reservations to be sent in the response" }, { "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 get reservations with package consumption for a specific date.OperationId:getReservationsByPackage
" }, { "info": { "name": "Get Deposit and Cancellation Policies that are applicable to the specified criteria.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/policies", "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 that identifies a single hotel property." } ] }, "docs": "This API fetches Deposit and Cancellation Policies that are applicable to the specified criteria. The criteria can include the rate plan code, arrival date, guarantee code and the profile information.OperationId:validatePolicies
" }, { "info": { "name": "Get rate information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/rateInfo", "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 where reservation is searched based on reservation ID." }, { "name": "currencyCode", "value": "", "type": "query", "description": "The code specifying a monetary unit. Use ISO 4217, three alpha code." }, { "name": "summaryInfo", "value": "", "type": "query", "description": "Flag to indicate if summary information is required." }, { "name": "criteriaStartDate", "value": "", "type": "query" }, { "name": "criteriaEndDate", "value": "", "type": "query" }, { "name": "adults", "value": "", "type": "query", "description": "Defines the number of Adults." }, { "name": "children", "value": "", "type": "query", "description": "Defines the number of Children." }, { "name": "childAge", "value": "", "type": "query", "description": "Age of a child in years." }, { "name": "bucket1Count", "value": "", "type": "query", "description": "Number of children classified under the first Age Qualifying Group(Child Bucket#1)." }, { "name": "bucket2Count", "value": "", "type": "query", "description": "Number of children classified under the second Age Qualifying Group(Child Bucket#2)." }, { "name": "bucket3Count", "value": "", "type": "query", "description": "Number of children classified under the third Age Qualifying Group(Child Bucket#3)." }, { "name": "bucket4Count", "value": "", "type": "query", "description": "Number of children classified under the fourth Age Qualifying Group(Child Bucket#4)." }, { "name": "bucket5Count", "value": "", "type": "query", "description": "Number of children classified under the fifth Age Qualifying Group(Child Bucket#5)." }, { "name": "detailDate", "value": "", "type": "query", "description": "This field is only required when the criteria is meant for a detailed results. The date for the rate detail is needed." }, { "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": "blockIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "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": "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": "ratePlanCode", "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": "effectiveRateEnd", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "effectiveRateStart", "value": "", "type": "query", "description": "The starting value of the date range." }, { "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." } ] }, "docs": "Retrieve the rate plan information for a reservation.OperationId:getRateInfo
This API allows a time span of 21 days.
" }, { "info": { "name": "Get rate information", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/rateInfo/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": "Unique ID of the hotel where reservation is searched based on reservation ID." } ] }, "docs": "Retrieve the rate plan information for a reservation.OperationId:searchRateInfo
This API allows a time span of 21 days.
" }, { "info": { "name": "Cancel reservations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/reservationCancellations", "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 where reservation is searched based on reservation ID." } ] }, "docs": "Use this API to cancel reservations including multiple share reservations with single request. You will receive cancellation numbers in the response.OperationId:postCancelShareReservation
" }, { "info": { "name": "Get Reservations for a hotel", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/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": "Unique ID of the hotel where reservation is searched based on reservation ID." } ] }, "docs": "This API allows users to search for reservations at a hotel using criteria in the request body. For example, you can search using first name, last name, dates, external confirmation, and more.OperationId:searchHotelReservations
" }, { "info": { "name": "Get Reservation DistributionReservationsSummary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/statistics", "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": "This is the Hotel Code of the Reservations" }, { "name": "enterpriseId", "value": "", "type": "query", "description": "This is the EnterpriseId of Hotel Code" }, { "name": "channelCode", "value": "", "type": "query", "description": "This is the ChannelCode of Hotel Code in the Reservations" }, { "name": "startDate", "value": "", "type": "query", "description": "This is the Last Updated From Date for a Reservation" }, { "name": "endDate", "value": "", "type": "query", "description": "This is the Last Updated To Date for a Reservation" }, { "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": "Get DistributionReservationsSummary.OperationId:getDistributionReservationsSummary
" }, { "info": { "name": "Get brief summary for Reservations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/summary", "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 where reservations is being searched." }, { "name": "advancedCheckedIn", "value": "", "type": "query", "description": "This filter indicates if the reservation(s) has performed an Advance Check-In or not. Data fetched is for 30 days ahead of business date." }, { "name": "limit", "value": "", "type": "query", "description": "This filter indicates number of records the API has to fetch." }, { "name": "offset", "value": "", "type": "query", "description": "This filter is for the 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": "preRegistered", "value": "", "type": "query", "description": "This filter indicates whether the reservation is Pre-Registered for Internet Check-In or not. Data fetched is for 30 days ahead of business date." }, { "name": "arrivalDate", "value": "", "type": "query", "description": "This filter is for the date of arrival of reservation." }, { "name": "departureDate", "value": "", "type": "query", "description": "This filter is for the date of departure of reservation." }, { "name": "createDateTime", "value": "", "type": "query", "description": "This filter is for the business date when reservation(s) was created in the system." }, { "name": "cancelledOn", "value": "", "type": "query", "description": "This filter is for the date when reservation(s) was cancelled." }, { "name": "folioClosedOn", "value": "", "type": "query", "description": "This filter is for the date when reservation(s) folio was closed." }, { "name": "lastName", "value": "", "type": "query", "description": "This filter looks up reservations with this last Name. Data fetched is for +-2 business date only when passed alone." }, { "name": "companyId", "value": "", "type": "query", "description": "This filter is ID of the company used for the reservation. Data fetched is for +-2 business date only when passed alone." }, { "name": "guestNameId", "value": "", "type": "query", "description": "This filter is ID of the guest." }, { "name": "reservationStatus", "value": "", "type": "query", "description": "This filter is computed reservation status of the reservation(s)." }, { "name": "confirmationNumber", "value": "", "type": "query", "description": "This filter is ID of confirmation for the reservation." }, { "name": "externalReferenceNumber", "value": "", "type": "query", "description": "This filter is ID of external reference for the reservation." }, { "name": "cancellationNumber", "value": "", "type": "query", "description": "This filter is ID of cancellation for the reservation." }, { "name": "membershipNumber", "value": "", "type": "query", "description": "This filter is used for looking up reservations with this membership number. Last Name is required along with membership number to filter the data." }, { "name": "registeredCardNumber", "value": "", "type": "query", "description": "This filter is unique identifier of the registration card number. Last Name is required along with registration card number to filter the data." }, { "name": "balance", "value": "", "type": "query", "description": "This filter checks reservations with balance amount greater than or equal to this amount. Departure date is required along with balance to filter the data." }, { "name": "roomId", "value": "", "type": "query", "description": "This filter is for room number." } ] }, "docs": "This operation fetches brief summary for the reservations and also supports the Global Parameter MAX ROWS FETCH COUNT.
By default this parameter is configured to support an overall fetch of 5000 Records in total, with maximum number of records that can be fetched at a time being 200 (limit). However, this parameter can be updated to support an overall fetch value being a valid number between 1 and 10000 wi"
},
{
"info": {
"name": "Search brief summary for Reservations",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/hotels/:hotelId/reservations/summary/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": "Unique ID of the hotel where reservations is being searched."
}
]
},
"docs": "
This operation fetches brief summary for the reservations and also supports the Global Parameter MAX ROWS FETCH COUNT.
By default this parameter is configured to support an overall fetch of 5000 Records in total, with maximum number of records that can be fetched at a time being 200 (limit). However, this parameter can be updated to support an overall fetch value being a valid number between 1 and 10000 wi"
},
{
"info": {
"name": "Validate Reservation Before Creating or Applying Changes",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/hotels/:hotelId/reservations/validations",
"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 where reservation is searched based on reservation ID."
}
]
},
"docs": "Use this API to validate details of a reservation that you are about to create or modify. Elements to be validated will depend on the instructions provided e.g. StayDates, Packages, Shares etc. Use of this api will not change any data on the reservation.
OperationId:putValidateReservationChanges
" }, { "info": { "name": "Get Reservations to share by Reservation id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationIdtoShare/share", "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": "reservationIdtoShare", "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 searched based on reservation ID." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "superSearch", "value": "", "type": "query", "description": "Free form text field for searching all reservation fields" }, { "name": "reservationGuestId", "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": "reservationGuestIdType", "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": "membershipLevel", "value": "", "type": "query" }, { "name": "membershipType", "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": "roomId", "value": "", "type": "query", "description": "Room number" }, { "name": "cancellationNumberList", "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": "externalReferenceIds", "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": "externalSystemCodes", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "confirmationNumberList", "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": "taRecordLocatorList", "value": "", "type": "query", "description": "Travel Agent Record Locators List." }, { "name": "reservationStatuses", "value": "", "type": "query", "description": "Reservation status list for reservations search." }, { "name": "linkedName", "value": "", "type": "query", "description": "Name of the group of Linked Reservations to be searched." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Instruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction." } ] }, "docs": "Fetch the reservation that can be shared with an existing reservation.OperationId:getReservationsToShareByReservationId
The maximum allowable limit for this API is 100.
" }, { "info": { "name": "Get Reservation by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/: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", "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 searched based on reservation ID." }, { "name": "profileExternalReferencesToFetch", "value": "", "type": "query", "description": "Define the external system(s) to return external reference ids for associated profiles for the reservation. A maximum of 10 different external systems can be be provided for this parameter." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Instruction on which of the reservation's elements are to be returned e.g. DailySummary will return summarized information for each day of the reservation. Instructions are cumulative i.e. if multiple instructions are sent in a request, then the combined reservation elements would be returned, elements will not be duplicated in the response." }, { "name": "allowedActions", "value": "", "type": "query", "description": "Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation." }, { "name": "markAsRecentlyAccessed", "value": "", "type": "query", "description": "Marks the reservation as recently accessed." }, { "name": "includeInSession", "value": "", "type": "query", "description": "Flag indicating whether to fetch the in-session reservation." } ] }, "docs": "Retrieve a reservation using the internal ID.OperationId:getReservation
" }, { "info": { "name": "Update Reservation by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/: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", "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 searched based on reservation ID." } ] }, "docs": "Use this to update an existing reservation for a hotel, such as adding comments, changing the number of guests. There are many fields in putReservation defined by ListOfValues; ensure you have reviewed ListOfValues APIs in order successfully to use putReservation.OperationId:putReservation
" }, { "info": { "name": "Delete a Reservation by resort", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/: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", "description": "Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is to delete only an on hold (in-session) reservation." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is searched based on reservation ID." } ] }, "docs": "This API will delete only an on hold (in-session) reservation.OperationId:deleteOnHoldReservation
" }, { "info": { "name": "Update Add On (Sell Separate) packages on a reservation.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/addOnReservationPackages", "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 searched based on reservation ID." } ] }, "docs": "This API will allow you to update Add On (Sell Separate) packages on a reservation. Note: this API works as a full overlay for Reservation's Add On Packages.OperationId:putAddOnReservationPackages
" }, { "info": { "name": "Fetch Alert Notices", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/alerts", "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 searched based on reservation ID." }, { "name": "alertArea", "value": "", "type": "query" }, { "name": "welcomeOffer", "value": "", "type": "query", "description": "Determines whether to fetch Global Alert Notices or Welcome Offer Alert Notice." } ] }, "docs": "Get the alert notices including global alerts for a reservation.OperationId:getAlertNotices
" }, { "info": { "name": "Get Reservation attachments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/attachments", "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 searched based on reservation ID." }, { "name": "webRegistrationCard", "value": "", "type": "query", "description": "Indicator to retrieve e-Signed registration card attachments." }, { "name": "attachedFileName", "value": "", "type": "query", "description": "File name used to filter final list of attachments. For example, Document.txt." }, { "name": "description", "value": "", "type": "query", "description": "Description used to filter final list of attachments. For example, Offical guest ID. (This parameter does not require wildcard characters like * or % )." }, { "name": "digitalRegistration", "value": "", "type": "query", "description": "Indicator to retrieve digital registration attachments." } ] }, "docs": "Get Reservation attachmentsOperationId:getReservationAttachments
" }, { "info": { "name": "Delete Reservation attachments", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/attachments/:attachmentId", "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": "attachmentId", "value": "", "type": "path", "description": "Unique Id of the attachment to be deleted." }, { "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 searched based on reservation ID." } ] }, "docs": "Delete attachments from a Reservation.OperationId:deleteReservationAttachment
" }, { "info": { "name": "Validate before breaking a share Reservation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/breakshares/action/validate", "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 searched based on reservation ID." } ] }, "docs": "This API performs a validation before separating share reservations.OperationId:putBreakShareValidations
" }, { "info": { "name": "Get the Reservation Call History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/calls", "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 searched based on reservation ID." } ] }, "docs": "Get the Reservation Call HistoryOperationId:getCallHistory
" }, { "info": { "name": "Get cancellation history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/cancellationHistory", "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 searched based on reservation ID." }, { "name": "hotelName", "value": "", "type": "query" }, { "name": "roomStayStartDate", "value": "", "type": "query" }, { "name": "roomStayEndDate", "value": "", "type": "query" }, { "name": "roomStayDuration", "value": "", "type": "query" }, { "name": "roomClass", "value": "", "type": "query", "description": "Room class code" }, { "name": "roomType", "value": "", "type": "query", "description": "Room type code" }, { "name": "numberOfRooms", "value": "", "type": "query", "description": "Room Id" }, { "name": "roomId", "value": "", "type": "query", "description": "Room Id" }, { "name": "ratePlanCode", "value": "", "type": "query", "description": "Rate plan code" }, { "name": "reservationBlockHotelId", "value": "", "type": "query", "description": "This is the HotelCode of the Block." }, { "name": "reservationBlockId", "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": "reservationBlockIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "blockName", "value": "", "type": "query", "description": "The Name of the block that is attached to the reservation." }, { "name": "bookingChannelCode", "value": "", "type": "query", "description": "Booking channel code" }, { "name": "linkCode", "value": "", "type": "query", "description": "Party code" }, { "name": "onHold", "value": "", "type": "query", "description": "Guarantee Code." }, { "name": "membershipAccountId", "value": "", "type": "query", "description": "The account identification number for this particular member in this particular program." }, { "name": "membershipBonusCode", "value": "", "type": "query", "description": "The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.)" }, { "name": "membershipLevel", "value": "", "type": "query", "description": "The code or name of the membership level and indicates the level of membership (Gold Club, Platinum member, etc.). This is same as the BonusCode." }, { "name": "membershipId", "value": "", "type": "query", "description": "Membership ID (Unique ID from the memberships table)." }, { "name": "lastStayDate", "value": "", "type": "query", "description": "Guest's last stay date." } ] }, "docs": "Get cancellation history for a reservation.OperationId:getCancellationHistory
This API allows a time span of 30 days.
" }, { "info": { "name": "Create a Cancellation policy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/cancellationPolicies", "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 searched based on reservation ID." } ] }, "docs": "Create a new cancellation policy for a property.OperationId:postCancellationPolicy
" }, { "info": { "name": "Compute the cancellation policies", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/cancellationPolicies", "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 searched based on reservation ID." } ] }, "docs": "Compute the cancellation policies for a reservation.OperationId:putComputeCancellationPolicies
" }, { "info": { "name": "Delete a Cancellation policy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/cancellationPolicies", "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 searched based on reservation ID." }, { "name": "policyId", "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." } ] }, "docs": "Delete an existing cancellation policy for a specific hotel.OperationId:deleteCancellationPolicy
" }, { "info": { "name": "Cancel Reservation by ID", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/cancellations", "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 searched based on reservation ID." } ] }, "docs": "Use this if a guest would like to cancel their reservation. You will receive a cancellation number in the response.OperationId:postCancelReservation
" }, { "info": { "name": "Reinstate a Reservation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/cancellations", "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 searched based on reservation ID." } ] }, "docs": "Use this API to reinstate a cancelled reservation.OperationId:putReinstateReservation
" }, { "info": { "name": "Attach Certificate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/certificates", "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 searched based on reservation ID." } ] }, "docs": "Attach a certificate to Reservation.OperationId:postReservationCertificate
" }, { "info": { "name": "Detach Certificate", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/certificates", "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 searched based on reservation ID." } ] }, "docs": "Remove a certification from a reservation.OperationId:deleteReservationCertificate
" }, { "info": { "name": "Combine Share Validations", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/combineshares/action/validate", "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 searched based on reservation ID." } ] }, "docs": "Validate before combining Reservations for shares.OperationId:putCombineShareValidations
" }, { "info": { "name": "Update consumed package quantity for package codes.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/consumedPackageQuantity", "headers": [ { "name": "authorization", "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 searched based on reservation ID." } ] }, "docs": "Use this API to update the consumed package quantity for package codes.OperationId:putConsumedPackageQuantity
" }, { "info": { "name": "Copy a Reservation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/copy", "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 searched based on reservation ID." } ] }, "docs": "Copy a Reservation.OperationId:postReservationCopy
" }, { "info": { "name": "Validate daily rate details change", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/dailyRates/action/validate", "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 searched based on reservation ID." } ] }, "docs": "Validate daily rate details change.OperationId:putReservationDailyRateDetailValidation
" }, { "info": { "name": "Create deposit policy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/depositPolicies", "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 searched based on reservation ID." } ] }, "docs": "Create deposit policy for a property. This policy can then be used for reservations.OperationId:postDepositPolicy
" }, { "info": { "name": "Computes the deposit policies", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/depositPolicies", "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 searched based on reservation ID." } ] }, "docs": "Computes the deposit policies.OperationId:putComputeDepositPolicies
" }, { "info": { "name": "Delete deposit policy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/depositPolicies", "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 searched based on reservation ID." }, { "name": "policyId", "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." } ] }, "docs": "Delete deposit policy for a property.OperationId:deleteDepositPolicy
" }, { "info": { "name": "Get Reservation Ecoupons", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/eCoupons", "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 searched based on reservation ID." }, { "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": "Get the Reservation Ecoupons.OperationId:getECoupons
" }, { "info": { "name": "Create Reservation ECoupon", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/eCoupons", "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 searched based on reservation ID." } ] }, "docs": "Create the Reservation Ecoupons.OperationId:postECoupons
" }, { "info": { "name": "Change Reservation Ecoupon", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/eCoupons", "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 searched based on reservation ID." } ] }, "docs": "Change the Reservation Ecoupons.OperationId:putECoupons
" }, { "info": { "name": "Delete Reservation ECoupons", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/eCoupons", "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 searched based on reservation ID." }, { "name": "eCouponId", "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." } ] }, "docs": "Delete the Reservation Ecoupons.OperationId:deleteECoupons
" }, { "info": { "name": "Operation to delete a flex field.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/flexFieldCode/:flexFieldCode", "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": "flexFieldCode", "value": "", "type": "path", "description": "Flex field code" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel in OPERA" }, { "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." } ] }, "docs": "Operation to delete a flex field Value.OperationId:deleteFlexFieldValue
" }, { "info": { "name": "Operation to fetch flex field values.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/flexFieldValues", "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 in OPERA" }, { "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": "flexFieldId", "value": "", "type": "query", "description": "Flex field ID" }, { "name": "flexFieldCode", "value": "", "type": "query", "description": "Flex field code" }, { "name": "flexFieldValue", "value": "", "type": "query", "description": "Flex field Value" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return. Default is 50" }, { "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": "API to fetch flex field values.OperationId:getFlexFieldValue
" }, { "info": { "name": "Operation to create a flex field with value for a module.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/flexFieldValues", "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 in OPERA" }, { "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." } ] }, "docs": "Operation to create a flex field Value.OperationId:postFlexFieldValue
" }, { "info": { "name": "Operation to update flex field value.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/flexFieldValues", "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 in OPERA" }, { "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." } ] }, "docs": "Operation to update flex field value.OperationId:putFlexFieldValue
" }, { "info": { "name": "Fetch Reservation Guest Locator", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/guestLocators", "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 searched based on reservation ID." } ] }, "docs": "Get the Guest locater for a Reservation.OperationId:getReservationLocators
" }, { "info": { "name": "Create Reservation Guest Locator", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/guestLocators", "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 searched based on reservation ID." } ] }, "docs": "Create Guest Locater for a list of Reservations.OperationId:postReservationLocators
" }, { "info": { "name": "Change Reservation Guest Locators", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/guestLocators/:locatorId", "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": "locatorId", "value": "", "type": "path" }, { "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 searched based on reservation ID." } ] }, "docs": "Change a list of Guest Locater for a Reservation.OperationId:changeReservationLocators
" }, { "info": { "name": "Remove Reservation Locators", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/guestLocators/:locatorId", "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": "locatorId", "value": "", "type": "path" }, { "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 searched based on reservation ID." } ] }, "docs": "Delete a Guest Locater for a Reservation.OperationId:deleteReservationLocators
" }, { "info": { "name": "Create guest messages", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/guestMessages", "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 searched based on reservation ID." } ] }, "docs": "Create guest message for a guest reservation.OperationId:postGuestMessages
" }, { "info": { "name": "Change Reservation Guest Messages", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/guestMessages", "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 searched based on reservation ID." } ] }, "docs": "Change guest messages for Reservation.OperationId:putResvGuestMessages
" }, { "info": { "name": "Change guest Message ", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/guestMessages/:guestMessageId", "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": "guestMessageId", "value": "", "type": "path", "description": "Guest Message Id" }, { "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 searched based on reservation ID." } ] }, "docs": "Change guest Message on a reservation.OperationId:putGuestMessages
" }, { "info": { "name": "Delete guest messages", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/guestMessages/:guestMessageId", "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": "guestMessageId", "value": "", "type": "path", "description": "Guest Message Id" }, { "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 searched based on reservation ID." } ] }, "docs": "Delete guest messages from a reservation.OperationId:deleteGuestMessages
" }, { "info": { "name": "Validate Reservation header change", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/header/action/validate", "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 searched based on reservation ID." } ] }, "docs": "Validate Reservation header change.OperationId:putReservationHeaderValidation
" }, { "info": { "name": "Get Reserved Inventory Items ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/inventoryItems", "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 searched based on reservation ID." } ] }, "docs": "Get the Inventory Items reserved for the Reservation.OperationId:getReservedInventoryItems
" }, { "info": { "name": "Reserve Reservation inventory items", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/inventoryItems", "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 searched based on reservation ID." } ] }, "docs": "Reserve Reservation inventory items.OperationId:postReserveInventoryItems
" }, { "info": { "name": "Change reserved Inventory Items ", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/inventoryItems", "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 searched based on reservation ID." } ] }, "docs": "Change the Inventory Items reserved for the Reservation.OperationId:putReservedInventoryItems
" }, { "info": { "name": "Delete Reserved Inventory Items", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/inventoryItems", "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 searched based on reservation ID." } ] }, "docs": "Delete the Inventory Items reserved for the Reservation.OperationId:deleteReservedInventoryItems
" }, { "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", "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 searched based on reservation ID." }, { "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": "additionalReservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Instruction to fetch whether the room was assigned/upgraded by AI. This will also include Reservation instruction." } ] }, "docs": "Get linked Reservations for given Reservation.OperationId:getLinkedReservations
" }, { "info": { "name": "Update Linked Reservation by ID", "type": "http" }, "http": { "method": "PUT", "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", "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 searched based on reservation ID." } ] }, "docs": "Use this API to update an existing linked reservation for given reservation name id and hotel code.OperationId:putLinkedReservation
" }, { "info": { "name": "Get Reservation summary for linked Reservation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/linkedSummary", "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 searched based on reservation ID." }, { "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": "additionalReservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "backToBackOnly", "value": "", "type": "query", "description": "Indicates that only reservations marked as Back to Back should be expected in the result. Returned linked Back to Back reservations will belong to the same group of linked Back to Back reservations as the specified reservation with the given reservation name id and hotel code." }, { "name": "excludeCancelledReservations", "value": "", "type": "query", "description": "When true indicates that linked reservations with Cancelled status should not be included in search results." }, { "name": "excludeNoShowReservations", "value": "", "type": "query", "description": "When true indicates that linked reservations with NoShow status should not be included in search results." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records this Web Service should return. Minimum is 0. Default is 200." } ] }, "docs": "Get Reservation summary for linked Reservation of given Reservation id.OperationId:getLinkedReservationsSummary
" }, { "info": { "name": "Acquire Reservation Lock", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/locks", "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 searched based on reservation ID." } ] }, "docs": "Acquire Reservation Lock.OperationId:putAcquireReservationLock
" }, { "info": { "name": "Break Reservation lock", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/locks/break", "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 searched based on reservation ID." } ] }, "docs": "Break Reservation lock on a reservation.OperationId:postBreakReservationLock
" }, { "info": { "name": "Create a Master Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/masterAccount", "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 searched based on reservation ID." } ] }, "docs": "Create a master account for a reservation.OperationId:postMasterAccount
" }, { "info": { "name": "Change a Master Account", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/masterAccount", "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 searched based on reservation ID." } ] }, "docs": "Change a master account on a reservation.OperationId:putMasterAccount
" }, { "info": { "name": "Cancel Master Account", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/masterAccount", "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 searched based on reservation ID." } ] }, "docs": "Cancel Master account on a reservation.OperationId:deleteMasterAccount
" }, { "info": { "name": "Merge multiple Reservations", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/mergeReservations", "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 searched based on reservation ID." } ] }, "docs": "Use this API to merge multiple reservations.OperationId:mergeReservations
" }, { "info": { "name": "Move the Reservation ", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/move", "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 searched based on reservation ID." } ] }, "docs": "This API can be used to move a reservation to a different hotel.OperationId:putReservationHotelMove
" }, { "info": { "name": "Get Package", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/packages", "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 searched based on reservation ID." }, { "name": "postingRhythm", "value": "", "type": "query" }, { "name": "productCode", "value": "", "type": "query" }, { "name": "ratePlanCode", "value": "", "type": "query" }, { "name": "reservationTimeSpanStartDate", "value": "", "type": "query" }, { "name": "reservationTimeSpanEndDate", "value": "", "type": "query" }, { "name": "packageTimeSpanStartDate", "value": "", "type": "query" }, { "name": "packageTimeSpanEndDate", "value": "", "type": "query" }, { "name": "packageQuantity", "value": "", "type": "query" }, { "name": "packageExcludedQuantity", "value": "", "type": "query" }, { "name": "reservationAdults", "value": "", "type": "query", "description": "Defines the number of Adults." }, { "name": "reservationChildren", "value": "", "type": "query", "description": "Defines the number of Children." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Simple type for package instructions that can be used in requests for partial operations." } ] }, "docs": "Get the package availability for a hotel code and reservation idOperationId:getPackage
" }, { "info": { "name": "Add a package to a Reservation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/packages", "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 searched based on reservation ID." } ] }, "docs": "This API will allow you to add packages to a reservation.OperationId:postReservationPackage
" }, { "info": { "name": "Update a package on a Reservation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/packages", "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 searched based on reservation ID." } ] }, "docs": "This API will allow you to update existing packages on a reservation.OperationId:putReservationPackage
" }, { "info": { "name": "Delete a package from a Reservation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/packages", "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 searched based on reservation ID." } ] }, "docs": "This API will allow you to delete packages from a reservation.OperationId:deleteReservationPackage
" }, { "info": { "name": "Update Payee Sharer Information by ID.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/payeeSharer", "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 searched based on reservation ID." } ] }, "docs": "Use this API to mark or un mark a shared reservation as the payee sharer for the group of shared reservations.OperationId:putPayeeSharer
" }, { "info": { "name": "Get a payment method ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/paymentMethods", "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 searched based on reservation ID." }, { "name": "includeAmounts", "value": "", "type": "query", "description": "Flag to notify the operation to also retrieve the outstanding balance, current authorized amount and amount needed to be approved for each folio." } ] }, "docs": "This API will return the payment method(s) that exist on a reservation.OperationId:getPaymentMethods
" }, { "info": { "name": "Create a payment method ", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/paymentMethods", "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 searched based on reservation ID." } ] }, "docs": "Use this API to add a payment method to a reservation.OperationId:postPaymentMethods
" }, { "info": { "name": "Change a payment method ", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/paymentMethods", "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 searched based on reservation ID." } ] }, "docs": "This API will update an existing payment method on a reservation.OperationId:putPaymentMethods
" }, { "info": { "name": "Delete a payment method ", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/paymentMethods", "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 searched based on reservation ID." } ] }, "docs": "Use this API to delete a payment method from a reservation.OperationId:deletePaymentMethods
" }, { "info": { "name": "Get Reservation Policies", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/policies", "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 searched based on reservation ID." }, { "name": "fetchDepositPolicies", "value": "", "type": "query", "description": "A flag which instructs whether the deposit policies needs to be fetched." }, { "name": "fetchCancellationPolicies", "value": "", "type": "query", "description": "A flag which instructs whether the cancel policies needs to be fetched." } ] }, "docs": "This API will retrieve the reservation policies for a specified reservation.OperationId:getReservationPolicies
" }, { "info": { "name": "Pre-Checkin a Reservation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/preCheckIn", "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 searched based on reservation ID." } ] }, "docs": "This will allow you to set a reservation as a pre-registered guest. The API request requires the guests confirmation number and you can optionally include arrival time. The behavior of the API will be dependent upon the Pre-registration rules configured for the hotel in OPERA Cloud administration.OperationId:postPreCheckInReservation
" }, { "info": { "name": "Revert a PreCheckIn Reservation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/preCheckIn", "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 searched based on reservation ID." }, { "name": "resvIDExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "arrivalTime", "value": "", "type": "query", "description": "The time at which the guest arrives at the hotel. Uses the hotel's time zone." }, { "name": "roomNumber", "value": "", "type": "query", "description": "Room Number to be assigned to the reservation." }, { "name": "guestPreferredCurrency", "value": "", "type": "query", "description": "Currency code preferred by guest." }, { "name": "allowMobileViewFolio", "value": "", "type": "query", "description": "Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device." }, { "name": "paymentMethodDescription", "value": "", "type": "query" }, { "name": "paymentMethodFolioView", "value": "", "type": "query" }, { "name": "paymentMethod", "value": "", "type": "query" }, { "name": "attachCreditCardToProfile", "value": "", "type": "query", "description": "Attach the credit card to profile." }, { "name": "cardHolderName", "value": "", "type": "query" }, { "name": "cardNumber", "value": "", "type": "query" }, { "name": "cardNumberLast4Digits", "value": "", "type": "query" }, { "name": "cardNumberMasked", "value": "", "type": "query" }, { "name": "cardOrToken", "value": "", "type": "query", "description": "Simple type for indicating if credit card number is tokenized." }, { "name": "cardType", "value": "", "type": "query", "description": "This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method." }, { "name": "expirationDate", "value": "", "type": "query", "description": "Expiration date of the credit card" }, { "name": "expirationDateExpired", "value": "", "type": "query" }, { "name": "expirationDateMasked", "value": "", "type": "query", "description": "Masked Expiration date of the credit card" }, { "name": "processing", "value": "", "type": "query" }, { "name": "swiped", "value": "", "type": "query" }, { "name": "userDefinedCardType", "value": "", "type": "query", "description": "Indicates the user defined credit card type if credit card type from a defined list is not provided" }, { "name": "cardId", "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": "cardIdIDExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "cardIdIDContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "cardIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "currentAuthorizedAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "authorizedAmountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "approvalAmountNeeded", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "approvalAmountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "balanceAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "balanceCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "authorizationRuleCode", "value": "", "type": "query", "description": "The authorization rule code." }, { "name": "authorizationRuleAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "authorizationRuleCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "authorizationRulePercent", "value": "", "type": "query", "description": "A percentage value if the authorization rule is percentage based." }, { "name": "emailFolio", "value": "", "type": "query" }, { "name": "emailFolioID", "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": "emailFolioIDExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "emailFolioIDContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "emailFolioIDType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "emailFolioCreateDateTime", "value": "", "type": "query", "description": "Time stamp of the creation. Uses the hotel's time zone." }, { "name": "emailFolioCreatorID", "value": "", "type": "query", "description": "ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation." }, { "name": "emailFolioEmailAddress", "value": "", "type": "query", "description": "Defines the e-mail address." }, { "name": "emailFolioEmailFormat", "value": "", "type": "query", "description": "Supported Email format." }, { "name": "emailFolioLastModifierID", "value": "", "type": "query", "description": "Identifies the last software system or person to modify a record." }, { "name": "emailFolioLastModifyDateTime", "value": "", "type": "query", "description": "Time stamp of last modification. Uses the hotel's time zone." }, { "name": "emailFolioOrderSequence", "value": "", "type": "query", "description": "Display Order sequence." }, { "name": "emailFolioPrimaryInd", "value": "", "type": "query", "description": "When true, indicates a primary information." }, { "name": "emailFolioPurgeDate", "value": "", "type": "query", "description": "Date an item will be purged from a database (e.g., from a live database to an archive)." }, { "name": "emailFolioType", "value": "", "type": "query", "description": "Defines the purpose of the e-mail address (e.g. personal, business, listserve)." }, { "name": "emailFolioTypeDescription", "value": "", "type": "query", "description": "Describes the Type code" }, { "name": "arrivalCarrierCode", "value": "", "type": "query" }, { "name": "arrivalDateTime", "value": "", "type": "query", "description": "Uses the hotel's time zone." }, { "name": "arrivalStationCode", "value": "", "type": "query" }, { "name": "arrivalTransportCode", "value": "", "type": "query" }, { "name": "arrivalTransportationReqd", "value": "", "type": "query" }, { "name": "arrivalType", "value": "", "type": "query" }, { "name": "arrivalComments", "value": "", "type": "query" } ] }, "docs": "This will cancel or rather revert the pre-checkin action for a guest's reservation. The reservation will return to DUEIN status.OperationId:deletePreCheckInReservation
" }, { "info": { "name": "Revert a PreCheckIn Reservation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/preCheckIn/deletions", "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 where reservation is searched based on reservation ID." }, { "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." } ] }, "docs": "This will cancel or rather revert the pre-checkin action for a guest's reservation. The reservation will return to DUEIN status.OperationId:postDeletePreCheckInReservation
" }, { "info": { "name": "Get Reservation Preferences", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/preferences", "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 searched based on reservation ID." }, { "name": "preferenceTypeCode", "value": "", "type": "query" } ] }, "docs": "You can use this API to retrieve the preferences that exist on a reservation.OperationId:getReservationPreference
" }, { "info": { "name": "Add a preference to a Reservation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/preferences", "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 searched based on reservation ID." } ] }, "docs": "This API will add a preference to a Reservation.OperationId:postReservationPreference
" }, { "info": { "name": "Change a Reservation Preference", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/preferences/:preferenceCode", "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": "preferenceCode", "value": "", "type": "path", "description": "Preference Code" }, { "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 searched based on reservation ID." } ] }, "docs": "You can use this API to update the preferences that exist on a reservation.OperationId:putReservationPreference
" }, { "info": { "name": "Delete a Reservation Preference", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/preferences/:preferenceCode", "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": "preferenceCode", "value": "", "type": "path", "description": "Preference Code" }, { "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 searched based on reservation ID." } ] }, "docs": "You can use this API to remove a preference that exist on a reservation.OperationId:deleteReservationPreference
" }, { "info": { "name": "Reverse a deposit policy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/reverseDepositPolicy/:policyId", "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": "policyId", "value": "", "type": "path", "description": "Policy ID" }, { "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 searched based on reservation ID." } ] }, "docs": "You can use this API to reverse a deposit policy on a specified reservation.OperationId:postReverseDepositPolicy
" }, { "info": { "name": "Get routing instructions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/routingInstructions", "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 searched based on reservation ID." }, { "name": "includeWindowRouting", "value": "", "type": "query", "description": "Include the window routing instructions to the response." }, { "name": "includeRoomRouting", "value": "", "type": "query", "description": "Include the room routing instructions in the response." }, { "name": "includeCompRouting", "value": "", "type": "query", "description": "Include the comp routing instructions in the response." }, { "name": "includeCompRoutingRequests", "value": "", "type": "query", "description": "Include the comp routing requests in the response." }, { "name": "effectiveOn", "value": "", "type": "query", "description": "If date is included then the search result should only be valid for dates which includes this date." } ] }, "docs": "Use this API to fetch a reservation's routing instructions. It requires a reservation ID, which can be fetched using getReservations.OperationId:getRoutingInstructions
The maximum allowable limit for this API is 20.
" }, { "info": { "name": "Create routing instructions for a reservation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/routingInstructions", "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 searched based on reservation ID." } ] }, "docs": "You can use this API to create routing instructions on a reservation. It requires a reservation ID, which can be fetched using getReservations.OperationId:postRoutingInstructions
" }, { "info": { "name": "Change routing instructions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/routingInstructions", "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 searched based on reservation ID." } ] }, "docs": "Change routing instructions on an existing reservation.OperationId:putRoutingInstructions
" }, { "info": { "name": "Delete routing instructions", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/routingInstructions", "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 searched based on reservation ID." } ] }, "docs": "You can use this API to delete routing instructions from a reservation.OperationId:deleteRoutingInstructions
" }, { "info": { "name": "Update Scheduled Room Move Details based on reservationID and move date", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/scheduledRoomMoves/:scheduledMoveDate", "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": "Property code of the reservation." }, { "name": "scheduledMoveDate", "value": "", "type": "path", "description": "The scheduled date of room move." } ] }, "docs": "Use this to update an existing scheduled room move for a reservation in a hotel and for a specific date. Use this to update move comments, move time etc.OperationId:putScheduledRoomMove
" }, { "info": { "name": "Separate Share Reservation and apply rate amounts to separated and remaining share reservations from room rates provided by an external application on a daily basis.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/separatedShare", "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 searched based on reservation ID." }, { "name": "overrideInventoryCheck", "value": "", "type": "query", "description": "Indicate to Override the Room Inventory Check if applicable." }, { "name": "overrideMaxOccupancyCheck", "value": "", "type": "query", "description": "Indicate to Override the check on Maximum Room Occupancy if applicable." }, { "name": "overrideRateAvailabilityCheck", "value": "", "type": "query", "description": "Indicate to Override the check on Maximum Room Occupancy if applicable." } ] }, "docs": "This API can be used to separate the share reservation and apply rate amounts to separated and remaining share reservations from room rates provided by an external application on a daily basis.OperationId:putSeparateShareReservation
" }, { "info": { "name": "Change Share Rate Amount", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/shareRateAmount", "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 searched based on reservation ID." } ] }, "docs": "Change the share amounts of a reservationOperationId:putShareRateAmount
" }, { "info": { "name": "Change Sharing Guests", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/sharedGuestCount", "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 searched based on reservation ID." } ] }, "docs": "Change the guest counts(adults or children) for a Sharing ReservationOperationId:putSharingGuests
" }, { "info": { "name": "Get share Reservations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/shares", "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 searched based on reservation ID." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Instruction on which of the shared reservation's elements are to be returned e.g. DailySummary will return summarized information for each day of the shared reservation. Instructions are cumulative i.e. if multiple instructions are sent in a request, then the combined shared reservation elements would be returned, elements will not be duplicated in the response." } ] }, "docs": "This API can be used to retrieve the share reservations that exist on a reservation.OperationId:getShareReservations
" }, { "info": { "name": "Combine Share Reservations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/shares", "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 searched based on reservation ID." } ] }, "docs": "Combine share reservation for a given reservation idOperationId:postCombineShareReservations
" }, { "info": { "name": "Separate share Reservations", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/shares", "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 searched based on reservation ID." }, { "name": "overrideInventoryCheck", "value": "", "type": "query", "description": "Indicate to Override the Room Inventory Check if applicable." }, { "name": "overrideMaxOccupancyCheck", "value": "", "type": "query", "description": "Indicate to Override the check on Maximum Room Occupancy if applicable." }, { "name": "overrideRateAvailabilityCheck", "value": "", "type": "query", "description": "Indicate to Override the check on Maximum Room Occupancy if applicable." }, { "name": "returnShareReservations", "value": "", "type": "query", "description": "After the break share operation, return the new list of Sharer Reservations." } ] }, "docs": "This API can be used to separate the share reservations.OperationId:deleteShareReservation
" }, { "info": { "name": "Check overlapping stay", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/stay/action/validate", "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 searched based on reservation ID." } ] }, "docs": "Validate overlapping stay for a reservationOperationId:putValidateOverlappingStay
" }, { "info": { "name": "Get tickets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/tickets", "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 searched based on reservation ID." }, { "name": "packageCode", "value": "", "type": "query", "description": "Property where the tickets messages belongs to." }, { "name": "retrieveIssuedOnly", "value": "", "type": "query", "description": "Flag that specified if only issued tickets will be retrieved." }, { "name": "retrieveNotIssuedOnly", "value": "", "type": "query", "description": "Flag that specified if only not issued tickets will be retrieved." } ] }, "docs": "Get tickets for a reservation.OperationId:getTickets
" }, { "info": { "name": "Create tickets", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/tickets", "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 searched based on reservation ID." } ] }, "docs": "Use this API to create tickets on a reservation.OperationId:postTickets
" }, { "info": { "name": "Change tickets", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/tickets", "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 searched based on reservation ID." } ] }, "docs": "Use this API to change tickets on a reservation.OperationId:putTickets
" }, { "info": { "name": "Delete tickets", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/tickets", "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 searched based on reservation ID." } ] }, "docs": "You can use this API to delete tickets from a reservation.OperationId:deleteTickets
" }, { "info": { "name": "Inquiry for Reservation tickets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/tickets/inquiry", "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 searched based on reservation ID." }, { "name": "ticketId", "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": "ticketIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "packageCode", "value": "", "type": "query", "description": "Package Code." }, { "name": "reservationProductId", "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": "reservationProductIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "ticketNumberId", "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": "ticketNumberIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "ticketIssueDate", "value": "", "type": "query", "description": "Tickets issue date." }, { "name": "ticketConsumptionDate", "value": "", "type": "query", "description": "Tickets comsumption date." }, { "name": "ticketRateCode", "value": "", "type": "query", "description": "The Rate Code to which tickets belong to." }, { "name": "ticketStatus", "value": "", "type": "query", "description": "The Status Code for outbound WS call." } ] }, "docs": "You can use this API to perform a Inquiry for Reservation tickets.OperationId:getTicketsInquiry
" }, { "info": { "name": "Issue Reservation tickets", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/tickets/issue", "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 searched based on reservation ID." } ] }, "docs": "You can use this API to issue Reservation tickets.OperationId:postIssueTickets
" }, { "info": { "name": "Refund Reservation tickets", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/tickets/refund", "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 searched based on reservation ID." } ] }, "docs": "You can use this API to refund Reservation tickets.OperationId:deleteRefundTickets
" }, { "info": { "name": "Reprints Reservation tickets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/tickets/reprint", "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 searched based on reservation ID." }, { "name": "ticketId", "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": "ticketIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "packageCode", "value": "", "type": "query", "description": "Package Code." }, { "name": "reservationProductId", "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": "reservationProductIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "ticketNumberId", "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": "ticketNumberIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "ticketIssueDate", "value": "", "type": "query", "description": "Tickets issue date." }, { "name": "ticketConsumptionDate", "value": "", "type": "query", "description": "Tickets comsumption date." }, { "name": "ticketRateCode", "value": "", "type": "query", "description": "The Rate Code to which tickets belong to." }, { "name": "ticketStatus", "value": "", "type": "query", "description": "The Status Code for outbound WS call." } ] }, "docs": "You can use this API to reprint Reservation tickets.OperationId:getReprintTickets
" }, { "info": { "name": "Get traces for a Reservation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/traces", "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 searched based on reservation ID." } ] }, "docs": "You can use this API to get traces for a Reservation.OperationId:getTracesByReservation
" }, { "info": { "name": "Get Transaction Diversions ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/transactionDiversions", "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 searched based on reservation ID." }, { "name": "transactionDiversionCodes", "value": "", "type": "query" }, { "name": "includeDailyDetails", "value": "", "type": "query", "description": "Flag to check if the the daily details are required to be fetched for a particular transaciton." } ] }, "docs": "You can use this API to get Transaction Diversions.OperationId:getTransactionDiversions
" }, { "info": { "name": "Create Transaction Diversions ", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/transactionDiversions", "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 searched based on reservation ID." } ] }, "docs": "You can use this API to create Transaction Diversions.OperationId:postTransactionDiversions
" }, { "info": { "name": "Change Transaction Diversions ", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/transactionDiversions", "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 searched based on reservation ID." } ] }, "docs": "You can use this API to change Transaction Diversions.OperationId:putTransactionDiversions
" }, { "info": { "name": "Delete Transaction Diversions ", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/transactionDiversions", "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 searched based on reservation ID." } ] }, "docs": "You can use this API to delete Transaction Diversions.OperationId:deleteTransactionDiversions
" }, { "info": { "name": "Set Upgrade Eligibility for Reservations", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/upgradeEligibleReservations", "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 searched based on reservation ID." } ] }, "docs": "You can use this API to set Upgrade Eligibility for Reservations.OperationId:putReservationsUpgradeEligibility
" }, { "info": { "name": "Get available Upsell offers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/upsell", "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 searched based on reservation ID." } ] }, "docs": "Use this API to retrieve the available upsell offers for a specific reservation. If no upsell options are configured for this hotel or available for this reservation, an appropriate error will be returned.OperationId:getReservationUpsellInfo
" }, { "info": { "name": "Upsell a Reservation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/upsell", "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 searched based on reservation ID." } ] }, "docs": "This API will allow you to upsell a reservation in OPERA. You would need to already know the upsell rules that are available for this reservation - you can do this by using the getUpsell API.OperationId:postUpsellReservation
" }, { "info": { "name": "Delete a Reservation Upsell", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/reservations/:reservationId/upsell", "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 searched based on reservation ID." }, { "name": "overrideInventory", "value": "", "type": "query", "description": "Indicates whether to Override the Room Inventory Check" } ] }, "docs": "This API will enable you to delete an upsell from a reservation. There may be reservation policies that might prevent an upsell from being deleted and as such an appropriate response will be returned.OperationId:deleteUpsell
" }, { "info": { "name": "Get the room calendar", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/roomCalendar", "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 where reservation is searched based on reservation ID." }, { "name": "advanceCheckedIn", "value": "", "type": "query", "description": "If true, then filter room results to rooms with Advance Checked In Reservations." }, { "name": "assignedRooms", "value": "", "type": "query", "description": "If 'Y', then filter room results to rooms that are assigned to guest." }, { "name": "componentRooms", "value": "", "type": "query", "description": "If 'Y', then filter room results to component rooms." }, { "name": "connectingRoomsOnly", "value": "", "type": "query", "description": "If 'Y', then filter room results to only connecting rooms." }, { "name": "backToBackOnly", "value": "", "type": "query", "description": "Indicates that only reservations marked as Back to Back should be expected in the result." }, { "name": "linkedReservationsOnly", "value": "", "type": "query", "description": "Indicates that only linked reservations are expected in the result." }, { "name": "linkedName", "value": "", "type": "query", "description": "Name of the group of Linked Reservations to be searched." }, { "name": "scheduledRoomMoveOnly", "value": "", "type": "query", "description": "Indicates that only reservations having scheduled room moves should be expected in the result." }, { "name": "dueOut", "value": "", "type": "query", "description": "If 'Y', then filter room results to rooms with Due Out Reservations." }, { "name": "endDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "isSortDescending", "value": "", "type": "query", "description": "If true, then fetch result will be sorted in descending order." }, { "name": "pageIndex", "value": "", "type": "query", "description": "Page index to be retrieved." }, { "name": "partiallyAssignedRooms", "value": "", "type": "query", "description": "If 'Y', then filter room results to component rooms that have at least one of its rooms assigned to guest." }, { "name": "recordsPerPage", "value": "", "type": "query", "description": "Number of records per page." }, { "name": "roomConditions", "value": "", "type": "query", "description": "If 'Y', then filter room results to rooms with Room Conditions." }, { "name": "ownerRoomsOnly", "value": "", "type": "query", "description": "If 'Y', then filter room results to rooms with rotation rooms only. It is supported only if OPERA Control Room Rotation is active." }, { "name": "ownerExclusiveOnly", "value": "", "type": "query", "description": "If 'Y', then filter room results to rooms that are exclusive to the owner. It is supported only if OPERA Control Room Rotation is active." }, { "name": "sortingBy", "value": "", "type": "query", "description": "A collection of supported sorting for room calendar." }, { "name": "includeRoomMoveHistory", "value": "", "type": "query", "description": "Include Room Move History in result." }, { "name": "includeComponentRoomBlockOutDates", "value": "", "type": "query", "description": "Include information about Component Room Reservation dates when fetching a component suite." }, { "name": "startDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "unassignedRooms", "value": "", "type": "query", "description": "If 'Y', then filter room results to rooms that are not yet assigned to guest." }, { "name": "roomId", "value": "", "type": "query", "description": "Room search filter." }, { "name": "roomType", "value": "", "type": "query", "description": "Room Type search filter." }, { "name": "roomClass", "value": "", "type": "query", "description": "Room Class search filter." }, { "name": "floor", "value": "", "type": "query", "description": "Floor search filter." }, { "name": "roomFeature", "value": "", "type": "query", "description": "A code representing a room feature." }, { "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": "smokingPreference", "value": "", "type": "query", "description": "Smoking Preference filter." }, { "name": "bedType", "value": "", "type": "query" }, { "name": "showRoomMoveSegments", "value": "", "type": "query", "description": "If set to true then reservations having past or future room moves will come according to the exact stay dates in the rooms." } ] }, "docs": "Use this API to get the room calendar for your Hotel.OperationId:getRoomCalendar
This API allows a time span of 366 days.
" }, { "info": { "name": "Get traces for a Room", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/rooms/:roomId/traces", "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", "description": "Room Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where reservation is searched based on reservation ID." } ] }, "docs": "This API will fetch the traces for a Room.OperationId:getTracesByRoom
" }, { "info": { "name": "Get a script", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/script", "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 where reservation is searched based on reservation ID." }, { "name": "languageCode", "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": "scriptType", "value": "", "type": "query", "description": "Used for Character Strings, length 0 to 40." }, { "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": "reservationIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "displayOffshoreRateInfo", "value": "", "type": "query", "description": "Indicates whether to display offshore rate information in the closing script or not." } ] }, "docs": "This API will get the script for your property.OperationId:getScript
" }, { "info": { "name": "Get sell messages ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/sellMessages/config", "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 where reservation is searched based on reservation ID." }, { "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": "message", "value": "", "type": "query", "description": "Sell Message text." }, { "name": "roomType", "value": "", "type": "query", "description": "Room Type." }, { "name": "ratePlanCode", "value": "", "type": "query", "description": "Rate Plan code." }, { "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": "blockIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "blockCode", "value": "", "type": "query", "description": "Block Code to query for." }, { "name": "languageCode", "value": "", "type": "query", "description": "Language code for the sell message." }, { "name": "croCode", "value": "", "type": "query", "description": "CRO code to query for." }, { "name": "displayDate", "value": "", "type": "query", "description": "The date on which the fetched sell message should be active." } ] }, "docs": "Fetch the existing sell message configuration for a property.OperationId:getSellMessageConfig
" }, { "info": { "name": "Create sell message", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/sellMessages/config", "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 where reservation is searched based on reservation ID." } ] }, "docs": "Create sell message configuration for a property.OperationId:postSellMessageConfig
" }, { "info": { "name": "Change sell message", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/sellMessages/config", "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 where reservation is searched based on reservation ID." } ] }, "docs": "Update the existing sell message configuration for a property.OperationId:putSellMessageConfig
" }, { "info": { "name": "Delete sell message", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/sellMessages/config", "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 where reservation is searched based on reservation ID." } ] }, "docs": "Delete an existing sell message configuration for a property.OperationId:deleteSellMessageConfig
" }, { "info": { "name": "Check overlapping stay", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/stay/action/validate", "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 where reservation is searched based on reservation ID." } ] }, "docs": "Validate overlapping staysOperationId:putValidateOverlappingStays
" }, { "info": { "name": "Register Turnaway", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/turnaways", "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 where reservation is searched based on reservation ID." } ] }, "docs": "Register turnaways for a property.OperationId:postTurnawayReservation
" }, { "info": { "name": "Get Future Reservations on a profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/reservations", "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": "profileId", "value": "", "type": "path", "description": "Unique OPERA internal profile ID which is used to find any type of profile from OPERA. This ID is a primary identification of a profile in OPERA." } ] }, "docs": "Use this API to identify whether there are future reservations or business block for the profile id.OperationId:getFutureReservationsOrBlocks
" }, { "info": { "name": "Get recently accessed Reservations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/recentlyAccessedReservations", "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": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "accessDate", "value": "", "type": "query", "description": "Indicates which date reservations to be returned" } ] }, "docs": "This API will return all recently accessed Reservations.OperationId:getRecentlyAccessedReservations
" }, { "info": { "name": "Get Reservations for a hotel", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reservations", "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": "recentlyAccessed", "value": "", "type": "query", "description": "Mark this reservation as recently accessed." }, { "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": "hotelIds", "value": "", "type": "query", "description": "List of Hotels to support searches with multiple resorts for which traces are to be fetched." }, { "name": "text", "value": "", "type": "query", "description": "Free form text field for searching all reservation fields" }, { "name": "reservationIdList", "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": "confirmationNumberList", "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": "cancellationNumberList", "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": "externalReferenceIds", "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": "externalSystemCodes", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "arrivalEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "arrivalStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "departureEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "departureStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "expectedArrivalStartTime", "value": "", "type": "query", "description": "The ending value of the time span. Uses the hotel's time zone." }, { "name": "expectedArrivalEndTime", "value": "", "type": "query", "description": "The starting value of the time span. Uses the hotel's time zone." }, { "name": "expectedReturnEndTime", "value": "", "type": "query", "description": "The ending value of the time span. Uses the hotel's time zone." }, { "name": "expectedReturnStartTime", "value": "", "type": "query", "description": "The starting value of the time span. Uses the hotel's time zone." }, { "name": "companyNames", "value": "", "type": "query", "description": "Attached profile name" }, { "name": "sourceNames", "value": "", "type": "query", "description": "Attached profile name" }, { "name": "travelAgentNames", "value": "", "type": "query", "description": "Attached profile name" }, { "name": "groupNames", "value": "", "type": "query", "description": "Attached profile name" }, { "name": "travelAgentIds", "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": "companyIds", "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": "sourceIds", "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": "contactIds", "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": "groupIds", "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": "billingContactIds", "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": "profileId", "value": "", "type": "query", "description": "Unique Identifier for a guest profile associated with the reservation(s)" }, { "name": "membershipCardNumber", "value": "", "type": "query", "description": "Membership ID criteria." }, { "name": "membershipLevels", "value": "", "type": "query" }, { "name": "membershipTypes", "value": "", "type": "query" }, { "name": "reservationsWithMembershipType", "value": "", "type": "query", "description": "When set to true, only reservations with a membership belonging to the specified membership type will be returned" }, { "name": "surname", "value": "", "type": "query", "description": "Family name, last name." }, { "name": "givenName", "value": "", "type": "query", "description": "Given name, first name or names" }, { "name": "anyVIPStatus", "value": "", "type": "query", "description": "VIP status of the customer." }, { "name": "vipCodes", "value": "", "type": "query", "description": "VIP status of the customer." }, { "name": "guaranteeCode", "value": "", "type": "query", "description": "Fetches the reservation having Guarantee Code(Reservation Type) supplied here." }, { "name": "paymentMethod", "value": "", "type": "query", "description": "Fetches the reservation having method of payment supplied here." }, { "name": "discountApplied", "value": "", "type": "query", "description": "Fetches the reservation for which discount is applied" }, { "name": "user", "value": "", "type": "query" }, { "name": "createdBy", "value": "", "type": "query", "description": "Fetches reservation created by specified user. If both CreatedByUsers and CreatedBy is specified, CreatedByUsers will take precedence." }, { "name": "cancelledByList", "value": "", "type": "query", "description": "Fetches reservations cancelled by list of users." }, { "name": "cancelledOn", "value": "", "type": "query", "description": "Fetches the reservations which are cancelled on a specific date." }, { "name": "ratePlanCodes", "value": "", "type": "query" }, { "name": "sourceCodes", "value": "", "type": "query" }, { "name": "marketCodes", "value": "", "type": "query" }, { "name": "excludeBlockReservations", "value": "", "type": "query", "description": "If true the search result will exclude the blocks reservations." }, { "name": "blockName", "value": "", "type": "query", "description": "The Name of the block that is attached to the reservation." }, { "name": "blockIds", "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": "blockCodes", "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": "customReference", "value": "", "type": "query", "description": "Custom reference" }, { "name": "recordLocator", "value": "", "type": "query", "description": "GDS Record Locator for reservation." }, { "name": "profileExternalReferencesToFetch", "value": "", "type": "query", "description": "Define the external system(s) to return external reference ids for associated profiles for the reservation. A maximum of 10 different external systems can be be provided for this parameter." }, { "name": "resvExternalReferencesToFetch", "value": "", "type": "query", "description": "Define the external system(s) to return external reference ids for reservations. A maximum of 10 different external systems can be be provided for this parameter." }, { "name": "orderBy", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" }, { "name": "roomAssignedOnly", "value": "", "type": "query", "description": "Indicator to query reservations which have a room number assigned." }, { "name": "roomUnassignedOnly", "value": "", "type": "query", "description": "Indicator to query reservations which does not have a room number assigned." }, { "name": "roomId", "value": "", "type": "query", "description": "Room number of the reservation to search by." }, { "name": "roomType", "value": "", "type": "query", "description": "Room Type." }, { "name": "roomFeatures", "value": "", "type": "query", "description": "A code representing a room feature." }, { "name": "roomSpecials", "value": "", "type": "query", "description": "Preference value for display purposes." }, { "name": "roomSmokingPreference", "value": "", "type": "query", "description": "Preference value for display purposes." }, { "name": "roomFloorPreferences", "value": "", "type": "query", "description": "Preference value for display purposes." }, { "name": "housekeepingRoomStatuses", "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": "roomClasses", "value": "", "type": "query" }, { "name": "roomRangeFrom", "value": "", "type": "query" }, { "name": "roomRangeTo", "value": "", "type": "query" }, { "name": "communication", "value": "", "type": "query", "description": "Any communication attached to the reservation from the primary guest's profile such as phone, fax or email address." }, { "name": "phone", "value": "", "type": "query", "description": "The phone number attached to the reservation from the primary guest's profile." }, { "name": "email", "value": "", "type": "query", "description": "The email address attached to the reservation from the primary guest's profile." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Instruction on which of the reservation's elements are to be returned. Instructions are cumulative i.e. if multiple instructions are sent in a request, then the combined reservation elements would be returned, elements will not be duplicated in the response." }, { "name": "allowedReservationActions", "value": "", "type": "query", "description": "Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation." }, { "name": "allowPreRegistration", "value": "", "type": "query", "description": "Flag containing true or false value for reservation to be eligible for prior check in by guest using mobile device. Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile check in yes / no. Upon fetch, the current state of the flag will show true or false." }, { "name": "hasDepositBalance", "value": "", "type": "query", "description": "Indicates that only reservations with deposit balance should be expected from the result." }, { "name": "hasOpenBalance", "value": "", "type": "query", "description": "Indicates that only reservations with open balance should 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": "includeScheduledCheckOut", "value": "", "type": "query", "description": "Criteria that indicates whether to scheduled checkouts or not." }, { "name": "linkedOnly", "value": "", "type": "query", "description": "Indicates that only linked reservations should be expected from the result." }, { "name": "unlinkedOnly", "value": "", "type": "query", "description": "Indicates that only unlinked reservations should be expected from the result." }, { "name": "actualArrivals", "value": "", "type": "query", "description": "Indicates if reservations which have already arrived on the Search Date is required." }, { "name": "actualDepartures", "value": "", "type": "query", "description": "Indicates if reservations which were expected to depart on the Search Date and have already checked, is required." }, { "name": "complimentaryReservations", "value": "", "type": "query", "description": "Indicates if reservations where rate codes are marked as Complimentary Rates , is required. This flag should be used in conjunction with the Arrivals, Departures or StayOvers criteria." }, { "name": "dayOfArrivalCancels", "value": "", "type": "query", "description": "Indicates if reservations which have cancelled on the Search Date which is also the day of arrival is required." }, { "name": "dayUse", "value": "", "type": "query", "description": "Indicates if reservations which are day use reservation on the Search Date, is required." }, { "name": "earlyDepartures", "value": "", "type": "query", "description": "Indicates if reservations which checked out early on the Search Date, is required." }, { "name": "expectedArrivals", "value": "", "type": "query", "description": "Indicates if reservations which are expected arrivals for the Search Date and who have not yet arrived, is required." }, { "name": "expectedDepartures", "value": "", "type": "query", "description": "Indicates if reservations which are expected departures for the Search Date and who have not yet departed, is required." }, { "name": "extendedStays", "value": "", "type": "query", "description": "Indicates if reservations which have extended their stays on the Search Date, is required." }, { "name": "houseUseReservations", "value": "", "type": "query", "description": "Indicates if reservations where rate codes are marked as House Use Rates , is required. This flag should be used in conjunction with the Arrivals, Departures or StayOvers criteria." }, { "name": "stayovers", "value": "", "type": "query", "description": "Indicates if reservations which are StayOvers on the Search Date, is required." }, { "name": "stayDate", "value": "", "type": "query", "description": "Date for searching the reservations. This is the date for which the search types are applicable. If date is not available, the business date will be used by default." }, { "name": "roomRoutingId", "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": "excludePseudoRoomReservations", "value": "", "type": "query", "description": "Indicates to exclude Pseudo room reservations." }, { "name": "excludeReservationIds", "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": "excludeVIPStatusCodes", "value": "", "type": "query", "description": "VIP status of the customer." }, { "name": "excludeSpecials", "value": "", "type": "query", "description": "Preference value for display purposes." }, { "name": "excludeFloorPreferences", "value": "", "type": "query", "description": "Preference value for display purposes." }, { "name": "excludeAdvanceCheckedIn", "value": "", "type": "query", "description": "Indicates to exclude Advance Checked In Reservations from search result." }, { "name": "excludeRoomFeatures", "value": "", "type": "query", "description": "Exclude the reservation(s) with provided room features from the search result." }, { "name": "playerId", "value": "", "type": "query", "description": "Player ID associated to the reservation." }, { "name": "gamingBalanceFrom", "value": "", "type": "query", "description": "Balance from." }, { "name": "gamingBalanceTo", "value": "", "type": "query", "description": "Balance to." }, { "name": "compAccountingBalanceFrom", "value": "", "type": "query", "description": "Comp Balance From" }, { "name": "compAccountingBalanceTo", "value": "", "type": "query", "description": "Comp Balance To" }, { "name": "searchTypes", "value": "", "type": "query", "description": "Represents Reservation search type Player Snapshot." }, { "name": "reservationStatuses", "value": "", "type": "query", "description": "Reservation status type for reservations search." }, { "name": "transportationCodes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "roomReadyStatuses", "value": "", "type": "query", "description": "Enum to denote the Status of Readiness messages sent to Guest Devices." }, { "name": "checkoutMessageReceived", "value": "", "type": "query", "description": "Fetches the reservations for which Checkout Message is received." }, { "name": "optedForCommunication", "value": "", "type": "query", "description": "Fetches the reservations for which reservation communication has been opted." }, { "name": "createdOn", "value": "", "type": "query", "description": "Fetches reservations which were created on the given property business date." }, { "name": "stayOn", "value": "", "type": "query", "description": "Fetches all reservations that are scheduled to stay over the selected date." }, { "name": "contactNames", "value": "", "type": "query", "description": "Name of Contact Profile associated with Reservation." }, { "name": "taRecordLocatorList", "value": "", "type": "query", "description": "Travel Agent Record Locators List." }, { "name": "guaranteeCodes", "value": "", "type": "query", "description": "Fetches the reservation having Guarantee Codes(Reservation Type) supplied here. Example guaranteeCodes=6PM" }, { "name": "linkedName", "value": "", "type": "query", "description": "Name of the group of Linked Reservations to be searched." }, { "name": "backToBackOnly", "value": "", "type": "query", "description": "Indicates that only reservations marked as Back to Back should be expected in the result." }, { "name": "backToBackDateOn", "value": "", "type": "query", "description": "Fetches linked Back to Back reservations with the specified Back to Back Date. Fetched reservations will be marked as Back to Back and they will either depart or arrive on the specified Back to Back day." }, { "name": "scheduledRoomMoveDate", "value": "", "type": "query", "description": "Scheduled Move Rooms Date Criteria. This will parameter be mandatory when Search Type is ScheduledRoomMove." }, { "name": "scheduledRoomMoveStartTime", "value": "", "type": "query", "description": "Start of Scheduled Move Room Time Range Criteria (in 24 hour time format). Applicable when Search Type is ScheduledRoomMove. Uses the hotel's time zone." }, { "name": "scheduledRoomMoveEndTime", "value": "", "type": "query", "description": "End of Scheduled Move Room Time Range Criteria (in 24 hour time format). Applicable when Search Type is ScheduledRoomMove. Uses the hotel's time zone." }, { "name": "scheduledRoomMoveStatus", "value": "", "type": "query", "description": "Scheduled Move Room Status Criteria." }, { "name": "checkInInitiatedBy", "value": "", "type": "query", "description": "This indicates who initiated the Check In/Advance Check In.Advance Check In functionality is available when the Advance Check In OPERA Control is active." }, { "name": "flexChar", "value": "", "type": "query", "description": "Search by User Defined Character Field. Available to be used when searchType = Arrival, Arrived, InHouse, Departure or CheckedOut. Format for searching by User Defined Character field is UDFCXX:OperationId:getReservations
" }, { "info": { "name": "Get Reservation indicators", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reservations/indicators", "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": "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": "hotelId", "value": "", "type": "query", "description": "Hotel code of each reservation ID. If more than one reservation id is requested from multiple hotels, this is needed to identify per reservation id. Example reservationId=123&hotelId=PROP1&reservationId=456&hotelId=PROP2" }, { "name": "checkInstructions", "value": "", "type": "query", "description": "Simple type that corresponds to check reservation instructions." } ] }, "docs": "Get Reservation indicators.OperationId:getReservationIndicators
" }, { "info": { "name": "Link Reservations By Chain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/reservations/linkedReservations/: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", "description": "Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA." } ] }, "docs": "This will allow you to link 1 or more reservations to an existing reservation.OperationId:postReservationLinksByChain
" }, { "info": { "name": "Remove Reservation Links By Chain", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/reservations/linkedReservations/: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", "description": "Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is a primary identification of a reservation in OPERA." } ] }, "docs": "Use this API to unlink a reservation from its currently associated reservation.OperationId:deleteReservationLinksByChain
" }, { "info": { "name": "Search Reservations for a hotel", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/reservations/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": "" } ] }, "docs": "This API will allow a user to retrieve a list of reservations based on the search criteria specified in the request body. For example you can search for reservations using query parameters like first name, last name, arrival/departure date, external confirmation number.OperationId:searchReservations
" }, { "info": { "name": "Delete a Reservation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/reservations/: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", "description": "Unique OPERA reservation ID which is used to find reservation from OPERA. This ID is to delete only an on hold (in-session) reservation." } ] }, "docs": "This API will delete only an on hold (in-session) reservation.OperationId:deleteReservation
" }, { "info": { "name": "Split multi room Reservation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/reservations/:reservationId/split", "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." } ] }, "docs": "You can use this API to split a multi room reservation. This will create a new confirmation number for the split reservation.OperationId:putSplitMultiRoomReservation
" }, { "info": { "name": "Get sell messages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sellMessages", "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": "croCode", "value": "", "type": "query", "description": "This is the Central Reservation office code." }, { "name": "hotelId", "value": "", "type": "query", "description": "This is the hotel code or resort." }, { "name": "criteriaId", "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": "criteriaIdType", "value": "", "type": "query", "description": "This is the language code." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "ratePlanCode", "value": "", "type": "query", "description": "This represents the rate plan code of the room type." }, { "name": "roomType", "value": "", "type": "query", "description": "This represents the room type code." }, { "name": "stickyFlagYn", "value": "", "type": "query", "description": "Flag which tells if this message is Sticky (Y/N)." }, { "name": "criteriaType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Instruction to fetch all Room Type sell messages configured." }, { "name": "usedInModule", "value": "", "type": "query", "description": "This represents the moduleType of the SellMessages to be fetched." } ] }, "docs": "Fetch the configured sell messages for a property.OperationId:getSellMessages
" }, { "info": { "name": "Get sell messages by chain", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sellMessages/config", "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": "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": "message", "value": "", "type": "query", "description": "Sell Message text." }, { "name": "roomType", "value": "", "type": "query", "description": "Room Type." }, { "name": "ratePlanCode", "value": "", "type": "query", "description": "Rate Plan code." }, { "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": "blockIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "blockCode", "value": "", "type": "query", "description": "Block Code to query for." }, { "name": "languageCode", "value": "", "type": "query", "description": "Language code for the sell message." }, { "name": "hotelIds", "value": "", "type": "query", "description": "Hotel code." }, { "name": "chainId", "value": "", "type": "query", "description": "Chain code to query for." }, { "name": "croCode", "value": "", "type": "query", "description": "CRO code to query for." }, { "name": "displayDate", "value": "", "type": "query", "description": "The date on which the fetched sell message should be active." } ] }, "docs": "Fetch the existing sell message configuration.OperationId:getSellMessageConfigByChain
" }, { "info": { "name": "Create sell message by chain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/sellMessages/config", "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": "Create sell message configuration.OperationId:postSellMessageConfigByChain
" }, { "info": { "name": "Change sell message by chain", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/sellMessages/config", "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": "Update the existing sell message configuration.OperationId:putSellMessageConfigByChain
" }, { "info": { "name": "Delete sell message by chain", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/sellMessages/config", "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": "sellMessageConfigId", "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." } ] }, "docs": "Delete an existing sell message configuration.OperationId:deleteSellMessageConfigByChain
" }, { "info": { "name": "Ping", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/services/reservations/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 reservation service versionOperationId:pingReservationService
" }, { "info": { "name": "Register Hub Turnaway", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/turnaways", "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": "Register Hub turnaways for a destination or multi-properties.OperationId:postHubTurnawayReservation
" } ] }, { "info": { "name": "ReservationExternal", "type": "folder" }, "items": [ { "info": { "name": "Ping", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/services/reservationExternal/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 version for Reservation External ServiceOperationId:pingReservationExternalService
" } ] } ], "bundled": true }