{ "opencollection": "1.0.0", "info": { "name": "OPERA Cloud Event Configuration API", "version": "26.2.0.0" }, "items": [ { "info": { "name": "ResourceConfig", "type": "folder" }, "items": [ { "info": { "name": "Copy event forecasts", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/EventForecasts/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 will allow you to copy an Event Forecast from a property to another.

OperationId:copyEventForecasts

" }, { "info": { "name": "Get catering containers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cateringContainers", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "fetchInactive", "value": "", "type": "query", "description": "Determines wether to fetch inactive records or not." }, { "name": "codes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "wildCard", "value": "", "type": "query", "description": "Wildcard search on the code." }, { "name": "description", "value": "", "type": "query", "description": "Description of the code." } ] }, "docs": "This API allows you to retrieve all existing Menu Item Catering Container codes.

OperationId:getCateringContainers

" }, { "info": { "name": "Create catering containers", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cateringContainers", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "Menu Item Catering Containers describe how individual menu item are sold (for example, per piece, per dozen, or each) when they are not included in the price of the menu. The description prints on reports such as the Banquet Event Order (BEO) and Proforma Invoice. This API allows you to create a new Menu Item Catering Container code and description.

OperationId:postCateringContainers

" }, { "info": { "name": "Change catering containers", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/cateringContainers/:cateringContainersCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringContainersCode", "value": "", "type": "path", "description": "Unique Catering Container Code" } ] }, "docs": "This API allows you to update an existing Menu Item Catering Container code.

OperationId:putCateringContainers

" }, { "info": { "name": "Delete Catering container", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/cateringContainers/:cateringContainersCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringContainersCode", "value": "", "type": "path", "description": "Unique Catering Container Code" } ] }, "docs": "This API allows you to delete an existing Menu Item Catering Container code.

OperationId:deleteCateringContainers

" }, { "info": { "name": "Get catering item rates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cateringItemRates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "fetchInactive", "value": "", "type": "query", "description": "Determines wether to fetch inactive records or not." }, { "name": "codes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "wildCard", "value": "", "type": "query", "description": "Wildcard search on the code." }, { "name": "description", "value": "", "type": "query", "description": "Description of the code." } ] }, "docs": "Retrieve catering item rates

OperationId:getCateringItemRates

" }, { "info": { "name": "Create Catering Item rates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cateringItemRates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Create Catering Item rates

OperationId:postCateringItemRates

" }, { "info": { "name": "Change catering item rates", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/cateringItemRates/:cateringItemRatesCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringItemRatesCode", "value": "", "type": "path", "description": "Unique Catering Item Rates Codes" } ] }, "docs": "Change catering item rates code

OperationId:putCateringItemRates

" }, { "info": { "name": "Remove catering item rates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/cateringItemRates/:cateringItemRatesCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringItemRatesCode", "value": "", "type": "path", "description": "Unique Catering Item Rates Codes" } ] }, "docs": "Remove catering item rates code

OperationId:deleteCateringItemRates

" }, { "info": { "name": "Create menu classes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cateringMenuClasses", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "You can use this API to create menu classes.

OperationId:postCateringMenuClasses

" }, { "info": { "name": "Update catering menu classes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/cateringMenuClasses", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Update catering menu classes

OperationId:putCateringMenuClasses

" }, { "info": { "name": "Create menu item classes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cateringMenuItemClasses", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "You can use this API to create menu item classes.

OperationId:postCateringMenuItemClasses

" }, { "info": { "name": "Update menu item classes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/cateringMenuItemClasses/:cateringMenuItemClassesCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringMenuItemClassesCode", "value": "", "type": "path", "description": "Unique Menu Item Class Id" } ] }, "docs": "You can use this API to update menu item classes.

OperationId:putCateringMenuItemClasses

" }, { "info": { "name": "Delete menu item classes", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/cateringMenuItemClasses/:cateringMenuItemClassesCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringMenuItemClassesCode", "value": "", "type": "path", "description": "Unique Menu Item Class ID" }, { "name": "menuItemClassesIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "menuItemClassesIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "menuItemClassesUniqueIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "You can use this API to delete menu item classes.

OperationId:deleteCateringMenuItemClasses

" }, { "info": { "name": "Copy menu item classes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/cateringMenuItemClasses/:cateringMenuItemClassesCode/copy", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringMenuItemClassesCode", "value": "", "type": "path", "description": "Unique Menu Item Class Id" } ] }, "docs": "You can use this API to copy menu item classes.

OperationId:copyCateringMenuItemClasses

" }, { "info": { "name": "Operation to remove catering menu items by chain.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/cateringMenuItems/:cateringMenuItemId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringMenuItemId", "value": "", "type": "path", "description": "Unique Catering Menu Item Id" }, { "name": "hotelId", "value": "", "type": "query", "description": "The Hotel code which the Catering Menu Items belongs to." } ] }, "docs": "

OperationId:deleteCateringMenuItemsByChain

" }, { "info": { "name": "Delete catering package resources", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/cateringPackageResources", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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": "The Hotel code which the Catering Package Event belongs to." }, { "name": "pkgEventId", "value": "", "type": "query", "description": "Unique Packages Event ID" }, { "name": "pkgEventIdType", "value": "", "type": "query", "description": "Unique Packages Event Type" }, { "name": "resourceId", "value": "", "type": "query", "description": "Unique Resources ID" }, { "name": "pkgEventIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "pkgEventIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "pkgEventType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "Use this API to delete catering package resources.

OperationId:deleteCateringPackageResources

" }, { "info": { "name": "Fetch catering packages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cateringPackages", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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": "hotelIds", "value": "", "type": "query" }, { "name": "packageCode", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query", "description": "Revenue Types for which details are to be fetched." }, { "name": "duration", "value": "", "type": "query", "description": "Duration for which the event is scheduled." }, { "name": "webBookable", "value": "", "type": "query", "description": "Defines if web booking is allowed." }, { "name": "pkgTmpltType", "value": "", "type": "query", "description": "It represents Catering Packages and Templates both." }, { "name": "marketCode", "value": "", "type": "query", "description": "Market Code associated with the price details of the Package." }, { "name": "priceCode", "value": "", "type": "query", "description": "Price Code for which details are to be fetched." }, { "name": "minAttendees", "value": "", "type": "query", "description": "Minimum Attendees." }, { "name": "maxAttendees", "value": "", "type": "query", "description": "Maximum Attendees." }, { "name": "sellDate", "value": "", "type": "query", "description": "Selling Date associated with the Price Details." }, { "name": "startDateTime", "value": "", "type": "query" }, { "name": "endDateTime", "value": "", "type": "query" }, { "name": "bookingType", "value": "", "type": "query", "description": "Collection of configured Booking Types for the package property." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Fetch instructions that can be used in Catering Packages maintenance." } ] }, "docs": "Fetch existing Catering Packages.

