OperationId:getRegionalRateParity
" }, { "info": { "name": "Gets hotel room's restrictions and channel availability", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/channels/:channelCode/rooms/:roomTypeCode/inventorySnapshot", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "roomTypeCode", "value": "", "type": "path", "description": "Room Type Code." }, { "name": "channelCode", "value": "", "type": "path", "description": "Channel Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "fromDate", "value": "", "type": "query" }, { "name": "friday", "value": "", "type": "query" }, { "name": "monday", "value": "", "type": "query" }, { "name": "saturday", "value": "", "type": "query" }, { "name": "sunday", "value": "", "type": "query" }, { "name": "thursday", "value": "", "type": "query" }, { "name": "tuesday", "value": "", "type": "query" }, { "name": "wednesday", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" }, { "name": "snapshotLevel", "value": "", "type": "query", "description": "Indicates to evaluate statistics for house, channel, and room type level. Must include the specific booking channel in the search criteria." } ] }, "docs": "Operation to fetch the room availability and restrictions for a given property and room type in relation to channels.OperationId:getChannelInventorySnapshotByRoomType
" }, { "info": { "name": "Gets the General Availability", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/generalAvailabilitySimulator", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "bookingChannelCode", "value": "", "type": "query" }, { "name": "arrival", "value": "", "type": "query" }, { "name": "adults", "value": "", "type": "query" }, { "name": "nights", "value": "", "type": "query" }, { "name": "children", "value": "", "type": "query" }, { "name": "noOfRooms", "value": "", "type": "query" }, { "name": "channelRatePlanCode", "value": "", "type": "query" }, { "name": "rateAccessCode", "value": "", "type": "query" }, { "name": "corpIdIATA", "value": "", "type": "query" }, { "name": "inventoryBlockCode", "value": "", "type": "query" }, { "name": "promotionCode", "value": "", "type": "query" }, { "name": "currencyCode", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query" } ] }, "docs": "Use this API to fetch the General Availability Simulator.OperationId:getGeneralAvailabilitySimulator
" }, { "info": { "name": "Gets hotel's rooms and restrictions channel availability", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/inventorySnapshot", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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." }, { "name": "fromDate", "value": "", "type": "query" }, { "name": "friday", "value": "", "type": "query" }, { "name": "monday", "value": "", "type": "query" }, { "name": "saturday", "value": "", "type": "query" }, { "name": "sunday", "value": "", "type": "query" }, { "name": "thursday", "value": "", "type": "query" }, { "name": "tuesday", "value": "", "type": "query" }, { "name": "wednesday", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" }, { "name": "bookingChannelCodes", "value": "", "type": "query" }, { "name": "channelRoomTypes", "value": "", "type": "query" }, { "name": "snapshotLevel", "value": "", "type": "query", "description": "Indicates to evaluate statistics for house, channel, and room type level. Must include the specific booking channel in the search criteria." } ] }, "docs": "Operation to fetch the room availability and restrictions for a given property in relation to channels.OperationId:getChannelInventorySnapshot
" }, { "info": { "name": "Gets channel's rate configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/rateParity", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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." }, { "name": "comparisonType", "value": "", "type": "query", "description": "An enumerated type defining the Parity Comparison type. Values: FIRST_RATES, CHANNEL_RATES. CHANNEL_RATES requires HotelCode and BookingChannelCode as part of request." }, { "name": "language", "value": "", "type": "query", "description": "Language identification." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "numberOfDays", "value": "", "type": "query" }, { "name": "channelCode", "value": "", "type": "query" }, { "name": "roomType", "value": "", "type": "query" }, { "name": "ratePlanCode", "value": "", "type": "query" }, { "name": "channelRoomType", "value": "", "type": "query" }, { "name": "channelRatePlanCode", "value": "", "type": "query" }, { "name": "chainCode", "value": "", "type": "query" }, { "name": "rateAccessCode", "value": "", "type": "query" }, { "name": "inventoryBlockCode", "value": "", "type": "query" }, { "name": "promotionCode", "value": "", "type": "query" }, { "name": "qualifyingProfileCategory", "value": "", "type": "query" }, { "name": "qualifyingProfileId", "value": "", "type": "query" } ] }, "docs": "Operation to Fetch the Rate Parity. The rate parity search criteria can include room types, rate plans, promotion code, rate access code or chain codes.OperationId:getRateParity
" } ] }, { "info": { "name": "Channel", "type": "folder" }, "items": [ { "info": { "name": "Gets list of channels", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "inactive", "value": "", "type": "query", "description": "Indicates whether searching for active or inactive codes." }, { "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": "channelCode", "value": "", "type": "query", "description": "External system code to be searched. This is also known as Booking Channel Code for CHANNEL external system type." }, { "name": "systemType", "value": "", "type": "query", "description": "External system type to be searched. Possible values are CHANNEL, OXI, etc." }, { "name": "systemSubType", "value": "", "type": "query", "description": "External system sub type to be searched. Possible values are GDS, WEB, etc." }, { "name": "systemRateType", "value": "", "type": "query", "description": "External system rate type to be searched. Possible values are DAILY, MAX_WEEKLY, etc." }, { "name": "includeInactive", "value": "", "type": "query", "description": "Flag whether to include inactive channel or not." } ] }, "docs": "Use this API to get list of channels from OPERA.OperationId:getChannels
" }, { "info": { "name": "Adds new channel", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to add new channel code in OPERAOperationId:postChannels
" }, { "info": { "name": "Update channel configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to update channel configurationOperationId:putChannels
" }, { "info": { "name": "Deletes channel account contracts.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/account/contracts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "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": "id1", "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": "idExtension1", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "idContext1", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type1", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "This API deletes channel account contracts.OperationId:deleteChannelAccountContracts
" }, { "info": { "name": "Creates copy of channel account contracts", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/account/contracts/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": "" } ] }, "docs": "This API creates copy of channel account contracts.OperationId:copyChannelAccountContracts
" }, { "info": { "name": "This API retrieves channel accounts.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/accounts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "excludeInactive", "value": "", "type": "query", "description": "Indicator that tells whether to include inactive channel accounts or not." }, { "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": "hotelId", "value": "", "type": "query" }, { "name": "accountType", "value": "", "type": "query", "description": "Represents channel account TEMPLATE type." }, { "name": "accountName", "value": "", "type": "query", "description": "Account Name for which details need to be fetched." }, { "name": "accountCode", "value": "", "type": "query", "description": "Account Code/No for which details need to be fetched." }, { "name": "contractExpInDays", "value": "", "type": "query", "description": "To fetch channel accounts which expires in no., of days." }, { "name": "attributeName", "value": "", "type": "query" }, { "name": "orderType", "value": "", "type": "query" } ] }, "docs": "This API retrieves channel accounts.OperationId:getChannelAccounts
" }, { "info": { "name": "Adds channel accounts.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/accounts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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 adds channel accounts.OperationId:postChannelAccounts
" }, { "info": { "name": "Updates channel accounts", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/accounts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to update existing channel account for a given OPERA profile idOperationId:putChannelAccounts
" }, { "info": { "name": "Gets channel accounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/accounts/:accountProfileId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountProfileId", "value": "", "type": "path", "description": "Unique ID that identifies an account profile." }, { "name": "markAsRecentlyAccessed", "value": "", "type": "query", "description": "Providing this flag marks the billing account as recently accessed." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Channel account indicators information." } ] }, "docs": "Use this API to get existing channel account for a given OPERA profile id.OperationId:getChannelAccount
" }, { "info": { "name": "Adds channel account contracts for given profile Id.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/accounts/:accountProfileId/contracts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountProfileId", "value": "", "type": "path", "description": "Unique ID that identifies an account profile." } ] }, "docs": "This API adds channel account contracts for given profile Id.OperationId:postChannelAccountContracts
" }, { "info": { "name": "Updates channel account contracts for given profile Id.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/accounts/:accountProfileId/contracts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountProfileId", "value": "", "type": "path", "description": "Unique ID that identifies an account profile." } ] }, "docs": "Use this API to update existing cannel account contract for a given OPERA profile idOperationId:putChannelAccountContracts
" }, { "info": { "name": "Gets channel account contracts for given profile Id.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/accounts/:accountProfileId/contracts/:contractId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "contractId", "value": "", "type": "path", "description": "Contract Id." }, { "name": "accountProfileId", "value": "", "type": "path", "description": "Unique ID that identifies an account profile." }, { "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": "attributeName", "value": "", "type": "query" }, { "name": "orderType", "value": "", "type": "query" } ] }, "docs": "Use this API to get existing cannel account contract for a given OPERA profile id.OperationId:getChannelAccountContractElements
" }, { "info": { "name": "Adds channel amenities configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/amenities", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to add channel amenities mappingOperationId:postAmenitiesMapping
" }, { "info": { "name": "Updates channel amenities configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/amenities", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to update channel amenities mappingOperationId:putAmenitiesMapping
" }, { "info": { "name": "Deletes channel amenities configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/amenities", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "inactive", "value": "", "type": "query", "description": "Indicates whether code is inactive or not." }, { "name": "systemCode", "value": "", "type": "query", "description": "External system code such as TRAVELOCITY, EXPEDIA, etc." }, { "name": "systemSubType", "value": "", "type": "query", "description": "External system subtype such as GDS, WEB, etc." }, { "name": "systemType", "value": "", "type": "query", "description": "External system type such as CHANNEL, OXI, etc." }, { "name": "systemName", "value": "", "type": "query", "description": "External system name." }, { "name": "websiteURL", "value": "", "type": "query", "description": "Cannel Website URL" }, { "name": "iconURL", "value": "", "type": "query", "description": "Channel Icon URL" }, { "name": "localSystemCode", "value": "", "type": "query", "description": "Code used inside the OPERA System" }, { "name": "externalSystemCode", "value": "", "type": "query", "description": "Code used in the External System" }, { "name": "description", "value": "", "type": "query", "description": "Detailed Description of the given entity." }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" }, { "name": "amenityGroup", "value": "", "type": "query", "description": "User defined logical group name for the amenities." } ] }, "docs": "Use this API to delete channel amenities mappingOperationId:deleteAmenitiesMapping
" }, { "info": { "name": "Gets channel amenities configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/amenities/mapping", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "inactive", "value": "", "type": "query", "description": "Indicates whether searching for active or inactive codes." }, { "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": "systemCode", "value": "", "type": "query", "description": "External system code to be searched. This is also known as Booking Channel Code for CHANNEL external system type." }, { "name": "systemType", "value": "", "type": "query", "description": "External system type to be searched. Possible values are CHANNEL, OXI, etc." }, { "name": "systemSubType", "value": "", "type": "query", "description": "External system sub type to be searched. Possible values are GDS, WEB, etc." }, { "name": "systemRateType", "value": "", "type": "query", "description": "External system rate type to be searched. Possible values are DAILY, MAX_WEEKLY, etc." }, { "name": "localSystemCodes", "value": "", "type": "query" } ] }, "docs": "Use this API to get channel amenities mapping.OperationId:getAmenitiesMapping
" }, { "info": { "name": "Publishes channel availability.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/availability/publish", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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 changes publishes channel availability.OperationId:publishChannelAvailability
" }, { "info": { "name": "Retrieves channel billing statements.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/billingStatements", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "includeLocked", "value": "", "type": "query", "description": "Indicates whether search results should include locked statements or not. By default, locked statements will be included." }, { "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": "statementId", "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": "statementIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "beginDate", "value": "", "type": "query", "description": "Begin date of the statement." }, { "name": "endDate", "value": "", "type": "query", "description": "End date of the statement." }, { "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": "profileIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "This API retrieves channel billing statements.OperationId:getChannelBillingStatements
" }, { "info": { "name": "Adds channel billing statements.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/billingStatements", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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 adds channel billing statements.OperationId:postChannelBillingStatements
" }, { "info": { "name": "Updates channel billing statement details", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/billingStatements", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to update channels billing statements for a given OPERA statement idOperationId:putChannelBillingStatements
" }, { "info": { "name": "Deletes channel billing statements.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/billingStatements", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "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." } ] }, "docs": "This API deletes channel billing statements.OperationId:deleteChannelBillingStatements
" }, { "info": { "name": "This API generates channel billing statements.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/billingStatements/generate", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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 generates channel billing statements.OperationId:generateChannelBillingStatements
" }, { "info": { "name": "Retrieves channel billing statement for a given statement Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/billingStatements/:statementId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "statementId", "value": "", "type": "path", "description": "Statement Id." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "idType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "This API retrieves channel billing statement for a given statement Id.OperationId:getChannelBillingStatement
" }, { "info": { "name": "Retrieves channel billing statement details for a given statement Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/billingStatements/:statementId/details", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "statementId", "value": "", "type": "path", "description": "Statement 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": "contractId", "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": "contractIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "attributeName", "value": "", "type": "query" }, { "name": "orderType", "value": "", "type": "query" } ] }, "docs": "This API retrieves channel billing statement details for a given statement Id.OperationId:getChannelBillingStatementDetails
" }, { "info": { "name": "Retrieves billing statement details statistics.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/billingStatements/:statementId/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": "statementId", "value": "", "type": "path", "description": "Statement Id." }, { "name": "contractId", "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": "contractIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Type for statement details statistics instructions that can be used in requests for partial operations." } ] }, "docs": "This API retrieves billing statement details statistics.OperationId:getStatementDetailsStatistics
" }, { "info": { "name": "Gets channel credit card mapping for a hotel", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/cardType/mappings", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelIds", "value": "", "type": "query" }, { "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": "bookingChannelCodes", "value": "", "type": "query" }, { "name": "cardTypes", "value": "", "type": "query" }, { "name": "channelCardTypes", "value": "", "type": "query" }, { "name": "includeInactive", "value": "", "type": "query", "description": "Indicates whether search includes inactive mapping." }, { "name": "fetchUnmapped", "value": "", "type": "query", "description": "Indicates whether unmapped channel-hotel card types should be fetched." }, { "name": "fetchMapped", "value": "", "type": "query", "description": "Indicates whether mapped channel-hotel card types should be fetched." } ] }, "docs": "Use this API to get channel mapping for OPERA credit cards to channel for a given hotel id.OperationId:getChannelCardTypeMappings
" }, { "info": { "name": "Adds channel credit card mapping", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/cardTypes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to add channel mapping for OPERA Credit cardsOperationId:postCreditCardsMapping
" }, { "info": { "name": "Updates channel credit card mapping", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/cardTypes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to update channel credit card code mapping to OPERA credit card codeOperationId:putCreditCardsMapping
" }, { "info": { "name": "Deletes channel credit card mapping", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/cardTypes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "inactive", "value": "", "type": "query", "description": "Indicates whether code is inactive or not." }, { "name": "systemCode", "value": "", "type": "query", "description": "External system code such as TRAVELOCITY, EXPEDIA, etc." }, { "name": "systemSubType", "value": "", "type": "query", "description": "External system subtype such as GDS, WEB, etc." }, { "name": "systemType", "value": "", "type": "query", "description": "External system type such as CHANNEL, OXI, etc." }, { "name": "systemName", "value": "", "type": "query", "description": "External system name." }, { "name": "websiteURL", "value": "", "type": "query", "description": "Cannel Website URL" }, { "name": "iconURL", "value": "", "type": "query", "description": "Channel Icon URL" }, { "name": "localSystemCode", "value": "", "type": "query", "description": "Code used inside the OPERA System" }, { "name": "externalSystemCode", "value": "", "type": "query", "description": "Code used in the External System" }, { "name": "description", "value": "", "type": "query", "description": "Detailed Description of the given entity." }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" } ] }, "docs": "Use this API to delete channel credit card code mapping to OPERA credit card code.OperationId:deleteCreditCardsMapping
" }, { "info": { "name": "Gets channel credit card mapping", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/cardTypes/mapping", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "inactive", "value": "", "type": "query", "description": "Indicates whether searching for active or inactive codes." }, { "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": "systemCode", "value": "", "type": "query", "description": "External system code to be searched. This is also known as Booking Channel Code for CHANNEL external system type." }, { "name": "systemType", "value": "", "type": "query", "description": "External system type to be searched. Possible values are CHANNEL, OXI, etc." }, { "name": "systemSubType", "value": "", "type": "query", "description": "External system sub type to be searched. Possible values are GDS, WEB, etc." }, { "name": "systemRateType", "value": "", "type": "query", "description": "External system rate type to be searched. Possible values are DAILY, MAX_WEEKLY, etc." }, { "name": "localSystemCodes", "value": "", "type": "query" }, { "name": "includeInactive", "value": "", "type": "query", "description": "Indicates whether to include inactive guarantees or not." } ] }, "docs": "Use this API to get channel credit card code mapping to OPERA credit card code.OperationId:getCreditCardsMapping
" }, { "info": { "name": "Gets channel property confirmation letter mapping", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/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": "channelCode", "value": "", "type": "query" }, { "name": "hotelIds", "value": "", "type": "query" }, { "name": "language", "value": "", "type": "query", "description": "Language code associated with the hotel letters." }, { "name": "letterType", "value": "", "type": "query", "description": "Represents Inquiry Letter Type." } ] }, "docs": "Use this API to get channel property confirmation letter configurationOperationId:getChannelHotelLetters
" }, { "info": { "name": "Adds channel property confirmation letter mapping", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/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": "" } ] }, "docs": "Use this API to add channel property confirmation letter configurationOperationId:postChannelHotelLetters
" }, { "info": { "name": "Updates channel property confirmation letter mapping", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/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": "" } ] }, "docs": "Use this API to update channel property confirmation letter configurationOperationId:putChannelHotelLetters
" }, { "info": { "name": "Deletes channel property confirmation letter mapping", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/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": "code", "value": "", "type": "query", "description": "Code." }, { "name": "description", "value": "", "type": "query", "description": "description." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel code which the hotel letters belong to." }, { "name": "code1", "value": "", "type": "query", "description": "Code." }, { "name": "description1", "value": "", "type": "query", "description": "description." }, { "name": "letterType", "value": "", "type": "query", "description": "Represents Inquiry Letter Type." } ] }, "docs": "Use this API to delete channel property confirmation letter configuration.OperationId:deleteChannelHotelLetters
" }, { "info": { "name": "Adds channel currency code mapping", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/currencies", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to add channel currency code mapping to OPERA currency codes.OperationId:postCurrenciesMapping
" }, { "info": { "name": "Updates channel currency code mapping", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/currencies", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to update channel mapping to OPERA currency codesOperationId:putCurrenciesMapping
" }, { "info": { "name": "Deletes channel currency code mapping", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/currencies", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "inactive", "value": "", "type": "query", "description": "Indicates whether code is inactive or not." }, { "name": "systemCode", "value": "", "type": "query", "description": "External system code such as TRAVELOCITY, EXPEDIA, etc." }, { "name": "systemSubType", "value": "", "type": "query", "description": "External system subtype such as GDS, WEB, etc." }, { "name": "systemType", "value": "", "type": "query", "description": "External system type such as CHANNEL, OXI, etc." }, { "name": "systemName", "value": "", "type": "query", "description": "External system name." }, { "name": "websiteURL", "value": "", "type": "query", "description": "Cannel Website URL" }, { "name": "iconURL", "value": "", "type": "query", "description": "Channel Icon URL" }, { "name": "localSystemCode", "value": "", "type": "query", "description": "Code used inside the OPERA System" }, { "name": "externalSystemCode", "value": "", "type": "query", "description": "Code used in the External System" }, { "name": "description", "value": "", "type": "query", "description": "Detailed Description of the given entity." }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" }, { "name": "lanyonDecimalPosition", "value": "", "type": "query", "description": "Number of decimal positions used by the currency." }, { "name": "channelDecimalPosition", "value": "", "type": "query", "description": "Number of decimal positions used by the currency as per the channel." } ] }, "docs": "Use this API to delete channel mapping to OPERA currency codes.OperationId:deleteCurrenciesMapping
" }, { "info": { "name": "Gets channel currency code mapping", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/currencies/mapping", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "inactive", "value": "", "type": "query", "description": "Indicates whether searching for active or inactive codes." }, { "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": "systemCode", "value": "", "type": "query", "description": "External system code to be searched. This is also known as Booking Channel Code for CHANNEL external system type." }, { "name": "systemType", "value": "", "type": "query", "description": "External system type to be searched. Possible values are CHANNEL, OXI, etc." }, { "name": "systemSubType", "value": "", "type": "query", "description": "External system sub type to be searched. Possible values are GDS, WEB, etc." }, { "name": "systemRateType", "value": "", "type": "query", "description": "External system rate type to be searched. Possible values are DAILY, MAX_WEEKLY, etc." }, { "name": "localSystemCodes", "value": "", "type": "query" }, { "name": "includeInactive", "value": "", "type": "query", "description": "Indicates whether to include inactive guarantees or not." } ] }, "docs": "Use this API to update channel mapping to OPERA currency codes.OperationId:getCurrenciesMapping
" }, { "info": { "name": "Retrieves distribution templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/distributionTemplates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "isChain", "value": "", "type": "query", "description": "Filter chain level distribution templates by chain." }, { "name": "hotelIds", "value": "", "type": "query" }, { "name": "codes", "value": "", "type": "query" }, { "name": "types", "value": "", "type": "query" }, { "name": "includeInactive", "value": "", "type": "query", "description": "Indicates whether search includes inactive distribution templates." } ] }, "docs": "This API retrieves distribution templates.OperationId:getDistributionTemplates
" }, { "info": { "name": "Adds rate templates configurations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/distributionTemplates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to add a distribution rate template.OperationId:postDistributionTemplates
" }, { "info": { "name": "Updates rate templates configurations", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/distributionTemplates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to update existing distribution rate templateOperationId:putDistributionTemplates
" }, { "info": { "name": "Deletes rate templates configurations", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/distributionTemplates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "codes", "value": "", "type": "query" }, { "name": "code", "value": "", "type": "query", "description": "Configuration code." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel where the code is configured." } ] }, "docs": "Use this API to delete existing distribution rate template.OperationId:deleteDistributionTemplates
" }, { "info": { "name": "Deletes channel error codes", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/errorCodes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "bookingChannelCode", "value": "", "type": "query", "description": "Booking channel code of error." }, { "name": "error", "value": "", "type": "query", "description": "Code of error." } ] }, "docs": "Use this API to delete channel error code mapping configurations.OperationId:deleteChannelErrors
" }, { "info": { "name": "Adds channel guarantee code mapping", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/guarantees", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to add channel's guarantee codes mapping to OPERA guarantee codes.OperationId:postGuaranteesMapping
" }, { "info": { "name": "Updates channel guarantee code mapping", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/guarantees", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to update channel's guarantee codes mapping to OPERA guarantee codesOperationId:putGuaranteesMapping
" }, { "info": { "name": "Deletes channel guarantee code mapping", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/guarantees", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "inactive", "value": "", "type": "query", "description": "Indicates whether code is inactive or not." }, { "name": "systemCode", "value": "", "type": "query", "description": "External system code such as TRAVELOCITY, EXPEDIA, etc." }, { "name": "systemSubType", "value": "", "type": "query", "description": "External system subtype such as GDS, WEB, etc." }, { "name": "systemType", "value": "", "type": "query", "description": "External system type such as CHANNEL, OXI, etc." }, { "name": "systemName", "value": "", "type": "query", "description": "External system name." }, { "name": "websiteURL", "value": "", "type": "query", "description": "Cannel Website URL" }, { "name": "iconURL", "value": "", "type": "query", "description": "Channel Icon URL" }, { "name": "localSystemCode", "value": "", "type": "query", "description": "Code used inside the OPERA System" }, { "name": "externalSystemCode", "value": "", "type": "query", "description": "Code used in the External System" }, { "name": "description", "value": "", "type": "query", "description": "Detailed Description of the given entity." }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" }, { "name": "requirementCode", "value": "", "type": "query", "description": "Requirement code of guarantee." } ] }, "docs": "Use this API to delete channel's guarantee codes mapping to OPERA guarantee codes.OperationId:deleteGuaranteesMapping
" }, { "info": { "name": "Gets channel guarantee code mapping for a hotel", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/guarantees/mapping", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "inactive", "value": "", "type": "query", "description": "Indicates whether searching for active or inactive codes." }, { "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": "systemCode", "value": "", "type": "query", "description": "External system code to be searched. This is also known as Booking Channel Code for CHANNEL external system type." }, { "name": "systemType", "value": "", "type": "query", "description": "External system type to be searched. Possible values are CHANNEL, OXI, etc." }, { "name": "systemSubType", "value": "", "type": "query", "description": "External system sub type to be searched. Possible values are GDS, WEB, etc." }, { "name": "systemRateType", "value": "", "type": "query", "description": "External system rate type to be searched. Possible values are DAILY, MAX_WEEKLY, etc." }, { "name": "localSystemCodes", "value": "", "type": "query" }, { "name": "includeInactive", "value": "", "type": "query", "description": "Indicates whether to include inactive guarantees or not." } ] }, "docs": "Use this API to get channel guarantee code mapping to OPERA guarantee code for a given hotel.OperationId:getGuaranteesMapping
" }, { "info": { "name": "Adds channel hotel mapping", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/hotels", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to add channel mapping to OPERA hotel id including channel hotel code, room sell limit per reservation, city code, end date.OperationId:postHotelsMapping
" }, { "info": { "name": "Updates channel hotel mapping", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/hotels", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to update channel mapping to OPERA hotel id including channel hotel code, room sell limit per reservation, city code, end dateOperationId:putHotelsMapping
" }, { "info": { "name": "Deletes channel hotel mapping", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/hotels", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "inactive", "value": "", "type": "query", "description": "Indicates whether code is inactive or not." }, { "name": "systemCode", "value": "", "type": "query", "description": "External system code such as TRAVELOCITY, EXPEDIA, etc." }, { "name": "systemSubType", "value": "", "type": "query", "description": "External system subtype such as GDS, WEB, etc." }, { "name": "systemType", "value": "", "type": "query", "description": "External system type such as CHANNEL, OXI, etc." }, { "name": "systemName", "value": "", "type": "query", "description": "External system name." }, { "name": "websiteURL", "value": "", "type": "query", "description": "Cannel Website URL" }, { "name": "iconURL", "value": "", "type": "query", "description": "Channel Icon URL" }, { "name": "localSystemCode", "value": "", "type": "query", "description": "Code used inside the OPERA System" }, { "name": "externalSystemCode", "value": "", "type": "query", "description": "Code used in the External System" }, { "name": "description", "value": "", "type": "query", "description": "Detailed Description of the given entity." }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" }, { "name": "city", "value": "", "type": "query", "description": "City code of the channel hotel." }, { "name": "roomLimit", "value": "", "type": "query", "description": "Maximum room limit for the channel hotel reservation." }, { "name": "bookingLimit", "value": "", "type": "query", "description": "Booking limit used by ADS interface for booking limit upload. Available if channel type is ADS and ADS ARI is enabled." }, { "name": "hotelChainId", "value": "", "type": "query", "description": "Hotel chain ID of channel-hotel mapping. Only available for UA channel. It may not be modified if in myfidelio environment, and user is for a specific hotel." }, { "name": "chainCode", "value": "", "type": "query", "description": "Chain code for the channel-hotel mapping." }, { "name": "prevailingRates", "value": "", "type": "query", "description": "Prevailing rates flag of channel-hotel mapping. Available if PREVAILING_RATE_BY_LOS parameter is on." }, { "name": "aRIEnabled", "value": "", "type": "query", "description": "ADS ARI enabled flag of channel-hotel mapping. Available only if channel type is ADS." }, { "name": "addOnLicense", "value": "", "type": "query", "description": "External system Add-on license. This is mandatory when Channel Type is ADS." }, { "name": "available", "value": "", "type": "query", "description": "Flag indicating if channel resort mapping is available." }, { "name": "defaultRateCode", "value": "", "type": "query", "description": "Default rate code to be used to calculate the total revenue." }, { "name": "defaultRateCode1", "value": "", "type": "query", "description": "Default rate code of channel hotel." }, { "name": "lowRevenueThreshold", "value": "", "type": "query", "description": "Low revenue threshold." }, { "name": "highRevenueThreshold", "value": "", "type": "query", "description": "High revenue threshold." } ] }, "docs": "Use this API to delete channel mapping to OPERA hotel id including channel hotel code, room sell limit per reservation, city code, end date.OperationId:deleteHotelsMapping
" }, { "info": { "name": "Gets channel hotel mapping", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/hotels/mapping", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "inactive", "value": "", "type": "query", "description": "Indicates whether searching for active or inactive codes." }, { "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": "systemCode", "value": "", "type": "query", "description": "External system code to be searched. This is also known as Booking Channel Code for CHANNEL external system type." }, { "name": "systemType", "value": "", "type": "query", "description": "External system type to be searched. Possible values are CHANNEL, OXI, etc." }, { "name": "systemSubType", "value": "", "type": "query", "description": "External system sub type to be searched. Possible values are GDS, WEB, etc." }, { "name": "systemRateType", "value": "", "type": "query", "description": "External system rate type to be searched. Possible values are DAILY, MAX_WEEKLY, etc." }, { "name": "localSystemCodes", "value": "", "type": "query" }, { "name": "includeInactive", "value": "", "type": "query", "description": "Indicates whether to include inactive guarantees or not." } ] }, "docs": "Use this API to get channel mapping to OPERA hotel id including channel hotel code, room sell limit per reservation, city code, end date.OperationId:getHotelsMapping
" }, { "info": { "name": "Gets channel marketing messages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/marketingText", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "transactionType", "value": "", "type": "query" }, { "name": "policyType", "value": "", "type": "query" }, { "name": "policyDetail", "value": "", "type": "query" }, { "name": "beginDate", "value": "", "type": "query" }, { "name": "filterHotelIds", "value": "", "type": "query" }, { "name": "bookingChannelCode", "value": "", "type": "query" }, { "name": "transactionTypes", "value": "", "type": "query" }, { "name": "policyTypesPolicyType", "value": "", "type": "query" }, { "name": "policyDetailPolicyDetail", "value": "", "type": "query" }, { "name": "showGlobal", "value": "", "type": "query" }, { "name": "includeInactive", "value": "", "type": "query", "description": "Include or not include inactive channel marketing text." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Simple type for channel fetch instruction." }, { "name": "hotelIds", "value": "", "type": "query", "description": "Hotel code." }, { "name": "channelCode", "value": "", "type": "query" } ] }, "docs": "Use this API to get channel mapping for marketing messages.OperationId:getChannelMarketingText
" }, { "info": { "name": "Adds channel marketing messages", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/marketingText", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to add channel mapping for marketing messagesOperationId:postChannelMarketingText
" }, { "info": { "name": "Updates channel marketing messages", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/marketingText", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to update channel mapping for marketing messagesOperationId:putChannelMarketingText
" }, { "info": { "name": "Deletes channel marketing messages", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/marketingText", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "beginDate", "value": "", "type": "query" }, { "name": "bookingChannelCode", "value": "", "type": "query", "description": "The code that identifies a Booking Channel." }, { "name": "endDate", "value": "", "type": "query" }, { "name": "globalTextYN", "value": "", "type": "query" }, { "name": "hotelId", "value": "", "type": "query", "description": "The code that identifies a Hotel." }, { "name": "marketingText", "value": "", "type": "query" }, { "name": "policyDetail", "value": "", "type": "query" }, { "name": "policyType", "value": "", "type": "query" }, { "name": "transactionType", "value": "", "type": "query" }, { "name": "newHotelId", "value": "", "type": "query" }, { "name": "newTransactionType", "value": "", "type": "query" }, { "name": "newPolicyType", "value": "", "type": "query" }, { "name": "newPolicyDetail", "value": "", "type": "query" }, { "name": "newBeginDate", "value": "", "type": "query" } ] }, "docs": "Use this API to delete channel mapping for marketing messages.OperationId:deleteChannelMarketingText
" }, { "info": { "name": "Allows to copy marketing message to another channel and hotel", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/marketingText/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": "" } ] }, "docs": "Use this API to copy one channel's mapping for marketing messages to another channel and hotel mapping.OperationId:copyChannelMarketingText
" }, { "info": { "name": "Gets channel negotiate rate", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/negotiatedRates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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": "hotelId", "value": "", "type": "query" }, { "name": "bookingChannelCode", "value": "", "type": "query" }, { "name": "channelRatePlanCode", "value": "", "type": "query" }, { "name": "accessCode", "value": "", "type": "query" }, { "name": "uniqueId", "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": "uniqueIdType", "value": "", "type": "query" } ] }, "docs": "Use this API to update channel's negotiated rate code mapping including negotiated profile, negotiate rate access code, start date, end date, and sequence.OperationId:getChannelNegotiatedRate
" }, { "info": { "name": "Adds channel negotiate rate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/negotiatedRates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to add channel's negotiated rate code mapping with an OPERA profile for a given hotel idOperationId:postChannelNegotiatedRate
" }, { "info": { "name": "Updates channel negotiate rate", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/negotiatedRates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to update channel's negotiated rate code mapping including negotiated profile, negotiate rate access code, start date, end date, and sequence.OperationId:putChannelNegotiatedRate
" }, { "info": { "name": "Deletes channel negotiate rate", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/negotiatedRates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "bookingChannelCode", "value": "", "type": "query", "description": "Booking Channel Code." }, { "name": "channelRatePlanCode", "value": "", "type": "query", "description": "Channel Room Type." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel Code." }, { "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": "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": "externalSystem", "value": "", "type": "query", "description": "When name type is external, indicates the external system the name belongs to." }, { "name": "language", "value": "", "type": "query", "description": "Language code associated with an alternate name." }, { "name": "nameType", "value": "", "type": "query", "description": "Person's name in an external system." }, { "name": "namePrefix", "value": "", "type": "query", "description": "Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)" }, { "name": "givenName", "value": "", "type": "query", "description": "Given name, first name or names." }, { "name": "middleName", "value": "", "type": "query", "description": "The middle name of the person name." }, { "name": "surname", "value": "", "type": "query", "description": "Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name." }, { "name": "nameSuffix", "value": "", "type": "query", "description": "Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)" }, { "name": "nameTitle", "value": "", "type": "query", "description": "Degree or honors (e.g., Ph.D., M.D.)" }, { "name": "nameTitleSuffix", "value": "", "type": "query", "description": "Title Suffix. Must be populated if ADVANCED_TITLE is on." }, { "name": "envelopeGreeting", "value": "", "type": "query", "description": "Envelope Greeting of the profile" }, { "name": "salutation", "value": "", "type": "query", "description": "Salutation of the profile" }, { "name": "accessCode", "value": "", "type": "query" }, { "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": "newAccessCode", "value": "", "type": "query" }, { "name": "channelRatePlanCodeOrder", "value": "", "type": "query" }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" } ] }, "docs": "Use this API to update channel's negotiated rate code mapping including negotiated profile, negotiate rate access code, start date, end date, and sequence.OperationId:deleteChannelNegotiatedRate
" }, { "info": { "name": "Deletes given channel's rate categories", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/rateCategories", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "bookingChannelCodes", "value": "", "type": "query", "description": "Booking channel code of rate category." }, { "name": "rateCategories", "value": "", "type": "query", "description": "Code of rate category." } ] }, "docs": "Use this API to delete channel rate categories for a given channel.OperationId:deleteChannelRateCategories
" }, { "info": { "name": "Deletes channel rate level", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/rateLevels", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "bookingChannelCodes", "value": "", "type": "query", "description": "Booking channel code of rate level." }, { "name": "rateLevels", "value": "", "type": "query", "description": "Code of rate level." } ] }, "docs": "Use this API to delete channel rate level code's description.OperationId:deleteChannelRateLevels
" }, { "info": { "name": "Gets channel property rate mapping", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/rates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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": "hotelId", "value": "", "type": "query" }, { "name": "channelCode", "value": "", "type": "query" }, { "name": "ratePlanCodes", "value": "", "type": "query" }, { "name": "channelRatePlanCodes", "value": "", "type": "query" }, { "name": "ratePlanCategories", "value": "", "type": "query" }, { "name": "channelRatePlanCategories", "value": "", "type": "query" }, { "name": "includeUnmappedRatePlans", "value": "", "type": "query", "description": "Flag whether to include unmapped rate codes." }, { "name": "onlyUnmappedRatePlans", "value": "", "type": "query", "description": "Flag whether to include unmapped rate codes only." }, { "name": "includeInactiveMappings", "value": "", "type": "query", "description": "Flag whether to include inactive mappings." }, { "name": "onlyNegotiatedRates", "value": "", "type": "query", "description": "Flag whether to include negotiated rate mappings only." } ] }, "docs": "Use this API to get channel property rate mapping including channel rate code, start date, end date, rate level, channel rate description.OperationId:getChannelRateMapping
" }, { "info": { "name": "Adds channel property rate mapping", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/rates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to add channel property rate mapping with OPERA hotel rateOperationId:postChannelRateMapping
" }, { "info": { "name": "Updates channel property rate mapping", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/rates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to update channel property rate mapping including channel rate code, start date, end date, rate level, channel rate description.OperationId:putChannelRateMapping
" }, { "info": { "name": "Deletes channel property rate mapping", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/rates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "bookingChannelCode", "value": "", "type": "query", "description": "Booking Channel Code." }, { "name": "channelRatePlanCode", "value": "", "type": "query", "description": "Channel Room Type." }, { "name": "hasChannelNegotiatedRates", "value": "", "type": "query", "description": "True if the mapping has channel negotiated rates, otherwise false." }, { "name": "hasNegotiatedRates", "value": "", "type": "query", "description": "True if this channel rate plan code has negotiated rates, otherwise false" }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel Code." }, { "name": "ratePlanCode", "value": "", "type": "query", "description": "Room Type." } ] }, "docs": "Use this API to delete channel property rate mapping including channel rate code, start date, end date, rate level, channel rate description.OperationId:deleteChannelRateMapping
" }, { "info": { "name": "Gets global rate descriptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/rates/globalDescriptions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelIds", "value": "", "type": "query" }, { "name": "ratePlanCodes", "value": "", "type": "query" }, { "name": "roomTypes", "value": "", "type": "query" }, { "name": "globalDescriptionType", "value": "", "type": "query", "description": "Either Room Type or Rate Plan Code" } ] }, "docs": "Use this API to get global rate description for given hotel id.OperationId:getChannelRatesGlobalDescriptions
" }, { "info": { "name": "Adds global room descriptions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/rates/globalDescriptions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to adds global room description for given hotel id and room type codeOperationId:postChannelRatesGlobalDescriptions
" }, { "info": { "name": "Updates global rate descriptions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/rates/globalDescriptions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to update global rate description for given hotel id and rate codeOperationId:putChannelRatesGlobalDescriptions
" }, { "info": { "name": "Deletes global rate descriptions", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/rates/globalDescriptions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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": "Property mapping with Rate plan code or Room type" }, { "name": "code", "value": "", "type": "query", "description": "Code." }, { "name": "description", "value": "", "type": "query", "description": "description." }, { "name": "code1", "value": "", "type": "query", "description": "Code." }, { "name": "description1", "value": "", "type": "query", "description": "description." }, { "name": "globalDescType", "value": "", "type": "query", "description": "Either Room Type or Rate Plan Code" } ] }, "docs": "Use this API to delete global rate description for given hotel id and rate code.OperationId:deleteChannelRatesGlobalDescriptions
" }, { "info": { "name": "Updates channel property rateroom sequence", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/rates/roomSequence", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to update sequence for given channel property rate room mappingOperationId:putChannelRateRoomSeq
" }, { "info": { "name": "Publishes channel restrictions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/restrictions/publish", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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 changes the channel restrictions.OperationId:publishChannelRestrictions
" }, { "info": { "name": "Delete channel configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/roomTypes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "bookingChannelCodes", "value": "", "type": "query", "description": "Booking channel code of room type." }, { "name": "roomTypes", "value": "", "type": "query", "description": "Code of room type." } ] }, "docs": "Use this API to delete channel configuration.OperationId:deleteChannelRoomTypes
" }, { "info": { "name": "Adds channel property room mapping", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/rooms", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to add channel room mapping to OPERA hotel's room.OperationId:postChannelRoomMapping
" }, { "info": { "name": "Updates channel room configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/rooms", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to update channel room descriptionOperationId:manageChannelRoomMapping
" }, { "info": { "name": "Update global descriptions for a room", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/rooms/globalDescription", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to update OPERA room's global description for global distribution type channelsOperationId:putRoomDescription
" }, { "info": { "name": "Gets global room descriptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/rooms/globalDescriptions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelIds", "value": "", "type": "query" }, { "name": "ratePlanCodes", "value": "", "type": "query" }, { "name": "roomTypes", "value": "", "type": "query" }, { "name": "globalDescriptionType", "value": "", "type": "query", "description": "Either Room Type or Rate Plan Code" } ] }, "docs": "Use this API to get global room description for given hotel id and room type code.OperationId:getChannelRoomsGlobalDescriptions
" }, { "info": { "name": "Adds global rate descriptions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/rooms/globalDescriptions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to add global rate description for given hotel id and rate codeOperationId:postChannelRoomsGlobalDescriptions
" }, { "info": { "name": "Updates global room descriptions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/rooms/globalDescriptions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to update global room description for given hotel id and room type codeOperationId:putChannelRoomsGlobalDescriptions
" }, { "info": { "name": "Deletes global room descriptions", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/rooms/globalDescriptions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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": "Property mapping with Rate plan code or Room type" }, { "name": "code", "value": "", "type": "query", "description": "Code." }, { "name": "description", "value": "", "type": "query", "description": "description." }, { "name": "code1", "value": "", "type": "query", "description": "Code." }, { "name": "description1", "value": "", "type": "query", "description": "description." }, { "name": "globalDescType", "value": "", "type": "query", "description": "Either Room Type or Rate Plan Code" } ] }, "docs": "Use this API to delete global room description for given hotel id and room type code.OperationId:deleteChannelRoomsGlobalDescriptions
" }, { "info": { "name": "Deletes sub channel configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/subChannels", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "bookingChannelCodes", "value": "", "type": "query", "description": "Booking channel code of carrier." }, { "name": "carriers", "value": "", "type": "query", "description": "Code of carrier." } ] }, "docs": "Use this API to delete sub-channel (carrier) configuration for a given channel code.OperationId:deleteChannelCarriers
" }, { "info": { "name": "Gets channel detail", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/:channelCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "includeInactive", "value": "", "type": "query", "description": "Indicates whether fetch should include inactive codes or not." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Simple type for external system instructions that can be used in requests for partial operations." } ] }, "docs": "This API retrieves channel information for the given channel code.OperationId:getChannel
" }, { "info": { "name": "Adds channel error codes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/:channelCode/errorCodes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." } ] }, "docs": "Use this API to add channel error code mapping configurationsOperationId:postChannelErrors
" }, { "info": { "name": "Updates channel error codes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/:channelCode/errorCodes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." } ] }, "docs": "Use this API to update channel error code mapping configurationsOperationId:putChannelErrors
" }, { "info": { "name": "Get channel hotel mappings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/:channelCode/hotels", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "hotelId", "value": "", "type": "query", "description": "OPERA hotel code for which mapped channel hotel code should be fetched." }, { "name": "channelHotelCode", "value": "", "type": "query", "description": "Channel hotel code for which mapped OPERA hotel code should be fetched." } ] }, "docs": "Use this API to get the channel mappings to the OPERA hotel id, including hotel details for channel hotel code, room sell limit per reservation, city code and end date.OperationId:getChannelHotelCodeMapping
" }, { "info": { "name": "Updates channel control settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/:channelCode/parameters", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." } ] }, "docs": "Use this API to active/inactive channel controls. It also allows to update channel control settings.OperationId:putChannelParameters
" }, { "info": { "name": "Adds given channel's rate categories", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/:channelCode/rateCategories", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." } ] }, "docs": "Use this API to add channel rate categories for a given channel.OperationId:postChannelRateCategories
" }, { "info": { "name": "Updates given channel's rate categories", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/:channelCode/rateCategories", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." } ] }, "docs": "Use this API to update channel rate categories for a given channel.OperationId:putChannelRateCategories
" }, { "info": { "name": "Adds channel rate level", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/:channelCode/rateLevels", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." } ] }, "docs": "Use this API to add channel rate level configurationsOperationId:postChannelRateLevels
" }, { "info": { "name": "Updates channel rate level", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/:channelCode/rateLevels", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." } ] }, "docs": "Use this API to update channel rate level code's descriptionOperationId:putChannelRateLevels
" }, { "info": { "name": "Publishes channel rate plan codes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/:channelCode/ratePlans", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." } ] }, "docs": "This API changes the channel rate plans for given channel code.OperationId:publishChannelRatePlans
" }, { "info": { "name": "Gets channel property rateroom sequence", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/:channelCode/rateRoomSequences", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "ratePlanCode", "value": "", "type": "query", "description": "Hotel Rate Plan Code." }, { "name": "roomType", "value": "", "type": "query", "description": "Hotel Room Type." }, { "name": "channelRatePlanCode", "value": "", "type": "query", "description": "Channel Rate Plan Code." }, { "name": "channelRoomType", "value": "", "type": "query", "description": "Channel Room Type." }, { "name": "channelRateRoomParameterName", "value": "", "type": "query", "description": "Enumeration of the different parameters Channel Rate Room accepts." }, { "name": "channelRateRoomParameterValue", "value": "", "type": "query" } ] }, "docs": "Use this API to get sequence for given channel property rate room mapping.OperationId:getChannelRateRoomSeq
" }, { "info": { "name": "Updates global descriptions for a rate", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/:channelCode/rates/:channelRateCode/globalDescription", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelRateCode", "value": "", "type": "path", "description": "Channel Rate Code." }, { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." } ] }, "docs": "Use this API to update OPERA rate's global description for global distribution type channelsOperationId:putRateGlobalDescription
" }, { "info": { "name": "Adds channel room", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/:channelCode/roomTypes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." } ] }, "docs": "Use this API to add channel room configurationOperationId:postChannelRoomTypes
" }, { "info": { "name": "Updates channel room", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/:channelCode/roomTypes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." } ] }, "docs": "Use this API to update channel room descriptionOperationId:putChannelRoomTypes
" }, { "info": { "name": "Adds sub channel configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/:channelCode/subChannels", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." } ] }, "docs": "Use this API to add sub-channel (carrier) configuration for a given channel codeOperationId:postChannelCarriers
" }, { "info": { "name": "Updates sub channel configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/:channelCode/subChannels", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." } ] }, "docs": "Use this API to update sub-channel (carrier) configuration for a given channel codeOperationId:putChannelCarriers
" }, { "info": { "name": "Adds channel tenants.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/channels/:channelCode/tenants", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." } ] }, "docs": "This API adds channel tenants.OperationId:postChannelOrgMapping
" }, { "info": { "name": "Retrieves channel tenants mapping.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/channels/:channelCode/tenants/:tenantCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "tenantCode", "value": "", "type": "path", "description": "Tenant Code." }, { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "chainCode", "value": "", "type": "query", "description": "Chain code for which channel code and org code are mapped." } ] }, "docs": "This API retrieves channel tenants mapping.OperationId:getChannelOrgMapping
" }, { "info": { "name": "Updates channel tenants mapping.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/channels/:channelCode/tenants/:tenantCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "tenantCode", "value": "", "type": "path", "description": "Tenant Code." }, { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." } ] }, "docs": "This API changes channel tenants mapping.OperationId:putChannelOrgMapping
" }, { "info": { "name": "Deletes channel tenants mapping.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/channels/:channelCode/tenants/:tenantCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "tenantCode", "value": "", "type": "path", "description": "Tenant Code." }, { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "chainCode", "value": "", "type": "query", "description": "Chain code for which channel code and org code are mapped." } ] }, "docs": "This API deletes channel tenants mapping.OperationId:deleteChannelOrgMapping
" }, { "info": { "name": "Gets channel negotiate rate", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/clusters/:clusterId/channels/negotiatedRates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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": "clusterId", "value": "", "type": "path", "description": "ClusterId in URI path" }, { "name": "hotelIds", "value": "", "type": "query" }, { "name": "channelCode", "value": "", "type": "query" }, { "name": "channelRateCode", "value": "", "type": "query" }, { "name": "ratePlanCode", "value": "", "type": "query" }, { "name": "accessCode", "value": "", "type": "query" }, { "name": "includeInactive", "value": "", "type": "query" }, { "name": "internalChannelsOnly", "value": "", "type": "query", "description": "If true then it would fetch only the internal channels. If false then it expects channelCode as well to establish if its an internal or external channel." }, { "name": "uniqueId", "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": "uniqueIdType", "value": "", "type": "query" } ] }, "docs": "Use this API to update channel's negotiated rate code mapping including negotiated profile, negotiate rate access code, start date, end date, and sequence.OperationId:getChannelNegotiatedRates
" }, { "info": { "name": "Initiate profile rate access codes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/clusters/:clusterId/channels/profileRatesAccess", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "ClusterId in URI path." } ] }, "docs": "OperationId: putProfileNegRateAccessCodes
Operation to Initiate profile rate access codes
" }, { "info": { "name": "Delete Channel Rates Access for cluster level", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/clusters/:clusterId/channels/profileRatesAccessDeletes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "ClusterId in URI path." } ] }, "docs": "operationId:deleteProfileNegRateAccessCodes
Delete Channel Rates Access for cluster level
" }, { "info": { "name": "Sync profile rate access codes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/clusters/:clusterId/channels/syncProfileRatesAccess", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "clusterId", "value": "", "type": "path", "description": "ClusterId in URI path." } ] }, "docs": "OperationId: syncProfileNegRateAccessCodes
Operation to Initiate profile rate access codes
" }, { "info": { "name": "Adds total pricing tax and fee types", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/totalPricing", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to add global distribution channels tax and fee configurations.OperationId:postTotalPricingElements
" }, { "info": { "name": "Updates total pricing tax and fee types", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/totalPricing", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Use this API to update global distribution channels tax and fee configurationsOperationId:putTotalPricingElements
" }, { "info": { "name": "Deletes total pricing tax and fee types", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/totalPricing", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 that associated with Transaction Code and Total Pricing Element" }, { "name": "code", "value": "", "type": "query", "description": "Code." }, { "name": "description", "value": "", "type": "query", "description": "description." } ] }, "docs": "Use this API to delete global distribution channels tax and fee configurations.OperationId:deleteTotalPricingElements
" }, { "info": { "name": "Allows to copy total pricing tax and fees to another hotel id", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/totalPricing/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": "" } ] }, "docs": "Use this API to copy global distribution system's fee and tax configurations from one hotel to another hotel within same chain/tenantOperationId:copyTotalPricingElements
" }, { "info": { "name": "Gets channel guarantee code mappings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/channels/guarantees", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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." }, { "name": "hotelIds", "value": "", "type": "query", "description": "Hotel code." }, { "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": "bookingChannelCodes", "value": "", "type": "query" }, { "name": "guaranteeCode", "value": "", "type": "query" }, { "name": "channelGuaranteeCode", "value": "", "type": "query" }, { "name": "includeInactive", "value": "", "type": "query", "description": "Indicates whether search includes inactive mapping." }, { "name": "fetchUnmapped", "value": "", "type": "query", "description": "Indicates whether unmapped channel-hotel guarantee code should be fetched." }, { "name": "fetchMapped", "value": "", "type": "query", "description": "Indicates whether mapped channel-hotel guarantee code should be fetched." } ] }, "docs": "Use this API to get the list of the channel guarantee code mappings to the OPERA guarantee codes.OperationId:getChannelGuaranteeCodeMappings
" }, { "info": { "name": "Publishes channel hotel rate plan codes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/channels/ratePlans", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 changes the channel rate plans for given Hotel Id.OperationId:publishHotelChannelRatePlans
" }, { "info": { "name": "Distributes channel rate mappings to channel room types", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/channels/rates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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": "Use this API to link (distribute) channel a rate code to channel room types.OperationId:postChannelRates
" }, { "info": { "name": "Gets total pricing tax and fee types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/channels/totalPricing", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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." }, { "name": "hotelIds", "value": "", "type": "query", "description": "Hotel code." }, { "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": "elementCodes", "value": "", "type": "query" }, { "name": "transactionCodes", "value": "", "type": "query" } ] }, "docs": "Use this API to get global distribution channels tax and fee configurations.OperationId:getTotalPricingElements
" }, { "info": { "name": "Adds channel credit card mapping for a hotel", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/channels/:channelCode/cardType/:cardTypeCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cardTypeCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "Use this API to add channel mapping for OPERA credit cards to channel for a given hotel idOperationId:postChannelCardTypeMapping
" }, { "info": { "name": "Updates channel credit card mapping for a hotel", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/channels/:channelCode/cardType/:cardTypeCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cardTypeCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "Use this API to update channel mapping for OPERA credit cards to channel for a given hotel idOperationId:putChannelCardTypeMapping
" }, { "info": { "name": "Deletes channel credit card mapping for a hotel", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/channels/:channelCode/cardType/:cardTypeCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cardTypeCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "channelCardType", "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": "Use this API to delete channel mapping for OPERA credit cards to channel for a given hotel id.OperationId:deleteChannelCardTypeMapping
" }, { "info": { "name": "Adds channel guarantee code mapping for a hotel", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/channels/:channelCode/guarantees/:guaranteeCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "guaranteeCode", "value": "", "type": "path", "description": "Guarantee Code." }, { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "Use this API to add channel guarantee code mapping to OPERA guarantee code for a given hotelOperationId:postChannelGuaranteeCodeMapping
" }, { "info": { "name": "Updates channel guarantee code mapping for a hotel", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/channels/:channelCode/guarantees/:guaranteeCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "guaranteeCode", "value": "", "type": "path", "description": "Guarantee Code." }, { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "Use this API to update channel guarantee code mapping to OPERA guarantee code for a given hotelOperationId:putChannelGuaranteeCodeMapping
" }, { "info": { "name": "Deletes channel guarantee code mapping for a hotel", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/channels/:channelCode/guarantees/:guaranteeCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "guaranteeCode", "value": "", "type": "path", "description": "Guarantee Code." }, { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "channelGuaranteeCode", "value": "", "type": "query", "description": "Channel Guarantee Code." } ] }, "docs": "Use this API to delete channel guarantee code mapping to OPERA guarantee code for a given property.OperationId:deleteChannelGuaranteeCodeMapping
" }, { "info": { "name": "Retrieves channel parameters.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/channels/:channelCode/parameters", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "parameterNameWildCard", "value": "", "type": "query", "description": "Parameter for wild card search on channel parameters." } ] }, "docs": "Use this API to get list of channel parameters and their settings.OperationId:getChannelParameters
" }, { "info": { "name": "Retrieves the channel policies", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/channels/:channelCode/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": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "requestType", "value": "", "type": "query" }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" }, { "name": "channelRatePlanCode", "value": "", "type": "query" }, { "name": "channelRoomTypeCode", "value": "", "type": "query" }, { "name": "ratePlanCode", "value": "", "type": "query" }, { "name": "roomTypeCode", "value": "", "type": "query" }, { "name": "corporateId", "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": "corporateIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "Use this API to retrieve channel policies mapping.OperationId:getChannelPolicies
" }, { "info": { "name": "Distributes channel room rate mappings.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/channels/:channelCode/rooms/:channelRoomType/rates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelRoomType", "value": "", "type": "path", "description": "Channel Room Type." }, { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "Use this API to link (distribute) channel a room type to channel rate codes.OperationId:postChannelRoomTypeRate
" }, { "info": { "name": "Gets channel room mapping by room type", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/channels/:channelCode/rooms/:roomTypeCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "roomTypeCode", "value": "", "type": "path", "description": "Room Type Code." }, { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "beginDate", "value": "", "type": "query", "description": "Begin Date." }, { "name": "channelRoomType", "value": "", "type": "query", "description": "Channel Room Type." } ] }, "docs": "This API retrieves channel room mapping by room type.OperationId:getChannelRoomMappingById
" }, { "info": { "name": "Updates channel property room mapping", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/channels/:channelCode/rooms/:roomTypeCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "roomTypeCode", "value": "", "type": "path", "description": "Room Type Code." }, { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "Use this API to update channel room mapping to OPERA hotel's room mapping including channel room type code, start date, end date, room order.OperationId:putChannelRoomMapping
" }, { "info": { "name": "Deletes channel property room mapping", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/channels/:channelCode/rooms/:roomTypeCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "roomTypeCode", "value": "", "type": "path", "description": "Room Type Code." }, { "name": "channelCode", "value": "", "type": "path", "description": "Unique ID that identifies a channel." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "beginDate", "value": "", "type": "query", "description": "Begin Date." }, { "name": "channelRoomType", "value": "", "type": "query", "description": "Channel Room Type." }, { "name": "endDate", "value": "", "type": "query", "description": "End date of the hotel-channel room type mapping." } ] }, "docs": "Use this API to delete channel room mapping to OPERA hotel's room mapping including channel room type code, start date, end date, room order.OperationId:deleteChannelRoomMapping
" }, { "info": { "name": "Gets global rate descriptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/rates/:ratePlanCode/globalDescription", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "Use this API to get global rate description for given hotel id and rate code.OperationId:getChannelRateCodeGlobalDesc
" }, { "info": { "name": "Gets channel property room mapping", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/rooms/mapping", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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." }, { "name": "hotelIds", "value": "", "type": "query", "description": "Hotel code." }, { "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": "bookingChannelCodes", "value": "", "type": "query" }, { "name": "roomTypes", "value": "", "type": "query" }, { "name": "channelRoomTypes", "value": "", "type": "query" }, { "name": "includeInactiveMappings", "value": "", "type": "query", "description": "Flag whether to include inactive mappings or not." }, { "name": "includeUnmappedRoomTypes", "value": "", "type": "query", "description": "Flag whether to include unmapped room types or not." }, { "name": "onlyUnmappedRoomTypes", "value": "", "type": "query", "description": "Flag whether to include mapped room types only." } ] }, "docs": "Use this API to get channel room mapping to OPERA hotel's room mapping including channel room type code, start date, end date, room order.OperationId:getChannelRoomMapping
" }, { "info": { "name": "Gets global room descriptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/rooms/:roomType/globalDescription", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "roomType", "value": "", "type": "path", "description": "Room type." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "Use this API to get global room description for given hotel id and room type code.OperationId:getChannelRoomTypeGlobalDesc
" }, { "info": { "name": "Retrieves channel service version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/services/channels/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": "This API retrieves channel service version.OperationId:pingChannelService
" } ] }, { "info": { "name": "Inventory", "type": "folder" }, "items": [ { "info": { "name": "Gets sell limit detail for a given channel hotel combination", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/channel/sellLimits", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 channel sell limits is searched." }, { "name": "fromDate", "value": "", "type": "query", "description": "Sell limits which exist at or beyond this date will be fetched." }, { "name": "bookingChannelCode", "value": "", "type": "query", "description": "Channel for which the sell limits are to be fetched." }, { "name": "channelRoomType", "value": "", "type": "query", "description": "Channel room type for which the sell limits are to be fetched." } ] }, "docs": "Use this API to retrieve channel sell limit detail to get or review daily sell limits for a given hotel-channel combination.OperationId:getChannelSellLimits
" }, { "info": { "name": "Updates channel sell limits by date", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/channelSellLimits", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 channel sell limits are updated by date." } ] }, "docs": "Use this API to update channel property sell limit mapping by given dates.OperationId:changeChannelSellLimitsByDate
" }, { "info": { "name": "Deletes channel sell limits", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/channelSellLimits/:Id", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "Id", "value": "", "type": "path", "description": "Unique ID of the channel sell limit to be deleted." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where channel sell limits is deleted." } ] }, "docs": "Use this API to delete channel property sell limit mapping.OperationId:deleteChannelSellLimits
" }, { "info": { "name": "Updates channel sell limits by daterange", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/channels/:channelId/channelSellLimitsByDateRange", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "channelId", "value": "", "type": "path", "description": "Unique ID of the channel for which sell limits are updated by date range." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel where channel sell limits are updated by date range." } ] }, "docs": "Use this API to update channel property sell limit mapping by given date range.OperationId:changeChannelSellLimitsByDateRange
" } ] } ], "bundled": true }