OperationId:getCateringPackagesMultiProperties

The maximum allowable limit for this API is 25.

This API allows a time span of 90 days.

" }, { "info": { "name": "Get catering package by chain", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cateringPackages/:cateringPackageId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringPackageId", "value": "", "type": "path", "description": "Unique Catering Package ID" }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel code of Catering Package to be fetched." }, { "name": "idExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "pkgIDType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Fetch instructions that can be used in Catering Packages maintenance." } ] }, "docs": "Use this API to get catering package.

OperationId:getCateringPackageByChain

" }, { "info": { "name": "Get catering servings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cateringServings", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "fetchInactive", "value": "", "type": "query", "description": "Determines wether to fetch inactive records or not." }, { "name": "servingCodes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "wildCard", "value": "", "type": "query", "description": "Wildcard search on the code." }, { "name": "description", "value": "", "type": "query", "description": "Description of the code." } ] }, "docs": "Get catering servings

OperationId:getCateringServings

" }, { "info": { "name": "Update catering servings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/cateringServings/:cateringServingsCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringServingsCode", "value": "", "type": "path", "description": "Unique Catering Sevrings Code" } ] }, "docs": "Update catering servings

OperationId:putCateringServings

" }, { "info": { "name": "Create event forecasts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/eventForecasts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "You can define Event Forecasts, with or without a market code or a block type, to manage different revenue forecasts for different types of bookings, such as corporate versus social. This API will allow you to create a new Event Forecast.

OperationId:postEventForecasts

" }, { "info": { "name": "Update Event forecasts", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/eventForecasts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "This API will allow you to update an Event Forecast for a property.

OperationId:putEventForecasts

" }, { "info": { "name": "Delete event forecasts", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/eventForecasts/:forecastsId/eventTypes/:eventTypesCode/eventForecasts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "eventTypesCode", "value": "", "type": "path", "description": "Unique Event Type Code" }, { "name": "forecastsId", "value": "", "type": "path", "description": "Unique Forecast Id" }, { "name": "forecastIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "forecastIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "forecastIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel Code to which the Event Forecast belongs to." }, { "name": "revenueTypeCode", "value": "", "type": "query", "description": "Code." }, { "name": "revenueTypeDescription", "value": "", "type": "query", "description": "description." }, { "name": "amount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "amountType", "value": "", "type": "query", "description": "Defines values for Amount Type of an event forecast revenue." } ] }, "docs": "This API will allow you to delete an Event Forecast for a property.

OperationId:deleteEventForecasts

" }, { "info": { "name": "Get menu classes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/cateringMenuClasses", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 OPERA Hotel 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": "className", "value": "", "type": "query", "description": "The name of Menu Class." }, { "name": "webBookable", "value": "", "type": "query", "description": "If true this boolean will set the criteria to only return Menu Classes configured as Web Bookable." }, { "name": "includeMenus", "value": "", "type": "query", "description": "If true this boolean will set the criteria to fetch associated menu for the menu classes." }, { "name": "inactive", "value": "", "type": "query", "description": "If true this boolean will set the criteria to only return Menu Classes configured as Inactive." } ] }, "docs": "Get menu classes for a property.

OperationId:getCateringMenuClasses

The maximum allowable limit for this API is 25.

" }, { "info": { "name": "Get menu item classes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/cateringMenuItemClasses", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 OPERA Hotel 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": "className", "value": "", "type": "query", "description": "Menu Item class name search filter." }, { "name": "menuTypes", "value": "", "type": "query", "description": "Defines values for Menu Type" }, { "name": "webBookable", "value": "", "type": "query", "description": "Indicates if web bookable." }, { "name": "includeMenuItems", "value": "", "type": "query", "description": "MenuItemClassInfo MenuItemInfo values can be passed as per requirement" }, { "name": "inactive", "value": "", "type": "query", "description": "If true this boolean will set the criteria to only return Menu Item Classes configured as Inactive." } ] }, "docs": "Get menu item classes for a property.

OperationId:getCateringMenuItemClasses

The maximum allowable limit for this API is 25.

" }, { "info": { "name": "Get Menu items", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/cateringMenuItems", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 OPERA Hotel 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": "name", "value": "", "type": "query", "description": "Menu item name of string length 30" }, { "name": "codes", "value": "", "type": "query" }, { "name": "quickInsertCode", "value": "", "type": "query", "description": "Article number of Menu Item in Caps" }, { "name": "listTypeCodes", "value": "", "type": "query" }, { "name": "inactive", "value": "", "type": "query", "description": "If true this boolean will set the criteria to only return Menu Items configured as Inactive." }, { "name": "eventTypesCodes", "value": "", "type": "query" }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Fetch instructions that can be used in Fetching Catering Menus Items. SummaryInfo fetchInstruction is used to fetch limited set of Menu Item information required for Menu Items Panel Drawer and DetailsInfo returns detailed information required for Menu Items listing screen." } ] }, "docs": "Get Menu items for a property.

OperationId:getCateringMenuItems

The maximum allowable limit for this API is 200.

" }, { "info": { "name": "Create menu items", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/cateringMenuItems", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 OPERA Hotel Id" } ] }, "docs": "You can use this API to create menu items.

OperationId:postCateringMenuItems

" }, { "info": { "name": "Operation to copy catering menu items.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/cateringMenuItems/copy", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel Id" } ] }, "docs": "

OperationId:copyCateringMenuItems

" }, { "info": { "name": "Update menu items", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/cateringMenuItems/:cateringMenuItemId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringMenuItemId", "value": "", "type": "path", "description": "Unique Catering Menu Item Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel Id" } ] }, "docs": "You can use this API to update menu items.

OperationId:putCateringMenuItems

" }, { "info": { "name": "Operation to remove catering menu items.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/cateringMenuItems/:cateringMenuItemId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringMenuItemId", "value": "", "type": "path", "description": "Unique Catering Menu Item Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel Id" } ] }, "docs": "

OperationId:deleteCateringMenuItems

" }, { "info": { "name": "Create/Update menu items", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/upsert/hotels/:hotelId/cateringMenuItems", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 OPERA Hotel Id" } ] }, "docs": "You can use this API to create/update menu items.

OperationId:putUpsertCateringMenuItems

" }, { "info": { "name": "Get menus", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/cateringMenus", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 OPERA Hotel 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": "menuId", "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": "menuIDType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "name", "value": "", "type": "query", "description": "This type holds name of Menu Class." }, { "name": "classNameListCodes", "value": "", "type": "query" }, { "name": "eventTypesCodes", "value": "", "type": "query" }, { "name": "menuTypes", "value": "", "type": "query", "description": "Defines values for Menu Type" }, { "name": "dietaryListCodes", "value": "", "type": "query" }, { "name": "inactive", "value": "", "type": "query", "description": "If true, only Composed Menu's marked as Inactive in Menu Configuration will be returned." }, { "name": "multiChoice", "value": "", "type": "query", "description": "When selected Only Composed Menu's noted as Multi Choice in Menu Configuration will be returned." }, { "name": "webBookable", "value": "", "type": "query", "description": "Check of Menu if it is web bookable" }, { "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": "fetchInstructions", "value": "", "type": "query", "description": "Fetch instructions that can be used in Catering Menus maintenance." } ] }, "docs": "Retrieve a list of menus for a property.

OperationId:getCateringMenus

The maximum allowable limit for this API is 200.

This API allows a time span of 90 days.

" }, { "info": { "name": "Create menus", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/cateringMenus", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 OPERA Hotel ID" } ] }, "docs": "Create menus for a property.

OperationId:postCateringMenus

" }, { "info": { "name": "Get menu", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/cateringMenus/:cateringMenuId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringMenuId", "value": "", "type": "path", "description": "Unique ID of Catering Menu" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel ID" }, { "name": "inactive", "value": "", "type": "query", "description": "If true, only Composed Menu's marked as Inactive in Menu Configuration will be returned." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Fetch instructions that can be used in Catering Menus maintenance." } ] }, "docs": "Retrieve details of a Catering menu

OperationId:getCateringMenu

" }, { "info": { "name": "Operation to change catering menus.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/cateringMenus/:cateringMenuId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringMenuId", "value": "", "type": "path", "description": "Unique ID of Catering Menu" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel ID" } ] }, "docs": "

OperationId:putCateringMenus

" }, { "info": { "name": "Delete a menu", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/cateringMenus/:cateringMenuId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringMenuId", "value": "", "type": "path", "description": "Unique ID of Catering Menu" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel ID" } ] }, "docs": "Delete a menu from a property.

OperationId:deleteCateringMenus

" }, { "info": { "name": "Copy a menu", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/cateringMenus/:cateringMenuId/copy", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringMenuId", "value": "", "type": "path", "description": "Unique ID of Catering Menu" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel Id" } ] }, "docs": "Copy a menu for a property.

OperationId:copyCateringMenus

" }, { "info": { "name": "Operation to create/change catering menus.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/upsert/hotels/:hotelId/cateringMenus", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 OPERA Hotel ID" } ] }, "docs": "

OperationId:putUpsertCateringMenus

" }, { "info": { "name": "Fetch catering packages for a property.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/cateringPackages", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 OPERA Hotel 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": "packageCode", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query", "description": "Revenue Types for which details are to be fetched." }, { "name": "duration", "value": "", "type": "query", "description": "Duration for which the event is scheduled." }, { "name": "webBookable", "value": "", "type": "query", "description": "Defines if web booking is allowed." }, { "name": "pkgTmpltType", "value": "", "type": "query", "description": "It represents Catering Packages and Templates both." }, { "name": "marketCode", "value": "", "type": "query", "description": "Market Code associated with the price details of the Package." }, { "name": "priceCode", "value": "", "type": "query", "description": "Price Code for which details are to be fetched." }, { "name": "minAttendees", "value": "", "type": "query", "description": "Minimum Attendees." }, { "name": "maxAttendees", "value": "", "type": "query", "description": "Maximum Attendees." }, { "name": "sellDate", "value": "", "type": "query", "description": "Selling Date associated with the Price Details." }, { "name": "startDateTime", "value": "", "type": "query" }, { "name": "endDateTime", "value": "", "type": "query" }, { "name": "bookingType", "value": "", "type": "query", "description": "Collection of configured Booking Types for the package property." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Fetch instructions that can be used in Catering Packages maintenance." } ] }, "docs": "Fetch existing Catering Packages for a property.

OperationId:getCateringPackages

The maximum allowable limit for this API is 25.

This API allows a time span of 90 days.

" }, { "info": { "name": "Create catering packages", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/cateringPackages", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 OPERA Hotel ID" } ] }, "docs": "Catering packages and templates are designed to make it easier for you to set up Events. They provide pre-configured resources typically used for Events. Templates and packages are similar except that templates do not include prices.

OperationId:postCateringPackages

" }, { "info": { "name": "Get catering package", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/cateringPackages/:cateringPackageId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringPackageId", "value": "", "type": "path", "description": "Unique Catering Package ID" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel ID" }, { "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": "pkgIDType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Fetch instructions that can be used in Catering Packages maintenance." } ] }, "docs": "Use this API to get catering package.

OperationId:getCateringPackage

" }, { "info": { "name": "Update Catering packages", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/cateringPackages/:cateringPackageId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringPackageId", "value": "", "type": "path", "description": "Unique Catering Package ID" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel ID" } ] }, "docs": "Update an existing Catering Package for a property.

OperationId:putCateringPackages

" }, { "info": { "name": "Delete catering packages", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/cateringPackages/:cateringPackageId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringPackageId", "value": "", "type": "path", "description": "Unique Package Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique Hotel Code" } ] }, "docs": "Use this API to delete catering packages.

OperationId:deleteCateringPackages

" }, { "info": { "name": "Operation to copy catering package or template.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/cateringPackages/:cateringPackageId/copy", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel code." }, { "name": "cateringPackageId", "value": "", "type": "path", "description": "Unique Catering Package or Template ID." } ] }, "docs": "Use this API to copy catering package or template.

OperationId:copyCateringPackage

" }, { "info": { "name": "Operation to copy catering package price.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/cateringPackages/:cateringPackageId/prices/:pricesId/copy", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "pricesId", "value": "", "type": "path", "description": "Unique Catering Package Prices ID" }, { "name": "cateringPackageId", "value": "", "type": "path", "description": "Unique Catering Package ID." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel ID" } ] }, "docs": "Use this API to copy catering package price.

OperationId:copyCateringPackagePrice

" }, { "info": { "name": "Remove menu multi courses", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/courses/:coursesId/menuMultiCourses", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "coursesId", "value": "", "type": "path", "description": "Unique Menu Multi Course ID" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel ID" }, { "name": "courseIdListUniqueIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "courseIdListUniqueIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "courseIdListUniqueIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "Use this API to remove Menu Multi Courses.

OperationId:deleteCateringMenuMultiCourses

" }, { "info": { "name": "Update Daily Inventory Item Quantities", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/dailyInventoryItemQuantities", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel code" } ] }, "docs": "You can use this API to add or update multiple Daily Inventory Item quantities and dates.

OperationId:putDailyInventoryItemQuantities/p>" }, { "info": { "name": "Get Daily Item Inventory", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/dailyInventoryItems", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 OPERA Hotel code" }, { "name": "itemClassCode", "value": "", "type": "query", "description": "Item Class ID which daily item belongs to." }, { "name": "itemName", "value": "", "type": "query", "description": "Item name which daily item belongs to." }, { "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": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" } ] }, "docs": "Retrieve a list of Daily Item Inventories that exist for a property. Examples of Item Inventory in a property could be Crib, Roll Away beds, Microwave etc. API will fetch daily quantity configured for the particular item.

OperationId:getDailyInventoryItems

This API allows a time span of 7 days.

" }, { "info": { "name": "Check if discount is available", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/discountAvailable/check", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 OPERA Hotel Id" } ] }, "docs": "Check if discount is available

OperationId:checkDiscountAvailable

" }, { "info": { "name": "Get Event Forecasts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/eventForecasts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 OPERA Hotel ID" }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Fetch instructions that can be used in event forecast maintenance." }, { "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": "eventTypeCodes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "eventTypeWildCard", "value": "", "type": "query", "description": "Wildcard search on the code." }, { "name": "revenueTypeCodes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "revenueTypeWildCard", "value": "", "type": "query", "description": "Wildcard search on the code." }, { "name": "eventDate", "value": "", "type": "query", "description": "Date for which the event is scheduled." }, { "name": "blockTypeCodes", "value": "", "type": "query" }, { "name": "marketCodes", "value": "", "type": "query" } ] }, "docs": "This API will allow you to retrieve all Event Forecast for a property.

OperationId:getEventForecasts

The maximum allowable limit for this API is 200.

" }, { "info": { "name": "Delete catering package revenues", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/events/:eventsId/revenues/:revenueType/packages/:priceId/cateringPackageRevenues", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "priceId", "value": "", "type": "path", "description": "Unique Catering Packages Revenue Price ID" }, { "name": "revenueType", "value": "", "type": "path", "description": "Unique Catering Packages Revenue Type" }, { "name": "eventsId", "value": "", "type": "path", "description": "Unique Catering Packages Revenue Event ID" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel ID" }, { "name": "packagePriceIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "packagePriceIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "packagePriceIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "eventIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "eventIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "eventIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "Use this API to delete catering package revenues.

OperationId:deleteCateringPackageRevenues

" }, { "info": { "name": "Get Item Inventory", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/inventoryItems", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel code" }, { "name": "itemClassCode", "value": "", "type": "query", "description": "The Item Class ID which the item belongs to." }, { "name": "itemName", "value": "", "type": "query", "description": "The name of Inventory Item." }, { "name": "itemCode", "value": "", "type": "query", "description": "The code of Inventory Item, also known as Quick Insert." }, { "name": "eventTypecodes", "value": "", "type": "query" }, { "name": "usedForEvents", "value": "", "type": "query", "description": "Flag to indicate whether the item is used for events." }, { "name": "includeItemsFromTemplates", "value": "", "type": "query", "description": "Indicates whether to include Items from Templates or not." }, { "name": "startDateTime", "value": "", "type": "query" }, { "name": "endDateTime", "value": "", "type": "query" } ] }, "docs": "Retrieve a list of Item Inventories that exist for a property. Examples of Item Inventory in a property could be Crib, Roll Away beds, Microwave etc. There is typically a quantity configured for each item, such as 5 Roll Away beds.

OperationId:getInventoryItems

The maximum allowable limit for this API is 200.

This API allows a time span of 7 days.

" }, { "info": { "name": "Create an Item Inventory", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/inventoryItems", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel code" } ] }, "docs": "You can use this API to create a new Item Inventory Code for a property.

OperationId:postInventoryItems

" }, { "info": { "name": "Update Item Inventory", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/inventoryItems/:inventoryItemId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "inventoryItemId", "value": "", "type": "path", "description": "Unique Inventory Item id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel code" } ] }, "docs": "Use this API to update an existing Item Inventory Code

OperationId:putInventoryItems

" }, { "info": { "name": "Delete Item Inventory", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/inventoryItems/:inventoryItemId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "inventoryItemId", "value": "", "type": "path", "description": "Unique Inventory Item Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel code" }, { "name": "itemIDExtension", "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": "itemIDType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "Use this API to delete an existing Item Inventory Code

OperationId:deleteInventoryItems

" }, { "info": { "name": "Create/Update Item Inventory", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/upsert/hotels/:hotelId/inventoryItems", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel code" } ] }, "docs": "Use this API to create/update an existing Item Inventory Code

OperationId:putUpsertInventoryItems

" }, { "info": { "name": "Get Item Pools", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/itemPools", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 OPERA Hotel code" }, { "name": "hotelIds", "value": "", "type": "query", "description": "Hotel code." }, { "name": "itemClasseCodes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "wildCard", "value": "", "type": "query", "description": "Wildcard search on the code." }, { "name": "itemPoolCodes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "itemPoolsWildCard", "value": "", "type": "query", "description": "Wildcard search on the code." } ] }, "docs": "Get Item Pools that are configured for a property.

OperationId:getItemPools

" }, { "info": { "name": "Delete Item Pools", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/itemPools/:itemPoolsCode/itemPools", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "itemPoolsCode", "value": "", "type": "path", "description": "Unique Item Pool code" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel code" } ] }, "docs": "Delete Item Pool for a property.

OperationId:deleteItemPools

" }, { "info": { "name": "Delete catering package resource notes", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/notes/:notesId/cateringPackageResourceNotes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "notesId", "value": "", "type": "path", "description": "Unique Catering Package Resource Notes ID" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel ID" } ] }, "docs": "Use this API to delete catering package resource notes.

OperationId:deleteCateringPackageResourceNotes

" }, { "info": { "name": "Delete catering package events", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/packageEvents/:packageEventsId/cateringPackageEvents", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "packageEventsId", "value": "", "type": "path", "description": "Unique Package Events ID" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel ID" }, { "name": "pkgEventIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "pkgEventIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "pkgEventIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "Use this API to delete catering package events.

OperationId:deleteCateringPackageEvents

" }, { "info": { "name": "Delete Catering package prices", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/packagePrices/:pricesId/cateringPackagePrices", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "pricesId", "value": "", "type": "path", "description": "Unique Catering Package Prices ID" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel ID" }, { "name": "packagPriceIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "packagPriceIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "packagPriceIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "Use this API to delete Catering package prices.

OperationId:deleteCateringPackagePrices

" }, { "info": { "name": "Delete catering package event notes", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/packages/:eventId/notes/:notedId/cateringPackageEventNotes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "notedId", "value": "", "type": "path", "description": "Unique Catering Package Event Notes ID" }, { "name": "eventId", "value": "", "type": "path", "description": "Unique Catering Package Event ID" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique OPERA Hotel ID" }, { "name": "pkgEventIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "pkgEventIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "pkgEventIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "noteIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "noteIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "noteIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "Use this API to delete catering package event notes.

OperationId:deleteCateringPackageEventNotes

" }, { "info": { "name": "Copy Item Inventories", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:sourceHotelId/inventoryItems/copy", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "sourceHotelId", "value": "", "type": "path", "description": "Unique ID of source hotel." } ] }, "docs": "This API will allow you to select multiple Item Inventories from the Source Property and copy to the Target Property.

OperationId:copyInventoryItems

" }, { "info": { "name": "Get Item Inventory templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/inventoryItems", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "query", "description": "Specifies the hotel code to be searched." }, { "name": "inventoryItemTemplateName", "value": "", "type": "query", "description": "Wildcard search for the inventory item template." } ] }, "docs": "Retrieve a list of Item Inventory templates that exist for a property.

OperationId:getInventoryItemTemplates

" }, { "info": { "name": "Create Item Inventory template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/inventoryItems", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Create an Item Inventory template.

OperationId:postInventoryItemTemplates

" }, { "info": { "name": "Change Item Inventory templates", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/inventoryItems/:inventoryItemId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "inventoryItemId", "value": "", "type": "path", "description": "Unique Inventory Item Template code" } ] }, "docs": "Change Item Inventory template.

OperationId:putInventoryItemTemplates

" }, { "info": { "name": "Delete Item Inventory templates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/inventoryItems/:inventoryItemId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "inventoryItemId", "value": "", "type": "path", "description": "Unique Inventory Item Template code" }, { "name": "inventoryItemTemplatesIdExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "inventoryItemTemplatesContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "inventoryItemTemplatesType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "Delete Item Inventory template.

OperationId:deleteInventoryItemTemplates

" }, { "info": { "name": "Get item classes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/itemClasses", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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" }, { "name": "itemClassesCode", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "wildCard", "value": "", "type": "query", "description": "Wildcard search on the code." }, { "name": "criteria", "value": "", "type": "query", "description": "Defines values for Item Class Type." }, { "name": "classId", "value": "", "type": "query" } ] }, "docs": "This API will allow you to fetch all existing Item Classes for a property. Items are categorized into logical entities called Item Classes. Item Classes assist you in filtering when selecting and grouping items on the Banquet Event Order (BEO). For example, you might have an item class for different kinds of audio visual equipment, for floral decorations, for recreational equipment, and so on.

OperationId:getItemClasses

" }, { "info": { "name": "Create item classes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/itemClasses", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "You can use this API to create item classes.

OperationId:postItemClasses

" }, { "info": { "name": "Copy item classes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/itemClasses/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": "You can use this API to copy item classes.

OperationId:copyItemClasses

" }, { "info": { "name": "Update item classes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/itemClasses/:itemClassesCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "itemClassesCode", "value": "", "type": "path", "description": "Unique Item Class Code" } ] }, "docs": "This API allows you to update existing Item Classes for a property.

OperationId:putItemClasses

" }, { "info": { "name": "Delete Item classes", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/itemClasses/:itemClassesCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "itemClassesCode", "value": "", "type": "path", "description": "Unique Item Class Code" } ] }, "docs": "This API allows you to delete an existing Item Classes for a property.

OperationId:deleteItemClasses

" }, { "info": { "name": "Create/Update item classes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/upsert/itemClasses/:itemClassesCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "itemClassesCode", "value": "", "type": "path", "description": "Unique Item Class Code" } ] }, "docs": "This API allows you to create/update existing Item Classes for a property.

OperationId:putUpsertItemClasses

" }, { "info": { "name": "Create Item Pools", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/itemPools", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "You can create Item Pools, whereby you are grouping Item Inventories into a group. For example you might have a Item Pool for a Promotional Package where the guest receives a number of Item Inventories; thus creating a group enables you to easily manage this.

OperationId:postItemPools

" }, { "info": { "name": "Change Item Pools", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/itemPools/:itemPoolsCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "itemPoolsCode", "value": "", "type": "path", "description": "Unique Item Pool code" } ] }, "docs": "Change/update an Item Pool that is already configured for a property.

OperationId:putItemPools

" }, { "info": { "name": "Create/Change Item Pools", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/upsert/itemPools/:itemPoolsCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "itemPoolsCode", "value": "", "type": "path", "description": "Unique Item Pool code" } ] }, "docs": "Create/Change/update an Item Pool that is already configured for a property.

OperationId:putUpsertItemPools

" }, { "info": { "name": "Delete menu classes", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/menuClasses/:menuClassesId/cateringMenuClasses", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "menuClassesId", "value": "", "type": "path", "description": "Unique Catering Menu Class ID" }, { "name": "menuClassListIDExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "menuClassListIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "menuClassListUniqueIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." } ] }, "docs": "You can use this API to delete menu classes.

OperationId:deleteCateringMenuClasses

" }, { "info": { "name": "Get Catering Revenue Groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/revenueGroups", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "fetchInactive", "value": "", "type": "query", "description": "Determines wether to fetch inactive records or not." }, { "name": "revenueGroupCodes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "wildCard", "value": "", "type": "query", "description": "Wildcard search on the code." }, { "name": "description", "value": "", "type": "query", "description": "Description of the code." }, { "name": "includeRevenueType", "value": "", "type": "query", "description": "Boolean flag to fetch revenue groups with/without revenue types. 'True' indicates including revenue types information for corresponding revenue groups." } ] }, "docs": "You can use this API to retrieve all catering revenue group codes.

OperationId:getRevenueGroups

" }, { "info": { "name": "Create Catering Revenue Groups", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/revenueGroups", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "You can use this API to create a new catering revenue group code.

OperationId:postRevenueGroups

" }, { "info": { "name": "Update Catering Revenue Groups", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/revenueGroups/:revenueGroupsCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "revenueGroupsCode", "value": "", "type": "path", "description": "Unique Revenue Group Code" } ] }, "docs": "You can use this API to update a catering revenue group Code.

OperationId:putRevenueGroups

" }, { "info": { "name": "Delete Catering Revenue Groups", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/revenueGroups/:revenueGroupsCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "revenueGroupsCode", "value": "", "type": "path", "description": "Unique Revenue Group Code" } ] }, "docs": "You can use this API to delete a catering revenue group code.

OperationId:deleteRevenueGroups

" }, { "info": { "name": "Get Catering Revenue Types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/revenueTypes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "revenueGroupCodes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "revenueGroupWildCard", "value": "", "type": "query", "description": "Wildcard search on the code." }, { "name": "revenueTypeCodes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "revenueTypeWildCard", "value": "", "type": "query", "description": "Wildcard search on the code." }, { "name": "includeInactive", "value": "", "type": "query", "description": "If true this boolean will set the criteria to only return Inactive records." }, { "name": "includeRevenueTypeDetail", "value": "", "type": "query", "description": "Boolean flag to fetch revenue groups/types with/without associated revenue types/revenue type details. 'True' indicates including revenue types/revenue type details information for corresponding revenue groups/revenue types. (Revenue Type is associated to Revenue groups and Revenue Type details are associated to Revenue Types)" } ] }, "docs": "You can use this API to retrieve all Catering Revenue Type codes configured.

OperationId:getRevenueTypes

" }, { "info": { "name": "Create Catering Revenue Types", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/revenueTypes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "You can use this API to create a new Catering Revenue Type code.

OperationId:postRevenueTypes

" }, { "info": { "name": "Update Catering Revenue Types", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/revenueTypes/:revenueTypesId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "revenueTypesId", "value": "", "type": "path", "description": "Unique code for Revenue Type" } ] }, "docs": "You can use this API to update a Catering Revenue Type code.

OperationId:putRevenueTypes

" }, { "info": { "name": "Create/Update catering menu classes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/upsert/cateringMenuClasses", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "You can use this API to create/update menu classes.

OperationId:putUpsertCateringMenuClasses

" }, { "info": { "name": "Create/Update menu item classes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/upsert/cateringMenuItemClasses", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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": "You can use this API to create/update menu item classes.

OperationId:putUpsertCateringMenuItemClasses

" }, { "info": { "name": "Create/Update Event forecasts", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/upsert/eventForecasts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "This API will allow you to create/update an Event Forecast for a property.

OperationId:putUpsertEventForecasts

" } ] }, { "info": { "name": "ChainConfig", "type": "folder" }, "items": [ { "info": { "name": "Get Function Space Event Types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/cateringEventTypes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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": "description", "value": "", "type": "query", "description": "Specifies the Event field value description to search." } ] }, "docs": "Use this API to get Function Space Event Types.

OperationId:getFunctionSpaceEventTypes

" }, { "info": { "name": "Create Function Space Event Types", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/cateringEventTypes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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 create Function Space Event Types.

OperationId:postFunctionSpaceEventTypes

" }, { "info": { "name": "Change Function Space Event Types", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/cateringEventTypes/:eventTypeCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "eventTypeCode", "value": "", "type": "path", "description": "Unique Code of Event Types." } ] }, "docs": "Use this API to update Function Space Event Types.

OperationId:changeFunctionSpaceEventTypes

" }, { "info": { "name": "Delete Function Space Event Types", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/cateringEventTypes/:eventTypeCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "eventTypeCode", "value": "", "type": "path", "description": "Unique Code of Event Types." } ] }, "docs": "Use this API to delete Function Space Event Types.

OperationId:removeFunctionSpaceEventTypes

" }, { "info": { "name": "Get Function Space Types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/functionSpaceTypes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "fetchInactive", "value": "", "type": "query", "description": "Determines wether to fetch inactive records or not." }, { "name": "codes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "wildCard", "value": "", "type": "query", "description": "Wildcard search on the code." }, { "name": "description", "value": "", "type": "query", "description": "Description of the code." } ] }, "docs": "Use this API to get Function Space Types.

OperationId:getFunctionSpaceTypes

" }, { "info": { "name": "Create Function Space Types", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/functionSpaceTypes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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 create Function Space Types.

OperationId:postFunctionSpaceTypes

" }, { "info": { "name": "Change Function Space Types", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/functionSpaceTypes/:functionSpaceTypesId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "functionSpaceTypesId", "value": "", "type": "path", "description": "Unique ID of Function Space Types." } ] }, "docs": "Use this API to update Function Space Types.

OperationId:putFunctionSpaceTypes

" }, { "info": { "name": "Delete Function Space Types", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/functionSpaceTypes/:functionSpaceTypesId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "functionSpaceTypesId", "value": "", "type": "path", "description": "Unique ID of Function Space Types." } ] }, "docs": "Use this API to delete Function Space Types.

OperationId:deleteFunctionSpaceTypes

" }, { "info": { "name": "Get Meal Types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/mealTypes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "fetchInactive", "value": "", "type": "query", "description": "Determines wether to fetch inactive records or not." }, { "name": "codes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "wildCard", "value": "", "type": "query", "description": "Wildcard search on the code." }, { "name": "description", "value": "", "type": "query", "description": "Description of the code." } ] }, "docs": "Use this API to get Meal Types.

OperationId:getMealTypes

" }, { "info": { "name": "Create Meal Types", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/mealTypes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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 create Meal Types.

OperationId:postMealTypes

" }, { "info": { "name": "Change Meal Types", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/mealTypes/:mealTypesId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "mealTypesId", "value": "", "type": "path", "description": "Unique ID of Meal Types." } ] }, "docs": "Use this API to update Meal Types.

OperationId:putMealTypes

" }, { "info": { "name": "Delete Meal Types", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/mealTypes/:mealTypesId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "mealTypesId", "value": "", "type": "path", "description": "Unique ID of Meal Types." } ] }, "docs": "Use this API to delete Meal Types.

OperationId:deleteMealTypes

" }, { "info": { "name": "Create/Change Function Space Event Types", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/upsert/cateringEventTypes/:eventTypeCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "eventTypeCode", "value": "", "type": "path", "description": "Unique Code of Event Types." } ] }, "docs": "Use this API to Create/update Function Space Event Types.

OperationId:changeUpsertFunctionSpaceEventTypes

" } ] }, { "info": { "name": "HotelConfig", "type": "folder" }, "items": [ { "info": { "name": "Get Template Event Codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/eventCodes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "eventsCodes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "wildCard", "value": "", "type": "query", "description": "Wildcard search on the code." }, { "name": "includeInactive", "value": "", "type": "query", "description": "If true, this flag will set the criteria to return only Inactive records." } ] }, "docs": "Use this API to get Template Event Codes.

OperationId:getTemplateEventCodes

" }, { "info": { "name": "Create Template Event Codes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/eventCodes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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 create Template Event Codes.

OperationId:postTemplateEventCodes

" }, { "info": { "name": "Change Template Event Codes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/eventCodes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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 Template Event Codes.

OperationId:changeTemplateEventCodes

" }, { "info": { "name": "Delete Template Event Codes", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/eventCodes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "templateEventCodes", "value": "", "type": "query" } ] }, "docs": "Use this API to delete Template Event Codes.

OperationId:removeTemplateEventCodes

" }, { "info": { "name": "Get Catering s Rental Codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/functionSpaceRentalCodes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "fetchInactive", "value": "", "type": "query", "description": "Determines wether to fetch inactive records or not." }, { "name": "codes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "wildCard", "value": "", "type": "query", "description": "Wildcard search on the code." }, { "name": "description", "value": "", "type": "query", "description": "Description of the code." } ] }, "docs": "Use this API to get Catering s Rental Codes.

OperationId:getCateringRentalCodes

" }, { "info": { "name": "Create Catering s Rental Codes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/functionSpaceRentalCodes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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 create Catering s Rental Codes.

OperationId:postCateringRentalCodes

" }, { "info": { "name": "Change Catering s Rental Codes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/functionSpaceRentalCodes/:cateringRentalId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringRentalId", "value": "", "type": "path", "description": "Unique CateringRentalCode for functionSpace." } ] }, "docs": "Use this API to update Catering s Rental Codes.

OperationId:changeCateringRentalCodes

" }, { "info": { "name": "Delete Catering s Rental Codes", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/functionSpaceRentalCodes/:cateringRentalId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "cateringRentalId", "value": "", "type": "path", "description": "Unique CateringRentalCode for functionSpace." } ] }, "docs": "Use this API to delete Catering s Rental Codes.

OperationId:removeCateringRentalCodes

" }, { "info": { "name": "Create/Change Catering s Rental Codes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/upsert/functionSpaceRentalCodes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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 create/update Catering s Rental Codes.

OperationId:changeUpsertCateringRentalCodes

" }, { "info": { "name": "Get Function space locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/functionspaceLocations", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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": "codes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "wildCard", "value": "", "type": "query", "description": "Wildcard search on the code." } ] }, "docs": "Use this API to get detail information of function space locations.

OperationId:getFunctionSpaceLocations

" }, { "info": { "name": "Create function space locations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/functionspaceLocations/:functionspaceLocationCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "functionspaceLocationCode", "value": "", "type": "path", "description": "Unique Code of function space locations." } ] }, "docs": "Use this API to create function space locations.

OperationId:postFunctionSpaceLocations

" }, { "info": { "name": "Change function space locations", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/functionspaceLocations/:functionspaceLocationCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "functionspaceLocationCode", "value": "", "type": "path", "description": "Unique Code of function space locations." } ] }, "docs": "Use this API to update function space locations.

OperationId:changeFunctionSpaceLocations

" }, { "info": { "name": "Delete function space locations", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/functionspaceLocations/:functionspaceLocationCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "functionspaceLocationCode", "value": "", "type": "path", "description": "Unique Code of function space locations." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel where the code is configured." } ] }, "docs": "Use this API to delete function space locations.

OperationId:removeFunctionSpaceLocations

" }, { "info": { "name": "Get Function space setup styles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/functionspaceSetupStyles", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "fetchInactive", "value": "", "type": "query", "description": "Determines wether to fetch inactive records or not." }, { "name": "codes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "wildCard", "value": "", "type": "query", "description": "Wildcard search on the code." }, { "name": "description", "value": "", "type": "query", "description": "Description of the code." } ] }, "docs": "Use this API to get Function space setup styles.

OperationId:getFunctionSpaceSetupStyles

" }, { "info": { "name": "Create function space setup styles", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/functionspaceSetupStyles", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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 create function space setup styles.

OperationId:postFunctionSpaceSetupStyles

" }, { "info": { "name": "Change function space setup styles", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/functionspaceSetupStyles/:functionSpaceSetupStyleId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "functionSpaceSetupStyleId", "value": "", "type": "path", "description": "Unique ID of function space setup styles." } ] }, "docs": "Use this API to update function space setup styles.

OperationId:changeFunctionSpaceSetupStyles

" }, { "info": { "name": "Delete function space setup styles", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/functionspaceSetupStyles/:functionSpaceSetupStyleId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "functionSpaceSetupStyleId", "value": "", "type": "path", "description": "Unique ID of function space setup styles." } ] }, "docs": "Use this API to delete function space setup styles.

OperationId:removeFunctionSpaceSetupStyles

" }, { "info": { "name": "Create/Change function space setup styles", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/upsert/functionspaceSetupStyles", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-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 create/update function space setup styles.

OperationId:changeUpsertFunctionSpaceSetupStyles

" }, { "info": { "name": "Get Function space ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/functionspaces/:functionSpaceCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "functionSpaceCode", "value": "", "type": "path", "description": "Unique code of function Space ." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "pageNumber", "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": "physical", "value": "", "type": "query", "description": "Is it a physical room type." }, { "name": "pseudo", "value": "", "type": "query", "description": "Is it a pseudo room type." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel code of room to be searched." }, { "name": "roomClassCodes", "value": "", "type": "query" }, { "name": "roomTypeCodes", "value": "", "type": "query" } ] }, "docs": "Retrieve detailed information on function spaces, for example Meeting Room.

OperationId:getFunctionSpace

The maximum allowable limit for this API is 25.

" }, { "info": { "name": "Create/Change Hotel Event Codes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/upsert/hotels/:hotelId/eventCodes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 hotel." } ] }, "docs": "Use this API to create/update Hotel Event Codes.

OperationId:changeUpsertEventCodes

" }, { "info": { "name": "Create/Change function space locations", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/upsert/functionspaceLocations/:functionspaceLocationCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "functionspaceLocationCode", "value": "", "type": "path", "description": "Unique Code of function space locations." } ] }, "docs": "Use this API to create/update function space locations.

OperationId:changeUpsertFunctionSpaceLocations

" }, { "info": { "name": "Get Hotel Event Codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/eventCodes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 hotel." }, { "name": "hotelIds", "value": "", "type": "query", "description": "Hotel code." }, { "name": "eventsCodes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "wildCard", "value": "", "type": "query", "description": "Wildcard search on the code." }, { "name": "includeInactive", "value": "", "type": "query", "description": "If true, this flag will set the criteria to return only Inactive records." } ] }, "docs": "Use this API to get Hotel Event Codes.

OperationId:getEventCodes

" }, { "info": { "name": "Create Hotel Event Codes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/eventCodes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 hotel." } ] }, "docs": "Use this API to create Hotel Event Codes.

OperationId:postEventCodes

" }, { "info": { "name": "Change Hotel Event Codes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/eventCodes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 hotel." } ] }, "docs": "Use this API to update Hotel Event Codes.

OperationId:changeEventCodes

" }, { "info": { "name": "Delete Hotel Event Codes", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/eventCodes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 hotel." }, { "name": "eventCode", "value": "", "type": "query", "description": "Configuration code." } ] }, "docs": "Use this API to delete Hotel Event Codes.

OperationId:removeEventCodes

" }, { "info": { "name": "Get Function Spaces", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/functionSpaces", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 hotel." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "pageNumber", "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": "sortingBy", "value": "", "type": "query", "description": "A collection of supported sorting for Event Calendar Function Space." }, { "name": "roomCodes", "value": "", "type": "query" }, { "name": "roomType", "value": "", "type": "query", "description": "Room Type where function space belongs to" }, { "name": "spaceType", "value": "", "type": "query", "description": "Space Type where function space belongs to" }, { "name": "functionSpaceWildcard", "value": "", "type": "query", "description": "Wild search on Room Code and Function Name." }, { "name": "webBookable", "value": "", "type": "query", "description": "If true, will set the criteria to return Function Spaces configured as web bookable only." }, { "name": "floorCodes", "value": "", "type": "query" }, { "name": "locationCodes", "value": "", "type": "query" }, { "name": "includeInactive", "value": "", "type": "query", "description": "If true this boolean will set the criteria to return Inactive records along with active records." } ] }, "docs": "This API fetches the configured function spaces of a specific property with possible search criteria of function space code, and space type. The result returns the function spaces that fit the search criteria with details about space name, short name, attributes such as shareable, combo, web bookable, and more.

OperationId:getFunctionSpaces

" }, { "info": { "name": "Create Function Spaces", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/functionSpaces", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 hotel." } ] }, "docs": "This API allows the creation of function spaces. Criteria that need to be supplied in the request body include function space code, description, space type, and min / max attendees. Optional details such as short name, shareable, combo, web bookable, and dimensions can also be included.

OperationId:postFunctionSpaces

" }, { "info": { "name": "Change Function Spaces", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/functionSpaces/:functionSpaceCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "functionSpaceCode", "value": "", "type": "path", "description": "Unique Code of functionSpace." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." } ] }, "docs": "Use this API to update Function Spaces.

OperationId:changeFunctionSpaces

" }, { "info": { "name": "Delete Function Spaces", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/functionSpaces/:functionSpaceCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "functionSpaceCode", "value": "", "type": "path", "description": "Unique Code of functionSpace." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." } ] }, "docs": "Use this API to delete Function Spaces.

OperationId:removeFunctionSpaces

" }, { "info": { "name": "Get Function Space Configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/functionSpaces/:functionSpaceCode/configurations", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "functionSpaceCode", "value": "", "type": "path", "description": "Unique Code of function space." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." } ] }, "docs": " Use this get Function Space detailed information.

OperationId:getFunctionSpaceConfig

" }, { "info": { "name": "Fetch Room Type Pool", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/roomPools", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 hotel." }, { "name": "includeInactive", "value": "", "type": "query", "description": "Flag to indicate if inactive room types should be included." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "pageNumber", "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": "physical", "value": "", "type": "query", "description": "Is it a physical sleep room type." }, { "name": "pseudo", "value": "", "type": "query", "description": "Is it a pseudo room type." }, { "name": "summaryInfo", "value": "", "type": "query", "description": "Flag to indicate if summary or detailed information should be fetched." }, { "name": "roomTypeCodes", "value": "", "type": "query" }, { "name": "roomClassCodes", "value": "", "type": "query" }, { "name": "roomTypePoolCodes", "value": "", "type": "query" } ] }, "docs": "This API allows you to Use this API to get Room Type Pool and the associated Room Types.

OperationId:getRoomTypePool

The maximum allowable limit for this API is 25.

" }, { "info": { "name": "Create Room Type Pools", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/roomPools", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "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 hotel." } ] }, "docs": "This API allows you to Use this API to create Room Type Pools.

OperationId:postRoomTypePool

" }, { "info": { "name": "Change Room Type Pool ", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/roomPools/:roomPoolCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "roomPoolCode", "value": "", "type": "path", "description": "Unique Code of room type pool." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." } ] }, "docs": "Use this API to update Room Type Pool and Associated Room Types.

OperationId:changeRoomTypePool

" }, { "info": { "name": "Delete Room Type Pool and Mappings", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/roomPools/:roomPoolCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "roomPoolCode", "value": "", "type": "path", "description": "Unique Code of room type pool." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." }, { "name": "description", "value": "", "type": "query", "description": "The description of room pool type." }, { "name": "defaultText", "value": "", "type": "query", "description": "Default text with Character length from 0 to 1000." }, { "name": "lang", "value": "", "type": "query", "description": "Language code for the translation." }, { "name": "sequence", "value": "", "type": "query", "description": "Sequence for representing room type pool record." }, { "name": "inactive", "value": "", "type": "query", "description": "Indicates the room type is inactive or not." }, { "name": "numberOfRooms", "value": "", "type": "query", "description": "Number of rooms for this room type." }, { "name": "roomType", "value": "", "type": "query" }, { "name": "roomClass", "value": "", "type": "query", "description": "Room class for the room type code." }, { "name": "shortDescription", "value": "", "type": "query", "description": "Short Description of room type." }, { "name": "activeDate", "value": "", "type": "query", "description": "Active date of the room type." }, { "name": "pseudo", "value": "", "type": "query", "description": "Indicates if room type is pseudo." }, { "name": "accessible", "value": "", "type": "query", "description": "Indicates if room type is accessible." }, { "name": "sendToInterface", "value": "", "type": "query", "description": "Indicates if room type is sent to interface." }, { "name": "sellSequence", "value": "", "type": "query", "description": "Indicates room types sell sequence." }, { "name": "suite", "value": "", "type": "query", "description": "Indicates room type is a suite." }, { "name": "meetingRoom", "value": "", "type": "query", "description": "Indicates room type is meeting room. This Can be Meeting room flag cannot be unmarked at the property level. Can only be marked for non pseudo room types." }, { "name": "restricted", "value": "", "type": "query", "description": "Indicates that the room pool cannot be used to allocate inventory to this room type. Inventory must be allocated directly to the room type itself." } ] }, "docs": "Use this API to delete Room Type Pool and Mappings.

OperationId:removeRoomTypePool

" }, { "info": { "name": "Copy Function Spaces", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:sourceHotelId/functionSpaces/copy", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "sourceHotelId", "value": "", "type": "path", "description": "Unique ID of source hotel." } ] }, "docs": " Use this API to copy Function Space.

OperationId:copyFunctionSpaces

" }, { "info": { "name": "Copy function space locations", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:sourceHotelId/functionspaceLocations/copy", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "sourceHotelId", "value": "", "type": "path", "description": "Unique ID of source hotel." } ] }, "docs": "Use this API to copy function space locations.

OperationId:copyFunctionSpaceLocations

" } ] } ], "bundled": true }