openapi: 3.2.0
info:
title: OPERA Cloud Event Configuration Resource Config API
description: This API caters for Event Configuration in OPERA Cloud.
Compatible with OPERA Cloud release 26.2.0.0.
This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2026 Oracle and/or its affiliates.
version: 26.2.0.0 termsOfService: https://www.oracle.com/legal/terms.html contact: email: hospitality_apis_ww_grp@oracle.com license: name: UPL url: https://opensource.org/licenses/upl servers: - url: /evm/config/v1 tags: - name: ResourceConfig description: The Resource Config Service Web Service offers capability to configure Master Data needed for Hotel Resources such as managing Inventory Items, Item Pools, Item Classes, etc. paths: /EventForecasts/copy: put: summary: Copy event forecasts description: This API will allow you to copy an Event Forecast from a property to another.OperationId:copyEventForecasts
operationId: copyEventForecasts parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/eventForecastsCopy' description: Request object for Copying Event Forecasts to multiple hotels. required: true /cateringContainers: get: summary: Get catering containers description: This API allows you to retrieve all existing Menu Item Catering Container codes.OperationId:getCateringContainers
operationId: getCateringContainers parameters: - name: fetchInactive in: query required: false description: Determines wether to fetch inactive records or not. schema: type: boolean - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Catering Code Containers details. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cateringContainersInfo' '204': description: CateringContainers not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig post: summary: Create catering containers description: 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
operationId: postCateringContainers parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringContainers' description: Request object which holds new Catering Code Containers. required: true /cateringContainers/{cateringContainersCode}: put: summary: Change catering containers description: This API allows you to update an existing Menu Item Catering Container code.OperationId:putCateringContainers
operationId: putCateringContainers parameters: - name: cateringContainersCode in: path required: true description: Unique Catering Container Code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringContainers' description: Request object which holds modified Catering Code Containers. required: true delete: summary: Delete Catering container description: This API allows you to delete an existing Menu Item Catering Container code.OperationId:deleteCateringContainers
operationId: deleteCateringContainers parameters: - name: cateringContainersCode in: path required: true description: Unique Catering Container Code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /cateringItemRates: get: summary: Get catering item rates description: Retrieve catering item ratesOperationId:getCateringItemRates
operationId: getCateringItemRates parameters: - name: fetchInactive in: query required: false description: Determines wether to fetch inactive records or not. schema: type: boolean - name: codes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Catering Code's Item Rate details. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cateringItemRatesInfo' '204': description: CateringItemRates not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig post: summary: Create Catering Item rates description: Create Catering Item ratesOperationId:postCateringItemRates
operationId: postCateringItemRates parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringItemRates' description: Request object which holds new Catering Code's Item Rates. required: true /cateringItemRates/{cateringItemRatesCode}: put: summary: Change catering item rates description: Change catering item rates codeOperationId:putCateringItemRates
operationId: putCateringItemRates parameters: - name: cateringItemRatesCode in: path required: true description: Unique Catering Item Rates Codes schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringItemRates' description: Request object which holds modified Catering Code's Item Rate. required: true delete: summary: Remove catering item rates description: Remove catering item rates codeOperationId:deleteCateringItemRates
operationId: deleteCateringItemRates parameters: - name: cateringItemRatesCode in: path required: true description: Unique Catering Item Rates Codes schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /cateringMenuClasses: post: summary: Create menu classes description: You can use this API to create menu classes.OperationId:postCateringMenuClasses
operationId: postCateringMenuClasses parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringMenuClasses' description: Requestion object for creating new Menu Classes. required: true put: summary: Update catering menu classes description: Update catering menu classesOperationId:putCateringMenuClasses
operationId: putCateringMenuClasses parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringMenuClasses' description: Request object for changing Menu Classes. required: true /cateringMenuItemClasses: post: summary: Create menu item classes description: You can use this API to create menu item classes.OperationId:postCateringMenuItemClasses
operationId: postCateringMenuItemClasses parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringMenuItemClasses' description: Request object for Creating Menu Item Classes. required: true /cateringMenuItemClasses/{cateringMenuItemClassesCode}: put: summary: Update menu item classes description: You can use this API to update menu item classes.OperationId:putCateringMenuItemClasses
operationId: putCateringMenuItemClasses parameters: - name: cateringMenuItemClassesCode in: path required: true description: Unique Menu Item Class Id schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringMenuItemClasses' description: Request object for updating Menu Item Classes. required: true delete: summary: Delete menu item classes description: You can use this API to delete menu item classes.OperationId:deleteCateringMenuItemClasses
operationId: deleteCateringMenuItemClasses parameters: - name: cateringMenuItemClassesCode in: path required: true description: Unique Menu Item Class ID schema: type: string maxLength: 2000 minLength: 1 - name: menuItemClassesIdExtension in: query description: Additional identifying value assigned by the creating system. required: false style: form explode: true schema: type: array items: type: integer - name: menuItemClassesIdContext in: query description: Used to identify the source of the identifier (e.g., IATA, ABTA). required: false style: form explode: true schema: type: array items: type: string - name: menuItemClassesUniqueIdType in: query description: A reference to the type of object defined by the UniqueID element. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /cateringMenuItemClasses/{cateringMenuItemClassesCode}/copy: put: summary: Copy menu item classes description: You can use this API to copy menu item classes.OperationId:copyCateringMenuItemClasses
operationId: copyCateringMenuItemClasses parameters: - name: cateringMenuItemClassesCode in: path required: true description: Unique Menu Item Class Id schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringMenuItemClassesCopy' description: Request object for Copying Menu Item Classes. required: true /cateringMenuItems/{cateringMenuItemId}: delete: summary: Operation to remove catering menu items by chain. description: 'OperationId:deleteCateringMenuItemsByChain
' operationId: deleteCateringMenuItemsByChain parameters: - name: cateringMenuItemId in: path required: true description: Unique Catering Menu Item Id schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: query required: false description: The Hotel code which the Catering Menu Items belongs to. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /cateringPackageResources: delete: summary: Delete catering package resources description: Use this API to delete catering package resources.OperationId:deleteCateringPackageResources
operationId: deleteCateringPackageResources parameters: - name: hotelId in: query description: The Hotel code which the Catering Package Event belongs to. required: true style: form explode: true schema: type: array items: type: string - name: pkgEventId in: query description: Unique Packages Event ID required: true style: form explode: true schema: type: array items: type: string - name: pkgEventIdType in: query description: Unique Packages Event Type required: true style: form explode: true schema: type: array items: type: string - name: resourceId in: query description: Unique Resources ID required: true style: form explode: true schema: type: array items: type: string - name: pkgEventIdExtension in: query required: false description: Additional identifying value assigned by the creating system. schema: type: integer - name: pkgEventIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: pkgEventType in: query description: A reference to the type of object defined by the UniqueID element. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /cateringPackages: get: summary: Fetch catering packages description: Fetch existing Catering Packages.OperationId:getCateringPackagesMultiProperties
The maximum allowable limit for this API is 25.
This API allows a time span of 90 days.
operationId: getCateringPackagesMultiProperties parameters: - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false 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. schema: type: integer default: 0 - name: hotelIds in: query required: false schema: type: array items: type: string maxItems: 4000 - name: packageCode in: query required: false schema: type: array items: type: string maxItems: 4000 - name: description in: query required: false description: Revenue Types for which details are to be fetched. schema: type: string - name: duration in: query required: false description: Duration for which the event is scheduled. schema: type: integer - name: webBookable in: query required: false description: Defines if web booking is allowed. schema: type: boolean - name: pkgTmpltType in: query required: false description: It represents Catering Packages and Templates both. schema: type: string enum: - Packages - Templates - Both uniqueItems: true - name: marketCode in: query required: false description: Market Code associated with the price details of the Package. schema: type: string - name: priceCode in: query required: false description: Price Code for which details are to be fetched. schema: type: string - name: minAttendees in: query required: false description: Minimum Attendees. schema: type: integer - name: maxAttendees in: query required: false description: Maximum Attendees. schema: type: integer - name: sellDate in: query required: false description: Selling Date associated with the Price Details. schema: type: string format: date - name: startDateTime in: query required: false schema: type: string format: date-time - name: endDateTime in: query required: false schema: type: string format: date-time - name: bookingType in: query required: false description: Collection of configured Booking Types for the package property. schema: type: string - name: fetchInstructions in: query description: Fetch instructions that can be used in Catering Packages maintenance. required: false style: form explode: true schema: type: array items: type: string enum: - PackageInfo - Events - Resources - Pricing - Indicators - BlockPackageInfo - EventNotes uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object to fetch Menu . content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cateringPackagesInfo' '204': description: CateringPackagesMultiProperties not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /cateringPackages/{cateringPackageId}: get: summary: Get catering package by chain description: Use this API to get catering package.OperationId:getCateringPackageByChain
operationId: getCateringPackageByChain parameters: - name: cateringPackageId in: path required: true description: Unique Catering Package ID schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: query required: false description: Hotel code of Catering Package to be fetched. schema: type: string - name: idExtension in: query required: false description: Additional identifying value assigned by the creating system. schema: type: integer - name: idContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: pkgIDType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - name: fetchInstructions in: query description: Fetch instructions that can be used in Catering Packages maintenance. required: false style: form explode: true schema: type: array items: type: string enum: - PackageInfo - Events - Resources - Pricing - Indicators - BlockPackageInfo - EventNotes uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object to fetch Menu . content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cateringPackage' '204': description: CateringPackageByChain not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /cateringServings: get: summary: Get catering servings description: Get catering servingsOperationId:getCateringServings
operationId: getCateringServings parameters: - name: fetchInactive in: query required: false description: Determines wether to fetch inactive records or not. schema: type: boolean - name: servingCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Catering Code's Serving details. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cateringServingsInfo' '204': description: CateringServings not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /cateringServings/{cateringServingsCode}: put: summary: Update catering servings description: Update catering servingsOperationId:putCateringServings
operationId: putCateringServings parameters: - name: cateringServingsCode in: path required: true description: Unique Catering Sevrings Code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringServings' description: Request object which holds modified Catering Code's Serving. required: true /eventForecasts: post: summary: Create event forecasts description: 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
operationId: postEventForecasts parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/eventForecasts' required: true put: summary: Update Event forecasts description: This API will allow you to update an Event Forecast for a property.OperationId:putEventForecasts
operationId: putEventForecasts parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/eventForecasts' required: true /eventForecasts/{forecastsId}/eventTypes/{eventTypesCode}/eventForecasts: delete: summary: Delete event forecasts description: This API will allow you to delete an Event Forecast for a property.OperationId:deleteEventForecasts
operationId: deleteEventForecasts parameters: - name: eventTypesCode in: path required: true description: Unique Event Type Code schema: type: string maxLength: 2000 minLength: 1 - name: forecastsId in: path required: true description: Unique Forecast Id schema: type: string maxLength: 2000 minLength: 1 - name: forecastIdExtension in: query required: false description: Additional identifying value assigned by the creating system. schema: type: integer - name: forecastIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: forecastIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - name: hotelId in: query description: Hotel Code to which the Event Forecast belongs to. required: false style: form explode: true schema: type: array items: type: string - name: revenueTypeCode in: query required: false description: Code. schema: type: string - name: revenueTypeDescription in: query required: false description: description. schema: type: string - name: amount in: query required: false description: A monetary amount. schema: type: number - name: currencyCode in: query required: false description: Provides a currency code to reflect the currency in which an amount may be expressed. schema: type: string - name: amountType in: query description: Defines values for Amount Type of an event forecast revenue. required: false style: form explode: true schema: type: array items: type: string enum: - FlatAmount - PerPerson uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /hotels/{hotelId}/cateringMenuClasses: get: summary: Get menu classes description: Get menu classes for a property.OperationId:getCateringMenuClasses
The maximum allowable limit for this API is 25.
operationId: getCateringMenuClasses parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel ID schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false 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. schema: type: integer default: 0 - name: className in: query required: false description: The name of Menu Class. schema: type: string - name: webBookable in: query required: false description: If true this boolean will set the criteria to only return Menu Classes configured as Web Bookable. schema: type: boolean - name: includeMenus in: query required: false description: If true this boolean will set the criteria to fetch associated menu for the menu classes. schema: type: boolean - name: inactive in: query required: false description: If true this boolean will set the criteria to only return Menu Classes configured as Inactive. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object to fetch Menu Classes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cateringMenuClassesInfo' '204': description: CateringMenuClasses not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /hotels/{hotelId}/cateringMenuItemClasses: get: summary: Get menu item classes description: Get menu item classes for a property.OperationId:getCateringMenuItemClasses
The maximum allowable limit for this API is 25.
operationId: getCateringMenuItemClasses parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel Id schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false 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. schema: type: integer default: 0 - name: className in: query required: false description: Menu Item class name search filter. schema: type: string - name: menuTypes in: query description: Defines values for Menu Type required: false style: form explode: true schema: type: array items: type: string enum: - Food - Beverage uniqueItems: true - name: webBookable in: query required: false description: Indicates if web bookable. schema: type: boolean - name: includeMenuItems in: query required: false description: MenuItemClassInfo MenuItemInfo values can be passed as per requirement schema: type: boolean default: 'true' - name: inactive in: query required: false description: If true this boolean will set the criteria to only return Menu Item Classes configured as Inactive. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for retrieving Menu Item Classes. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cateringMenuItemClassesInfo' '204': description: CateringMenuItemClasses not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /hotels/{hotelId}/cateringMenuItems: get: summary: Get Menu items description: Get Menu items for a property.OperationId:getCateringMenuItems
The maximum allowable limit for this API is 200.
operationId: getCateringMenuItems parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel Id schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false 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. schema: type: integer default: 0 - name: name in: query required: false description: Menu item name of string length 30 schema: type: string - name: codes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: quickInsertCode in: query required: false description: Article number of Menu Item in Caps schema: type: string - name: listTypeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: inactive in: query required: false description: If true this boolean will set the criteria to only return Menu Items configured as Inactive. schema: type: boolean - name: eventTypesCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: fetchInstructions in: 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. required: false style: form explode: true schema: type: array items: type: string enum: - SummaryInfo - DetailsInfo maxItems: 20 uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for retrieving Menu Items. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cateringMenuItemsInfo' '204': description: CateringMenuItems not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig post: summary: Create menu items description: You can use this API to create menu items.OperationId:postCateringMenuItems
operationId: postCateringMenuItems parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel Id schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringMenuItems' description: Request object for creating Menu Items. required: true /hotels/{hotelId}/cateringMenuItems/copy: post: summary: Operation to copy catering menu items. description: 'OperationId:copyCateringMenuItems
' operationId: copyCateringMenuItems parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel Id schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringMenuItemsCopy' description: Request object for Copying Menu Items. required: true /hotels/{hotelId}/cateringMenuItems/{cateringMenuItemId}: put: summary: Update menu items description: You can use this API to update menu items.OperationId:putCateringMenuItems
operationId: putCateringMenuItems parameters: - name: cateringMenuItemId in: path required: true description: Unique Catering Menu Item Id schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel Id schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringMenuItems' description: Request object for changing Menu Items. required: true delete: summary: Operation to remove catering menu items. description: 'OperationId:deleteCateringMenuItems
' operationId: deleteCateringMenuItems parameters: - name: cateringMenuItemId in: path required: true description: Unique Catering Menu Item Id schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel Id schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /upsert/hotels/{hotelId}/cateringMenuItems: put: summary: Create/Update menu items description: You can use this API to create/update menu items.OperationId:putUpsertCateringMenuItems
operationId: putUpsertCateringMenuItems parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel Id schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringMenuItems' description: Request object for changing Menu Items. required: true /hotels/{hotelId}/cateringMenus: get: summary: Get menus description: 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.
operationId: getCateringMenus parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel ID schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false 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. schema: type: integer default: 0 - name: menuId in: query required: false description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. schema: type: string - name: iDExtension in: query required: false description: Additional identifying value assigned by the creating system. schema: type: integer - name: idContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: menuIDType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - name: name in: query required: false description: This type holds name of Menu Class. schema: type: string - name: classNameListCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: eventTypesCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: menuTypes in: query description: Defines values for Menu Type required: false style: form explode: true schema: type: array items: type: string enum: - Food - Beverage uniqueItems: true - name: dietaryListCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: inactive in: query required: false description: If true, only Composed Menu's marked as Inactive in Menu Configuration will be returned. schema: type: boolean - name: multiChoice in: query required: false description: When selected Only Composed Menu's noted as Multi Choice in Menu Configuration will be returned. schema: type: boolean - name: webBookable in: query required: false description: Check of Menu if it is web bookable schema: type: boolean - name: end in: query required: false description: The ending value of the date range. schema: type: string format: date - name: start in: query required: false description: The starting value of the date range. schema: type: string format: date - name: fetchInstructions in: query description: Fetch instructions that can be used in Catering Menus maintenance. required: false style: form explode: true schema: type: array items: type: string enum: - Revenue - MenuDetails - MenuNotes uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object to fetch Menu . content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cateringMenusInfo' '204': description: CateringMenus not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig post: summary: Create menus description: Create menus for a property.OperationId:postCateringMenus
operationId: postCateringMenus parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel ID schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringMenus' description: Request object for creating new Menu . required: true /hotels/{hotelId}/cateringMenus/{cateringMenuId}: get: summary: Get menu description: Retrieve details of a Catering menuOperationId:getCateringMenu
operationId: getCateringMenu parameters: - name: cateringMenuId in: path required: true description: Unique ID of Catering Menu schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel ID schema: type: string maxLength: 2000 minLength: 1 - name: inactive in: query required: false description: If true, only Composed Menu's marked as Inactive in Menu Configuration will be returned. schema: type: boolean - name: fetchInstructions in: query description: Fetch instructions that can be used in Catering Menus maintenance. required: false style: form explode: true schema: type: array items: type: string enum: - Revenue - MenuDetails - MenuNotes uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object to fetch Menu . content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cateringMenusInfo' '204': description: CateringMenu not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig put: summary: Operation to change catering menus. description: 'OperationId:putCateringMenus
' operationId: putCateringMenus parameters: - name: cateringMenuId in: path required: true description: Unique ID of Catering Menu schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel ID schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringMenus' description: Request object for changing Menu . required: true delete: summary: Delete a menu description: Delete a menu from a property.OperationId:deleteCateringMenus
operationId: deleteCateringMenus parameters: - name: cateringMenuId in: path required: true description: Unique ID of Catering Menu schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel ID schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /hotels/{hotelId}/cateringMenus/{cateringMenuId}/copy: post: summary: Copy a menu description: Copy a menu for a property.OperationId:copyCateringMenus
operationId: copyCateringMenus parameters: - name: cateringMenuId in: path required: true description: Unique ID of Catering Menu schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel Id schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringMenusCopy' description: Request object for copying a Menu. required: true /upsert/hotels/{hotelId}/cateringMenus: put: summary: Operation to create/change catering menus. description: 'OperationId:putUpsertCateringMenus
' operationId: putUpsertCateringMenus parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel ID schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringMenus' description: Request object for changing Menu . required: true /hotels/{hotelId}/cateringPackages: get: summary: Fetch catering packages for a property. description: 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.
operationId: getCateringPackages parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel ID schema: type: string maxLength: 2000 minLength: 1 - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false 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. schema: type: integer default: 0 - name: packageCode in: query required: false schema: type: array items: type: string maxItems: 4000 - name: description in: query required: false description: Revenue Types for which details are to be fetched. schema: type: string - name: duration in: query required: false description: Duration for which the event is scheduled. schema: type: integer - name: webBookable in: query required: false description: Defines if web booking is allowed. schema: type: boolean - name: pkgTmpltType in: query required: false description: It represents Catering Packages and Templates both. schema: type: string enum: - Packages - Templates - Both uniqueItems: true - name: marketCode in: query required: false description: Market Code associated with the price details of the Package. schema: type: string - name: priceCode in: query required: false description: Price Code for which details are to be fetched. schema: type: string - name: minAttendees in: query required: false description: Minimum Attendees. schema: type: integer - name: maxAttendees in: query required: false description: Maximum Attendees. schema: type: integer - name: sellDate in: query required: false description: Selling Date associated with the Price Details. schema: type: string format: date - name: startDateTime in: query required: false schema: type: string format: date-time - name: endDateTime in: query required: false schema: type: string format: date-time - name: bookingType in: query required: false description: Collection of configured Booking Types for the package property. schema: type: string - name: fetchInstructions in: query description: Fetch instructions that can be used in Catering Packages maintenance. required: false style: form explode: true schema: type: array items: type: string enum: - PackageInfo - Events - Resources - Pricing - Indicators - BlockPackageInfo - EventNotes uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object to fetch Menu . content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cateringPackagesInfo' '204': description: CateringPackages not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig post: summary: Create catering packages description: 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
operationId: postCateringPackages parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel ID schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringPackages' description: Request object for creating new Catering Packages. required: true /hotels/{hotelId}/cateringPackages/{cateringPackageId}: get: summary: Get catering package description: Use this API to get catering package.OperationId:getCateringPackage
operationId: getCateringPackage parameters: - name: cateringPackageId in: path required: true description: Unique Catering Package ID schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel ID schema: type: string maxLength: 2000 minLength: 1 - name: idExtension in: query required: false description: Additional identifying value assigned by the creating system. schema: type: integer - name: idContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: pkgIDType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - name: fetchInstructions in: query description: Fetch instructions that can be used in Catering Packages maintenance. required: false style: form explode: true schema: type: array items: type: string enum: - PackageInfo - Events - Resources - Pricing - Indicators - BlockPackageInfo - EventNotes uniqueItems: true - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object to fetch Menu . content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/cateringPackage' '204': description: CateringPackage not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig put: summary: Update Catering packages description: Update an existing Catering Package for a property.OperationId:putCateringPackages
operationId: putCateringPackages parameters: - name: cateringPackageId in: path required: true description: Unique Catering Package ID schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel ID schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringPackages' description: Request object for changing Catering Packages. required: true delete: summary: Delete catering packages description: Use this API to delete catering packages.OperationId:deleteCateringPackages
operationId: deleteCateringPackages parameters: - name: cateringPackageId in: path required: true description: Unique Package Id schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique Hotel Code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /hotels/{hotelId}/cateringPackages/{cateringPackageId}/copy: post: summary: Operation to copy catering package or template. description: Use this API to copy catering package or template.OperationId:copyCateringPackage
operationId: copyCateringPackage parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code. schema: type: string maxLength: 20 minLength: 1 - name: cateringPackageId in: path required: true description: Unique Catering Package or Template ID. schema: type: string maxLength: 38 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response object of newly copied resource or configuration code. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/resourceCodeInfo' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyCateringPackageType' description: Request object for Copying Catering Package/Template. required: true /hotels/{hotelId}/cateringPackages/{cateringPackageId}/prices/{pricesId}/copy: post: summary: Operation to copy catering package price. description: Use this API to copy catering package price.OperationId:copyCateringPackagePrice
operationId: copyCateringPackagePrice parameters: - name: pricesId in: path required: true description: Unique Catering Package Prices ID schema: type: string maxLength: 38 minLength: 1 - name: cateringPackageId in: path required: true description: Unique Catering Package ID. schema: type: string maxLength: 38 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel ID schema: type: string maxLength: 20 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response object of newly copied resource or configuration code. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/resourceCodeInfo' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/copyCateringPackagePriceType' description: Request object for Copying Catering Package Price. required: true /hotels/{hotelId}/courses/{coursesId}/menuMultiCourses: delete: summary: Remove menu multi courses description: Use this API to remove Menu Multi Courses.OperationId:deleteCateringMenuMultiCourses
operationId: deleteCateringMenuMultiCourses parameters: - name: coursesId in: path required: true description: Unique Menu Multi Course ID schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel ID schema: type: string maxLength: 2000 minLength: 1 - name: courseIdListUniqueIdExtension in: query description: Additional identifying value assigned by the creating system. required: false style: form explode: true schema: type: array items: type: integer - name: courseIdListUniqueIdContext in: query description: Used to identify the source of the identifier (e.g., IATA, ABTA). required: false style: form explode: true schema: type: array items: type: string - name: courseIdListUniqueIdType in: query description: A reference to the type of object defined by the UniqueID element. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /hotels/{hotelId}/dailyInventoryItemQuantities: put: summary: Update Daily Inventory Item Quantities description: You can use this API to add or update multiple Daily Inventory Item quantities and dates.OperationId:putDailyInventoryItemQuantities/p> operationId: putDailyInventoryItemQuantities parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/dailyInventoryItemQuantities' description: Request object for bulk update of Daily Inventory Item quantities required: true /hotels/{hotelId}/dailyInventoryItems: get: summary: Get Daily Item Inventory description: 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.
operationId: getDailyInventoryItems parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - name: itemClassCode in: query required: false description: Item Class ID which daily item belongs to. schema: type: string - name: itemName in: query required: false description: Item name which daily item belongs to. schema: type: string - name: friday in: query required: false schema: type: boolean - name: monday in: query required: false schema: type: boolean - name: saturday in: query required: false schema: type: boolean - name: sunday in: query required: false schema: type: boolean - name: thursday in: query required: false schema: type: boolean - name: tuesday in: query required: false schema: type: boolean - name: wednesday in: query required: false schema: type: boolean - name: startDate in: query required: false schema: type: string format: date - name: endDate in: query required: false schema: type: string format: date - name: duration in: query required: false schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Daily Inventory Items. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/dailyInventoryItems' '204': description: DailyInventoryItems not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /hotels/{hotelId}/discountAvailable/check: get: summary: Check if discount is available description: Check if discount is availableOperationId:checkDiscountAvailable
operationId: checkDiscountAvailable parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel Id schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object to determine whether the discount is availabe for resort or not. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/checkedDiscountAvailable' '204': description: checkDiscountAvailable not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /hotels/{hotelId}/eventForecasts: get: summary: Get Event Forecasts description: This API will allow you to retrieve all Event Forecast for a property.OperationId:getEventForecasts
The maximum allowable limit for this API is 200.
operationId: getEventForecasts parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel ID schema: type: string maxLength: 2000 minLength: 1 - name: fetchInstructions in: query description: Fetch instructions that can be used in event forecast maintenance. x-example: - forecastInfo required: true style: form explode: true schema: type: array items: type: string enum: - ForecastInfo - RevenueDetails uniqueItems: true - name: limit in: query required: false description: Indicates maximum number of records a Web Service should return. schema: type: integer - name: offset in: query required: false 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. schema: type: integer default: 0 - name: eventTypeCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: eventTypeWildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: revenueTypeCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: revenueTypeWildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: eventDate in: query required: false description: Date for which the event is scheduled. schema: type: string format: date - name: blockTypeCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: marketCodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object to fetch Menu . content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/eventForecastsInfo' '204': description: EventForecasts not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /hotels/{hotelId}/events/{eventsId}/revenues/{revenueType}/packages/{priceId}/cateringPackageRevenues: delete: summary: Delete catering package revenues description: Use this API to delete catering package revenues.OperationId:deleteCateringPackageRevenues
operationId: deleteCateringPackageRevenues parameters: - name: priceId in: path required: true description: Unique Catering Packages Revenue Price ID schema: type: string maxLength: 2000 minLength: 1 - name: revenueType in: path required: true description: Unique Catering Packages Revenue Type schema: type: string maxLength: 2000 minLength: 1 - name: eventsId in: path required: true description: Unique Catering Packages Revenue Event ID schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel ID schema: type: string maxLength: 2000 minLength: 1 - name: packagePriceIdExtension in: query required: false description: Additional identifying value assigned by the creating system. schema: type: integer - name: packagePriceIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: packagePriceIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - name: eventIdExtension in: query required: false description: Additional identifying value assigned by the creating system. schema: type: integer - name: eventIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: eventIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /hotels/{hotelId}/inventoryItems: get: summary: Get Item Inventory description: 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.
operationId: getInventoryItems parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - name: itemClassCode in: query required: false description: The Item Class ID which the item belongs to. schema: type: string - name: itemName in: query required: false description: The name of Inventory Item. schema: type: string - name: itemCode in: query required: false description: The code of Inventory Item, also known as Quick Insert. schema: type: string - name: eventTypecodes in: query required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: usedForEvents in: query required: false description: Flag to indicate whether the item is used for events. schema: type: boolean - name: includeItemsFromTemplates in: query required: false description: Indicates whether to include Items from Templates or not. schema: type: boolean - name: startDateTime in: query required: false schema: type: string format: date-time - name: endDateTime in: query required: false schema: type: string format: date-time - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object to fetch Inventory Items Setup configuration content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/inventoryItems' '204': description: InventoryItems not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig post: summary: Create an Item Inventory description: You can use this API to create a new Item Inventory Code for a property.OperationId:postInventoryItems
operationId: postInventoryItems parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response object for creating Inventory Items Setup configurations content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/inventoryItemsCreated' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/inventoryItems' description: Requestion object for creating new Inventory Items Setup configurations required: true /hotels/{hotelId}/inventoryItems/{inventoryItemId}: delete: summary: Delete Item Inventory description: Use this API to delete an existing Item Inventory CodeOperationId:deleteInventoryItems
operationId: deleteInventoryItems parameters: - name: inventoryItemId in: path required: true description: Unique Inventory Item Id schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - name: itemIDExtension in: query required: false description: Additional identifying value assigned by the creating system. schema: type: integer - name: idContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: itemIDType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig put: summary: Update Item Inventory description: Use this API to update an existing Item Inventory CodeOperationId:putInventoryItems
operationId: putInventoryItems parameters: - name: inventoryItemId in: path required: true description: Unique Inventory Item id schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/inventoryItems' description: Request object for changing Inventory Items Setup configuration required: true /upsert/hotels/{hotelId}/inventoryItems: put: summary: Create/Update Item Inventory description: Use this API to create/update an existing Item Inventory CodeOperationId:putUpsertInventoryItems
operationId: putUpsertInventoryItems parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/inventoryItems' description: Request object for changing Inventory Items Setup configuration required: true /hotels/{hotelId}/itemPools: get: summary: Get Item Pools description: Get Item Pools that are configured for a property.OperationId:getItemPools
operationId: getItemPools parameters: - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - name: hotelIds in: query description: Hotel code. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: itemClasseCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: itemPoolCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: itemPoolsWildCard in: query required: false description: Wildcard search on the code. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object which holds collection of Item Pools. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/itemPoolsInfo' '204': description: ItemPools not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /hotels/{hotelId}/itemPools/{itemPoolsCode}/itemPools: delete: summary: Delete Item Pools description: Delete Item Pool for a property.OperationId:deleteItemPools
operationId: deleteItemPools parameters: - name: itemPoolsCode in: path required: true description: Unique Item Pool code schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /hotels/{hotelId}/notes/{notesId}/cateringPackageResourceNotes: delete: summary: Delete catering package resource notes description: Use this API to delete catering package resource notes.OperationId:deleteCateringPackageResourceNotes
operationId: deleteCateringPackageResourceNotes parameters: - name: notesId in: path required: true description: Unique Catering Package Resource Notes ID schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel ID schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /hotels/{hotelId}/packageEvents/{packageEventsId}/cateringPackageEvents: delete: summary: Delete catering package events description: Use this API to delete catering package events.OperationId:deleteCateringPackageEvents
operationId: deleteCateringPackageEvents parameters: - name: packageEventsId in: path required: true description: Unique Package Events ID schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel ID schema: type: string maxLength: 2000 minLength: 1 - name: pkgEventIdExtension in: query required: false description: Additional identifying value assigned by the creating system. schema: type: integer - name: pkgEventIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: pkgEventIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /hotels/{hotelId}/packagePrices/{pricesId}/cateringPackagePrices: delete: summary: Delete Catering package prices description: Use this API to delete Catering package prices.OperationId:deleteCateringPackagePrices
operationId: deleteCateringPackagePrices parameters: - name: pricesId in: path required: true description: Unique Catering Package Prices ID schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel ID schema: type: string maxLength: 2000 minLength: 1 - name: packagPriceIdExtension in: query required: false description: Additional identifying value assigned by the creating system. schema: type: integer - name: packagPriceIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: packagPriceIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /hotels/{hotelId}/packages/{eventId}/notes/{notedId}/cateringPackageEventNotes: delete: summary: Delete catering package event notes description: Use this API to delete catering package event notes.OperationId:deleteCateringPackageEventNotes
operationId: deleteCateringPackageEventNotes parameters: - name: notedId in: path required: true description: Unique Catering Package Event Notes ID schema: type: string maxLength: 2000 minLength: 1 - name: eventId in: path required: true description: Unique Catering Package Event ID schema: type: string maxLength: 2000 minLength: 1 - name: hotelId in: path required: true description: Unique OPERA Hotel ID schema: type: string maxLength: 2000 minLength: 1 - name: pkgEventIdExtension in: query required: false description: Additional identifying value assigned by the creating system. schema: type: integer - name: pkgEventIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: pkgEventIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - name: noteIdExtension in: query required: false description: Additional identifying value assigned by the creating system. schema: type: integer - name: noteIdContext in: query required: false description: Used to identify the source of the identifier (e.g., IATA, ABTA). schema: type: string - name: noteIdType in: query required: false description: A reference to the type of object defined by the UniqueID element. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /hotels/{sourceHotelId}/inventoryItems/copy: put: summary: Copy Item Inventories description: This API will allow you to select multiple Item Inventories from the Source Property and copy to the Target Property.OperationId:copyInventoryItems
operationId: copyInventoryItems parameters: - name: sourceHotelId in: path required: true description: Unique ID of source hotel. schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/inventoryItemsCopy' description: Request object for copying Inventory Items Setup configuration required: true /inventoryItems: get: summary: Get Item Inventory templates description: Retrieve a list of Item Inventory templates that exist for a property.OperationId:getInventoryItemTemplates
operationId: getInventoryItemTemplates parameters: - name: hotelId in: query required: false description: Specifies the hotel code to be searched. schema: type: string - name: inventoryItemTemplateName in: query required: false description: Wildcard search for the inventory item template. schema: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching inventory item templates. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/inventoryItemTemplates' '204': description: InventoryItemTemplates not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig post: summary: Create Item Inventory template description: Create an Item Inventory template.OperationId:postInventoryItemTemplates
operationId: postInventoryItemTemplates parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/inventoryItemTemplates' description: Request object for creating new inventory item templates. required: true /inventoryItems/{inventoryItemId}: delete: summary: Delete Item Inventory templates description: Delete Item Inventory template.OperationId:deleteInventoryItemTemplates
operationId: deleteInventoryItemTemplates parameters: - name: inventoryItemId in: path required: true description: Unique Inventory Item Template code schema: type: string maxLength: 2000 minLength: 1 - name: inventoryItemTemplatesIdExtension in: query description: Additional identifying value assigned by the creating system. required: false style: form explode: true schema: type: array items: type: integer - name: inventoryItemTemplatesContext in: query description: Used to identify the source of the identifier (e.g., IATA, ABTA). required: false style: form explode: true schema: type: array items: type: string - name: inventoryItemTemplatesType in: query description: A reference to the type of object defined by the UniqueID element. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig put: summary: Change Item Inventory templates description: Change Item Inventory template.OperationId:putInventoryItemTemplates
operationId: putInventoryItemTemplates parameters: - name: inventoryItemId in: path required: true description: Unique Inventory Item Template code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/inventoryItemTemplates' description: Request object for changing existing inventory item templates. required: true /itemClasses: get: summary: Get item classes description: 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
operationId: getItemClasses parameters: - name: hotelId in: query required: false schema: type: array items: type: string maxItems: 4000 - name: itemClassesCode in: query required: false description: Codes to be searched. schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: criteria in: query x-example: reservation required: false description: Defines values for Item Class Type. schema: type: string enum: - Reservation - Events - Leisure - ReservationAndEvents - EventsAndLeisure - LeisureAndReservation - ReservationAndEventsAndLeisure uniqueItems: true - name: classId in: query required: false schema: type: number - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching item class. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/itemClassesInfo' '204': description: ItemClasses not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig post: summary: Create item classes description: You can use this API to create item classes.OperationId:postItemClasses
operationId: postItemClasses parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/itemClasses' description: Request object for creating new item class. required: true /itemClasses/copy: put: summary: Copy item classes description: You can use this API to copy item classes.OperationId:copyItemClasses
operationId: copyItemClasses parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/itemClassesCopy' description: List of the Item Class to be copied. required: true /itemClasses/{itemClassesCode}: put: summary: Update item classes description: This API allows you to update existing Item Classes for a property.OperationId:putItemClasses
operationId: putItemClasses parameters: - name: itemClassesCode in: path required: true description: Unique Item Class Code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/itemClasses' description: Request object for modifying item class. required: true delete: summary: Delete Item classes description: This API allows you to delete an existing Item Classes for a property.OperationId:deleteItemClasses
operationId: deleteItemClasses parameters: - name: itemClassesCode in: path required: true description: Unique Item Class Code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /upsert/itemClasses/{itemClassesCode}: put: summary: Create/Update item classes description: This API allows you to create/update existing Item Classes for a property.OperationId:putUpsertItemClasses
operationId: putUpsertItemClasses parameters: - name: itemClassesCode in: path required: true description: Unique Item Class Code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/itemClasses' description: Request object for modifying item class. required: true /itemPools: post: summary: Create Item Pools description: 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
operationId: postItemPools parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/itemPools' description: Request object which holds new Item Pools. required: true /itemPools/{itemPoolsCode}: post: summary: Change Item Pools description: Change/update an Item Pool that is already configured for a property.OperationId:putItemPools
operationId: putItemPools parameters: - name: itemPoolsCode in: path required: true description: Unique Item Pool code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/itemPools' description: Request object which holds modified Item Pools. required: true /upsert/itemPools/{itemPoolsCode}: post: summary: Create/Change Item Pools description: Create/Change/update an Item Pool that is already configured for a property.OperationId:putUpsertItemPools
operationId: putUpsertItemPools parameters: - name: itemPoolsCode in: path required: true description: Unique Item Pool code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/itemPools' description: Request object which holds modified Item Pools. required: true /menuClasses/{menuClassesId}/cateringMenuClasses: delete: summary: Delete menu classes description: You can use this API to delete menu classes.OperationId:deleteCateringMenuClasses
operationId: deleteCateringMenuClasses parameters: - name: menuClassesId in: path required: true description: Unique Catering Menu Class ID schema: type: string maxLength: 2000 minLength: 1 - name: menuClassListIDExtension in: query description: Additional identifying value assigned by the creating system. required: false style: form explode: true schema: type: array items: type: integer - name: menuClassListIdContext in: query description: Used to identify the source of the identifier (e.g., IATA, ABTA). required: false style: form explode: true schema: type: array items: type: string - name: menuClassListUniqueIdType in: query description: A reference to the type of object defined by the UniqueID element. required: false style: form explode: true schema: type: array items: type: string - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /revenueGroups: get: summary: Get Catering Revenue Groups description: You can use this API to retrieve all catering revenue group codes.OperationId:getRevenueGroups
operationId: getRevenueGroups parameters: - name: fetchInactive in: query required: false description: Determines wether to fetch inactive records or not. schema: type: boolean - name: revenueGroupCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: wildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: description in: query required: false description: Description of the code. schema: type: string - name: includeRevenueType in: query required: false description: Boolean flag to fetch revenue groups with/without revenue types. 'True' indicates including revenue types information for corresponding revenue groups. schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Catering Revenue Groups configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/revenueGroupsInfo' '204': description: RevenueGroups not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig post: summary: Create Catering Revenue Groups description: You can use this API to create a new catering revenue group code.OperationId:postRevenueGroups
operationId: postRevenueGroups parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/revenueGroups' description: Request object for creating new Catering Revenue Groups Configurations. required: true /revenueGroups/{revenueGroupsCode}: put: summary: Update Catering Revenue Groups description: You can use this API to update a catering revenue group Code.OperationId:putRevenueGroups
operationId: putRevenueGroups parameters: - name: revenueGroupsCode in: path required: true description: Unique Revenue Group Code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/revenueGroups' description: Request object for changing existing Catering Revenue Groups Configurations. required: true delete: summary: Delete Catering Revenue Groups description: You can use this API to delete a catering revenue group code.OperationId:deleteRevenueGroups
operationId: deleteRevenueGroups parameters: - name: revenueGroupsCode in: path required: true description: Unique Revenue Group Code schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig /revenueTypes: get: summary: Get Catering Revenue Types description: You can use this API to retrieve all Catering Revenue Type codes configured.OperationId:getRevenueTypes
operationId: getRevenueTypes parameters: - name: revenueGroupCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: revenueGroupWildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: revenueTypeCodes in: query description: Codes to be searched. required: false style: form explode: true schema: type: array items: type: string maxItems: 4000 - name: revenueTypeWildCard in: query required: false description: Wildcard search on the code. schema: type: string - name: includeInactive in: query required: false description: If true this boolean will set the criteria to only return Inactive records. schema: type: boolean - name: includeRevenueTypeDetail in: query required: false 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) schema: type: boolean - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' description: Response object for fetching Revenue Types Setup configurations. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/revenueTypesInfo' '204': description: RevenueTypes not found. '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig post: summary: Create Catering Revenue Types description: You can use this API to create a new Catering Revenue Type code.OperationId:postRevenueTypes
operationId: postRevenueTypes parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '201': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: HATEOAS links which help the consumer to navigate to resources content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/revenueTypes' description: Request object for creating new Revenue Types Setup Configurations. required: true /revenueTypes/{revenueTypesId}: put: summary: Update Catering Revenue Types description: You can use this API to update a Catering Revenue Type code.OperationId:putRevenueTypes
operationId: putRevenueTypes parameters: - name: revenueTypesId in: path required: true description: Unique code for Revenue Type schema: type: string maxLength: 2000 minLength: 1 - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/revenueTypes' description: Request object for changing existing Revenue Types Setup Configurations. required: true /upsert/cateringMenuClasses: put: summary: Create/Update catering menu classes description: You can use this API to create/update menu classes.OperationId:putUpsertCateringMenuClasses
operationId: putUpsertCateringMenuClasses parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringMenuClasses' description: Request object for changing Menu Classes. required: true /upsert/cateringMenuItemClasses: put: summary: Create/Update menu item classes description: You can use this API to create/update menu item classes.OperationId:putUpsertCateringMenuItemClasses
operationId: putUpsertCateringMenuItemClasses parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/cateringMenuItemClasses' description: Request object for updating Menu Item Classes. required: true /upsert/eventForecasts: put: summary: Create/Update Event forecasts description: This API will allow you to create/update an Event Forecast for a property.OperationId:putUpsertEventForecasts
operationId: putUpsertEventForecasts parameters: - $ref: '#/components/parameters/authKey' - $ref: '#/components/parameters/externalData' - $ref: '#/components/parameters/x-app-key' - $ref: '#/components/parameters/x-request-id' - $ref: '#/components/parameters/x-originating-application' - $ref: '#/components/parameters/x-hotelid' - $ref: '#/components/parameters/x-externalsystem' - $ref: '#/components/parameters/Accept-Language' responses: '200': headers: Content-Language: description: Audience language x-example: en-GB schema: type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' Location: description: Location of newly created resource schema: type: string description: Response Body. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/status' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '413': $ref: '#/components/responses/413' '414': $ref: '#/components/responses/414' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' '503': $ref: '#/components/responses/503' tags: - ResourceConfig requestBody: content: application/json;charset=UTF-8: schema: allOf: - $ref: '#/components/schemas/eventForecasts' required: true components: schemas: cateringPackageEventResourceType: type: object description: Type used for managing Resources associated with a particular Catering Package Event. properties: resourceId: description: Unique Identifier for a Resource associated with a particular Catering Package Event. type: string minLength: 0 maxLength: 20 type: description: Resource Type associated with the Catering Package Event. $ref: '#/components/schemas/eventResourceType' name: description: Name of the Resource. type: string minLength: 0 maxLength: 200 roomSetup: description: Setup code of th Function Space. type: string minLength: 0 maxLength: 20 roomRate: description: RateCode associated with the Function Space. type: string minLength: 0 maxLength: 20 revenueTypes: description: List of revenue types associated with the resource $ref: '#/components/schemas/codeListType' isShareable: description: Defines if the Function Space is shareable. type: boolean quantity: description: Defines the quantity of the Item. type: integer orderBy: description: Defines the Display Order of the Item or Pickup Sequence during the booking process for a Function Space. type: integer itemAttribute: description: Defines the ID of the Item Attribute associated with the Item. $ref: '#/components/schemas/uniqueID_Type' itemRate: description: Rate Code associated with the Item. type: string minLength: 0 maxLength: 20 price: description: Price defined for a CUSTOM Rate Code associated with the Item. $ref: '#/components/schemas/currencyAmountType' resourceNotes: description: Collection of Notes associated with the Catering Package Event Resource. $ref: '#/components/schemas/cateringPackageResourceNoteListType' translationTextType200: type: object description: Contains Multiple translated texts and language codes. properties: defaultText: description: Default text with Character length from 0 to 200. type: string minLength: 0 maxLength: 200 translatedTexts: description: List of translated text and language codes. $ref: '#/components/schemas/translationsTextType' dailyInventoryItems: type: object description: Response object for creating new Catering Packages. properties: dailyItems: description: Collection of Daily Inventory Items. $ref: '#/components/schemas/dailyInventoryItemsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' eventForecastRevDetailListType: type: array description: Collection of Event Forecast Revenue Details. maxItems: 4000 items: $ref: '#/components/schemas/eventForecastRevDetailType' cateringMenuItemClassListType: type: array description: List of Values of Menu Item Class. maxItems: 4000 items: $ref: '#/components/schemas/cateringMenuItemClassType' cateringPackageType: type: object description: Type used for managing Catering Package. properties: pkgId: description: Unique Identifier for a Catering Package. $ref: '#/components/schemas/uniqueID_Type' hotelId: description: Hotel Code associated with the Catering Package. type: string minLength: 0 maxLength: 20 packageDetail: description: Provides information about the Catering Package. $ref: '#/components/schemas/cateringPackageInfoType' eventsList: description: Provides Events details associated to the Catering Package. $ref: '#/components/schemas/cateringPackageEventListType' pricingList: description: Provides Pricing details associated to the Catering Package. $ref: '#/components/schemas/cateringPackagePricingListType' cateringPackageEventListType: type: array description: Collection of multiple Events associated with a particular Catering Packages. maxItems: 4000 items: $ref: '#/components/schemas/cateringPackageEventType' cateringMenuItemClasses: type: object description: Request object for updating Menu Item Classes. properties: menuItemClasses: description: Menu Item Classes to be changed. $ref: '#/components/schemas/cateringMenuItemClassListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cateringMenusInfo: type: object description: Response object to fetch Menu . properties: menuList: description: Collection of Menu . $ref: '#/components/schemas/cateringMenuListType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' revenueGroupsInfo: type: object description: Response object for fetching Catering Revenue Groups configurations. properties: revenueGroups: description: Collection of Catering Revenue Groups configurations. $ref: '#/components/schemas/revenueGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' eventForecasts: type: object properties: eventForecasts: description: Consists of modified Event Forecasts to be saved. $ref: '#/components/schemas/eventForecastListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cateringItemRates: type: object description: Request object which holds modified Catering Code's Item Rate. properties: itemRates: description: Collection of Item Rates to be changed. $ref: '#/components/schemas/cateringCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' dailyInventoryItemType: type: object description: Details of Daily Inventory Items. properties: itemId: description: The id of the daily Item Inventory. $ref: '#/components/schemas/uniqueID_Type' itemName: description: The Name of the Daily Item from Inventory. $ref: '#/components/schemas/translationTextType200' itemDescription: description: The Description of the Daily Item from Inventory. type: string minLength: 0 maxLength: 2000 itemClassId: description: The Item Class ID which the Daily Item belongs to. $ref: '#/components/schemas/uniqueID_Type' itemClassCode: description: The Item Class Code which the Daily Item belongs to. type: string minLength: 0 maxLength: 20 quantityInStock: description: Item quantity in Stock of the Daily Item from Inventory. type: number dailyItemQuantityByDate: description: List of Daily quantity for Item by date/dates. type: array maxItems: 4000 items: $ref: '#/components/schemas/itemQuantityDateType' hotelId: description: The Hotel code which the daily item belongs to. type: string minLength: 0 maxLength: 20 cateringPackageEventType: type: object description: Type used for managing Events associated with a particular Catering Package. properties: id: description: Unique Identifier for a Event associated with a particular Catering Package. $ref: '#/components/schemas/uniqueID_Type' masterEventId: description: Master Event associated with the Catering Package Event. $ref: '#/components/schemas/uniqueID_Type' eventType: description: Event Type associated with the Catering Package Event. type: string minLength: 0 maxLength: 20 eventName: description: Event Name for the Catering Package Event. type: string minLength: 0 maxLength: 60 dayOrder: description: Event Day for the Catering Package Event. type: integer eventTime: description: Start/End Time details for the Catering Package Event. $ref: '#/components/schemas/dateTimeSpanType' room: description: Room details for the Catering Package Event. type: string minLength: 0 maxLength: 20 roomSetup: description: Room Setup details for the Catering Package Event. type: string minLength: 0 maxLength: 20 roomRateCode: description: Stores the selected rate code for the meeting room. type: string minLength: 0 maxLength: 20 isMaster: description: Indiciates if this package event has sub-events. type: boolean isShareable: description: Indicates if the function space should be booked as sharable. type: boolean alternate: description: Indicates if the function space requires an alternate space. type: boolean sub: description: Indicates if the package event is a sub-event or not. type: boolean notes: description: Collection of Notes associated with the Catering Package Event. $ref: '#/components/schemas/cateringPackageEventNoteListType' resources: description: Collection of Resources associated with the Catering Package Event. $ref: '#/components/schemas/cateringPackageResourceListType' eventForecastsListType: type: object description: Collection of Event Forecast details that needs to be copied. properties: sourceHotelCode: description: Property from which Code is to be copied. type: string minLength: 0 maxLength: 20 targetHotelCode: description: Property to which configuration code type to be copied to. type: string minLength: 0 maxLength: 20 sourceForecastId: description: Unique Identifier from which event forecast to be copied. $ref: '#/components/schemas/uniqueID_Type' sourceEventType: description: Source Event Type from which code is to be copied from. type: string minLength: 0 maxLength: 20 copyEventTypeAs: description: Event Type will be copied From. type: string minLength: 0 maxLength: 20 copyDateRangeAs: description: Start Date and End Date for the event forecast to be copied. $ref: '#/components/schemas/dateRangeType' copyMarketCodeAs: description: Copy Market code as. type: string minLength: 0 maxLength: 20 copyBookingTypeAs: description: Copy Booking Type as. type: string minLength: 0 maxLength: 20 cateringMenuItemClassInfoType: type: object properties: hotelId: description: The Hotel code which the menu item class belongs to type: string minLength: 0 maxLength: 20 className: description: Menu Item Class Name type: string minLength: 0 maxLength: 200 eventTypeList: description: Event types associated with the Menu Class $ref: '#/components/schemas/codeListType' responsibleDepartmentList: description: Departments associated with the MenuClass $ref: '#/components/schemas/codeListType' menuType: description: Menu Type information, it is either Beverage or Food $ref: '#/components/schemas/menuTypeType' sequence: description: Sequence of the Menu Class type: integer webBookable: description: Boolean value indicates whether the Menu Class is web bookable or not type: boolean iconName: description: Icon Name of the Menu Class type: string minLength: 0 maxLength: 30 managedBy: $ref: '#/components/schemas/managedByOptions' code: description: Field for unique code identifier for Menu Item Class. type: string minLength: 0 maxLength: 20 cateringMenuDetailType: type: object description: Detailed attributes of Menu Item. properties: id: description: The menu item class unique ID $ref: '#/components/schemas/uniqueID_Type' hotelId: description: The Hotel code which the menu item class belongs to type: string minLength: 0 maxLength: 20 classInfo: description: Displays the Menu Item Name noted in the Menu Item Configuration. $ref: '#/components/schemas/codeDescriptionType' displayOrder: description: Defines the Display Order of the menu item class, to which the menu item is attached type: integer name1: description: First value of menu item which belongs to a menu item class $ref: '#/components/schemas/translationTextType2000' name2: description: Seond value of menu item which belongs to a menu item class $ref: '#/components/schemas/translationTextType2000' name3: description: Third value of menu item which belongs to a menu item class $ref: '#/components/schemas/translationTextType2000' origin1: description: The values entered here most commonly reference a Wine, Meat origin if Restaurant features a Local Farm $ref: '#/components/schemas/translationTextType2000' origin2: description: The values entered here most commonly reference a Wine, Meat origin if Restaurant features a Local Farm $ref: '#/components/schemas/translationTextType2000' menuType: description: Type of Menu -Food or Beverage $ref: '#/components/schemas/menuTypeType' custom: description: Indicates whether this menu item is custom type: boolean year: description: This value is typically the year of the Wine type: integer restriction: description: Any particular restriction description in 100 charactera type: string minLength: 0 maxLength: 100 description: description: Detailed description of menu items in 100 characters $ref: '#/components/schemas/translationTextType2000' dietaryPreferenceList: description: list of configured Dietary preferences $ref: '#/components/schemas/dietaryPrefListType' eventTypes: description: Field will be inherited values from the Menu Item Class associated for Event Types. $ref: '#/components/schemas/codeListType' responsibleDepartments: description: Department Code(s) will be displayed in the field for a particular menu item $ref: '#/components/schemas/codeListType' quickInsertCode: description: Article number in Caps of menu item type: string minLength: 0 maxLength: 20 revenueType: description: RevenueType of Menu Item type: string minLength: 0 maxLength: 20 salesPrice: description: Price of Menu Item , Numeric currency value field conforming to Currency Format for the selected Property. $ref: '#/components/schemas/currencyAmountType' cost: description: Actual Cost of Menu Item $ref: '#/components/schemas/currencyAmountType' itemConsumption: description: Selection of this notes that the price defined is charged 'as-consumed' basis type: boolean container: description: Code and description of the container to be used by Menu Item $ref: '#/components/schemas/codeDescriptionType' portion: description: Portion of the menu item $ref: '#/components/schemas/translationTextType2000' servings: description: Numeric value of servings of Menu item type: integer webBookable: description: Check of Menu Item if it is web bookable type: boolean print: description: check if Print action is required for menu item type: boolean inactive: description: Check for the status of menu item type: boolean includedYN: description: Included flag type: boolean course: description: Course number defined will be the display order of the Menu Items on the screen and in Banquet Event Order. type: string minLength: 0 maxLength: 20 order: description: Order of Menu. type: string minLength: 0 maxLength: 20 demandFactor: description: Demand Factor of the Menu. type: string minLength: 0 maxLength: 20 menuName: description: Holds the value of Menu name. type: string minLength: 0 maxLength: 30 includedMenu: description: Return true means, menu as Included in the Menu Price type: boolean mandatory: description: Return true means, menu as Included in the Menu Price type: boolean cateringMenusCopy: type: object description: Request object for copying Menu . properties: copyCateringMenus: description: Copy Menu criteria type to copy multiple Menu. $ref: '#/components/schemas/copyCateringMenuType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' eventForecastsInfo: type: object properties: eventForecasts: description: Collection of Event Forecasts. $ref: '#/components/schemas/eventForecastListType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cateringServingsInfo: type: object description: Response object for fetching Catering Code's Serving details. properties: servings: description: Collection of Catering's Serving Details. $ref: '#/components/schemas/cateringCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' itemVendorsType: type: array description: List of Item Vendors. maxItems: 4000 items: $ref: '#/components/schemas/itemVendorType' warningsType: type: array description: Used in conjunction with the Success element to define a business error. maxItems: 4000 items: $ref: '#/components/schemas/warningType' cateringMenuItemsCopy: type: object description: Request object for Copying Menu Items. properties: copyMenuItems: description: List of Menu Items to be copied. $ref: '#/components/schemas/copyMenuItemsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' inventoryItems: type: object description: Response object to fetch Inventory Items Setup configuration properties: items: description: Collection of Inventory Items Setup configurations $ref: '#/components/schemas/inventoryItemsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyInventoryItemsType: type: object description: Copy Inventory Items criteria type to copy multiple Inventory Items from one Hotel to other Hotels. properties: copyInventoryItem: description: The details of Inventory Items to be copied. type: array maxItems: 4000 items: $ref: '#/components/schemas/copyInventoryItemType' hotelId: description: Hotel Code from which Inventory Items are being copied. type: string minLength: 0 maxLength: 20 includeRates: description: If true, include to copy the Item Rates. type: boolean includeAttributes: description: If true, include to copy the Item Attributes. type: boolean includeVendors: description: If true, include to copy the Item Vendor. type: boolean eventForecastsCopy: type: object description: Request object for Copying Event Forecasts to multiple hotels. properties: criteria: description: Criteria for copying Event Forecasts. $ref: '#/components/schemas/copyEventForecastsCriteriaType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' inventoryItemsType: type: array description: List of Inventory Items. maxItems: 4000 items: $ref: '#/components/schemas/inventoryItemType' copyMenuItemClassesType: type: object properties: sourceHotelCode: description: Source Hotel code from where menu item classes needs to be copied type: string minLength: 0 maxLength: 20 itemClasses: description: Menu Item classes of to be copied $ref: '#/components/schemas/uniqueIDListType' targetHotelCodes: description: Target Hotel code where menu item classes need to be copied $ref: '#/components/schemas/codeListType' copyInstructions: description: Instructions which will be considered when copying from the template. If this element is not sent, all the flags will be ignored. type: object properties: associatedItems: description: When true, this will copy the source block's room allocation counts to the new block. type: boolean cateringMenuItemClassType: type: object description: Menu Item Class Values. properties: id: description: The menu item class unique ID $ref: '#/components/schemas/uniqueID_Type' itemClassInfo: description: The menu item class detailed info $ref: '#/components/schemas/cateringMenuItemClassInfoType' itemList: description: The menu items detailed attribute which belongs to particular menu item class $ref: '#/components/schemas/cateringMenuItemListType' inventoryItemTemplatesType: type: array description: This type holds a collection of inventory item templates. maxItems: 4000 items: $ref: '#/components/schemas/inventoryItemTemplateType' revenueTypeDetailsType: type: array description: List of Revenue details associated to a Revenue Type (Additional Details) maxItems: 4000 items: $ref: '#/components/schemas/revenueTypeDetailType' uniqueID_Type: type: object description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). properties: id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 currencyAmountType: type: object description: A monetary value expressed with a currency code. properties: amount: description: A monetary amount. type: number currencyCode: description: Provides a currency code to reflect the currency in which an amount may be expressed. type: string minLength: 3 maxLength: 3 cateringMenuRevListType: type: array description: This type holds revenue list. maxItems: 4000 items: $ref: '#/components/schemas/cateringMenuRevType' dailyAvailableInventoryItemType: type: object description: Contains Daily Availability inventory item quantity details properties: startDate: description: Starting date for the daily availability. type: string format: date maxLength: 8 endDate: description: Ending date for the daily availability. type: string format: date maxLength: 8 quantity: description: Quantity of item inventoy which will be availaible based on daily. type: number minimum: 0 maximum: 100 sunday: type: boolean monday: type: boolean tuesday: type: boolean wednesday: type: boolean thursday: type: boolean friday: type: boolean saturday: type: boolean copyMenuItemsType: type: object properties: hotelId: description: Source Hotel code from where menu items needs to be copied type: string minLength: 0 maxLength: 20 menuItemList: description: Source menu items to be copied $ref: '#/components/schemas/cateringMenuItemListType' menuItemClassList: description: Target Menu Classes where menu items need to be copied $ref: '#/components/schemas/cateringMenuItemClassListType' cateringMenuClassListType: type: array description: List of Values of Menu. maxItems: 4000 items: $ref: '#/components/schemas/cateringMenuClassType' cateringPackageResourceNoteListType: type: array description: Collection of multiple Resource Notes associated with a particular Catering Package Resource. maxItems: 4000 items: $ref: '#/components/schemas/cateringPackageResourceNoteType' copyCateringMenuType: type: object properties: menuId: description: This type holds the menu id which will be copied. $ref: '#/components/schemas/uniqueID_Type' hotelId: description: Source Hotel code from where the menu will be copied. type: string minLength: 0 maxLength: 20 menuClassList: description: Target Menu Class list where the menu will be copied to. $ref: '#/components/schemas/cateringMenuClassListType' cateringServings: type: object description: Request object which holds modified Catering Code's Serving. properties: servings: description: Collection of Serving to be changed. $ref: '#/components/schemas/cateringCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' revenueGroupsType: type: array description: Details for Catering Revenue Group along with associated Revenue Type codes. maxItems: 4000 items: $ref: '#/components/schemas/revenueGroupType' itemClassTypeType: type: string description: Defines values for Item Class Type. enum: - Reservation - Events - Leisure - ReservationAndEvents - EventsAndLeisure - LeisureAndReservation - ReservationAndEventsAndLeisure copyConfigurationCodeType: type: object description: Information needed to copy configuration code from one property to the other. properties: targetHotelCode: description: Property to which configuration code type to be copied to. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 sourceHotelCode: description: Code that is to be copied. type: string minLength: 0 maxLength: 20 code: description: Source hotel code from which code is to be copied from. type: string minLength: 0 maxLength: 20 codeListType: type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 dailyInventoryItemQuantities: type: object description: Collection of Inventory Items for bulk update of daily dates and quantities properties: dailyInventoryItems: type: array description: List of Daily Inventory Quantities. maxItems: 200 items: $ref: '#/components/schemas/dailyInventoryItemQuantityType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' instanceLink: type: object description: Metadata describing link description objects that MAY appear in the JSON instance representation. properties: href: description: URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true. type: string rel: description: Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile. type: string templated: description: Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false. type: boolean default: false method: description: HTTP method for requesting the target of the link. type: string enum: - GET - POST - PUT - DELETE - PATCH - OPTIONS - HEAD targetSchema: description: Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.. type: string operationId: description: The operationId of the path you can call to follow this link. This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply. type: string title: description: Exact copy of the "summary" field on the linked operation. type: string copyEventForecastsCriteriaType: type: object description: Copy event forecasts criteria type to copy multiple event forecasts from one Hotel to another Hotel. properties: eventForecastsList: description: Provides Event Forecast details that needs to be copied. type: array maxItems: 4000 items: $ref: '#/components/schemas/eventForecastsListType' includeRevenueType: description: include Revenue Types for the event forecasts? type: boolean cateringMenuItems: type: object description: Request object for changing Menu Items. properties: cateringMenuItems: description: Menu Items to be changed. $ref: '#/components/schemas/cateringMenuItemListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' eventForecastRevDetailType: type: object description: Revenue Details for a revenue type attached to an event forecast. properties: revenueType: description: Denotes the Revenue Type for an event forecast. $ref: '#/components/schemas/codeDescriptionType' amount: description: Forecast Amount associated to the Revenue Type. $ref: '#/components/schemas/currencyAmountType' amountType: description: Denotes whether Forecast type is per person or flat amount. $ref: '#/components/schemas/forecastRevenueAmountTypeType' dietaryPrefListType: type: array maxItems: 4000 items: $ref: '#/components/schemas/dietaryPrefType' cateringMultiChoiceMenuListType: type: array description: This type holds Multi choice Menu. maxItems: 4000 items: $ref: '#/components/schemas/cateringMultiChoiceMenuType' cateringPackages: type: object description: Request object for changing Catering Packages. properties: cateringPackageList: description: Catering Packages to be changed $ref: '#/components/schemas/cateringPackageListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' status: type: object description: Response Body. properties: warnings: $ref: '#/components/schemas/warningsType' links: $ref: '#/components/schemas/links' cateringPackageEventNoteType: type: object description: Type used for managing Event Notes associated with a particular Catering Package Event. properties: id: description: Unique Identifier for a Note associated with a particular Catering Package Event. $ref: '#/components/schemas/uniqueID_Type' noteCode: description: Note Code/Type of the Catering Package Event Note. type: string minLength: 0 maxLength: 20 title: description: Title of the Catering Package Event Note. type: string minLength: 0 maxLength: 200 comment: description: Comment associated the Catering Package Event Note. type: string minLength: 0 maxLength: 2000 internal: description: Indiciates if this is Internal. type: boolean createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 cateringPackageEventNoteListType: type: array description: Collection of multiple Event Notes associated with a particular Catering Package Event. maxItems: 4000 items: $ref: '#/components/schemas/cateringPackageEventNoteType' cateringMenuClassesInfo: type: object description: Response object to fetch Menu Classes. properties: menuClassList: description: Collection of Menu classes. $ref: '#/components/schemas/cateringMenuClassListType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cateringPackageInfoType: type: object description: Catering Package details. properties: pkgCode: description: Package Code associated with the Catering Package. type: string minLength: 0 maxLength: 20 description: description: Description/Name of the Catering Package. $ref: '#/components/schemas/translationTextType200' duration: description: Duration (in days) of the Catering Package. type: integer webBookable: description: Defines if web booking is allowed. type: boolean isTemplate: description: Defines if Catering Package is a Template or not. type: boolean itemAttributesType: type: array description: List of Item Attributes. maxItems: 4000 items: $ref: '#/components/schemas/itemAttributeType' dateTimeSpanType: type: object description: Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to add to the StartDate to yield end date. properties: startDateTime: type: string format: date-time endDateTime: type: string format: date-time cateringPackagesInfo: type: object properties: pkgTmplts: description: Collection of Catering Packages. $ref: '#/components/schemas/cateringPackageListType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cateringPackageResourceListType: type: array description: Collection of multiple Resources associated with a particular Catering Package Event. maxItems: 4000 items: $ref: '#/components/schemas/cateringPackageEventResourceType' itemPoolType: type: object description: A type which holds the Item pool. properties: hotelId: description: Hotel Code which belong to Item Pool type: string minLength: 0 maxLength: 20 code: description: Item Pools Code type: string minLength: 0 maxLength: 20 description: description: Description of the Item Pool code. type: string minLength: 0 maxLength: 200 itemClass: description: Item Class which associated to Item codes. type: string minLength: 0 maxLength: 20 displaySequence: description: Sequence of Item Pool code. type: number itemIds: description: List of Item Id which belongs to Item Pools Code $ref: '#/components/schemas/itemIDListType' managedBy: $ref: '#/components/schemas/managedByOptions' servingType: type: string description: Serving enum: - Pp - Pt eventResourceNoteType: type: object description: Contains the event resource's note information. properties: noteId: description: Unique identifier for event resource note. If it is missing, this indicate that it is a new note. If only NoteID is provided then it is a delete operation $ref: '#/components/schemas/uniqueID_Type' noteCode: description: Note code. type: string minLength: 0 maxLength: 20 internal: description: Indicates if the note is internal use only. type: boolean noteTitle: description: Contains note title. type: string minLength: 0 maxLength: 200 note: description: Contains note text. type: string minLength: 0 maxLength: 2000 sequence: description: Contains display sequence. type: integer createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 eventForecastInfoType: type: object description: Associated Information for an event forecast. properties: eventType: description: Event Type for which the forecast is associated. $ref: '#/components/schemas/codeDescriptionType' blockType: description: Block type for which the forecast is associated. type: string minLength: 0 maxLength: 20 marketCode: description: Market code for which the forecast is associated. type: string minLength: 0 maxLength: 20 dateRange: description: Start Date and End Date for the event forecast. $ref: '#/components/schemas/dateRangeType' inventoryItemTemplateType: type: object description: This gives detailed information about an inventory item template. properties: hotelId: description: Specifies the hotel code for which the inventory item template is defined. type: string minLength: 0 maxLength: 20 inventoryItemTemplateId: description: Specifies the inventory item template ID. $ref: '#/components/schemas/uniqueID_Type' inventoryItemTemplateName: description: Specifies the name of the inventory item template. type: string minLength: 0 maxLength: 40 inventoryItemTemplateItems: description: Collection of inventory items which are grouped together in the inventory item template. $ref: '#/components/schemas/inventoryItemTemplateItemsType' codeDescriptionType: type: object description: This contains a generic code and description information. properties: code: description: Code. type: string minLength: 0 maxLength: 20 description: description: description. type: string minLength: 0 maxLength: 2000 itemPoolsInfo: type: object description: Response object which holds collection of Item Pools. properties: itemPools: description: Collection of Item Pools. $ref: '#/components/schemas/itemPoolsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cateringMenuItemClassesCopy: type: object description: Request object for Copying Menu Item Classes. properties: copyMenuItemClasses: description: List of Menu Item Classes to be copied. $ref: '#/components/schemas/copyMenuItemClassesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' inventoryItemTemplates: type: object description: Response object for fetching inventory item templates. properties: inventoryItemTemplates: description: Collection of inventory item templates fetched. $ref: '#/components/schemas/inventoryItemTemplatesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' itemClassesType: type: array description: Holds Item Class details. maxItems: 4000 items: $ref: '#/components/schemas/itemClassType' managedByOptions: description: Describes of the Configuration is Managed by Enterprise or Property. type: string enum: - EnterpriseManaged - PropertyManaged - EnterpriseEnforced - PropertyOverridden cateringPackagePricingListType: type: array description: Collection of multiple Pricing Details associated with a particular Catering Package. maxItems: 4000 items: $ref: '#/components/schemas/cateringPackagePricingType' copyCateringPackageType: type: object description: 'Request object for Copying Catering Package/Template. ' properties: code: description: Code associated with the newly copied Catering Package/template. type: string minLength: 0 maxLength: 10 translatableDescription: description: Description of the the newly copied Catering Package/template. $ref: '#/components/schemas/translationTextType200' warnings: $ref: '#/components/schemas/warningsType' eventForecastType: type: object description: Type used for managing forecast for any event. properties: forecastId: description: Unique Identifier for an event forecast. $ref: '#/components/schemas/uniqueID_Type' hotelId: description: Hotel Code to which the Event Forecast belongs to. type: string minLength: 0 maxLength: 20 forecastInfo: description: Provides information about the event forecast. type: array maxItems: 2 items: $ref: '#/components/schemas/eventForecastInfoType' revenueDetails: description: Provides revenue details attached to the event forecast. $ref: '#/components/schemas/eventForecastRevDetailListType' managedBy: $ref: '#/components/schemas/managedByOptions' code: description: Unique identifier code for an Event Forecast record. type: string minLength: 0 maxLength: 20 menuTypeType: type: string description: Defines values for Menu Type enum: - Food - Beverage itemRateType: type: object description: Details of the Item Rate. properties: itemRateId: description: The ID of the Item Rate. $ref: '#/components/schemas/uniqueID_Type' itemRateCode: description: The Rate Code of the Item Rate. type: string minLength: 0 maxLength: 20 name: description: The Name of the Item Rate. type: string minLength: 0 maxLength: 200 price: description: The Price of the Item. $ref: '#/components/schemas/currencyAmountType' hourly: description: If true, it's hourly rate. type: boolean default: description: If true, it's the default Rate for the Item. type: boolean warningType: type: object description: Used when a message has been successfully processed to report any warnings or business errors that occurred. properties: value: type: string description: Property Value shortText: description: An abbreviated version of the error in textual format. type: string maxLength: 2000 code: description: If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. type: string minLength: 0 maxLength: 20 docURL: description: If present, this URL refers to an online description of the error that occurred. type: string maxLength: 2000 status: description: If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration. type: string maxLength: 2000 tag: description: If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing]. type: string maxLength: 2000 recordId: description: If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction. type: string maxLength: 2000 type: description: The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown". type: string minLength: 0 maxLength: 20 language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' rph: description: Reference Place Holder used as an index for this warning. type: string minLength: 1 maxLength: 8 exceptionDetailType: title: Error Detail description: Complex type that contains error details for a REST call. type: object properties: type: type: string description: Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML). title: type: string description: Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization. status: type: integer description: HTTP status code for this occurrence of the problem, set by the origin server. detail: type: string description: Human-readable description specific to this occurrence of the problem. instance: type: string description: Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced. o:errorCode: type: string description: Application error code, which is different from HTTP error code. o:errorPath: type: string description: Path to the problem at the resource or property level. o:errorDetails: description: Details of the error message, consisting of a hierarchical tree structure. type: array items: $ref: '#/components/schemas/errorInstance' links: $ref: '#/components/schemas/links' required: - type - title revenueTypesInfo: type: object description: Response object for fetching Revenue Types Setup configurations. properties: revenueTypes: description: Collection of Revenue Types Setup configurations. $ref: '#/components/schemas/revenueTypesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' itemClassesCopy: type: array description: List of the Item Class to be copied. items: $ref: '#/components/schemas/copyConfigurationCodeType' inventoryItemType: type: object description: Inventory Items identification details. properties: hotelId: description: The Hotel code which the item belongs to. type: string minLength: 0 maxLength: 20 itemId: description: The id of the Item class. $ref: '#/components/schemas/uniqueID_Type' itemClassId: description: The Item Class ID which the item belongs to. $ref: '#/components/schemas/uniqueID_Type' itemClassCode: description: The Item Class Code which the item belongs to. type: string minLength: 0 maxLength: 20 itemClassDescription: description: The Description of the Item Class. type: string minLength: 0 maxLength: 2000 itemName: description: The Name of the Item. $ref: '#/components/schemas/translationTextType200' itemDescription: description: The Description of the Item. type: string minLength: 0 maxLength: 2000 itemCode: description: The Article Number of the Item. type: string minLength: 0 maxLength: 20 revenueType: description: The Revenue Type of the Item. type: string minLength: 0 maxLength: 20 revenueTypeEditable: description: If true, the revenue could be changed. type: boolean externalOrder: description: Flag to define if the inventory item can be ordered externally when the item is marked as critical. type: boolean print: description: The Revenue Type of the Item. type: boolean sellInfo: description: The Sell Information of the Item. type: object properties: available: description: The available period of the Item. $ref: '#/components/schemas/dateTimeSpanType' availableQty: description: Available quantity during a period of time. type: number qtyInStock: description: Item quantity in Stock. type: number defaultQty: description: Defines the default quantity when booking the Item. type: number sellSeparate: description: If true, the item could be sold separately. type: boolean sellControl: description: If true, item is mandatory for booking. type: boolean welcomeOffer: description: If true, the item can be attached as part of a Welcome Offer type: boolean webBookable: description: If true, web booking is allowed. type: boolean itemClassWebBookable: description: Specifies if web booking is allowed for the Item Class. type: boolean outsideStay: description: Define if the the Item could be held outside of the reservation stay days. type: boolean fixedCharge: description: If true, the Fixed Charges screen will be automatically displayed when this item gets attached to a reservation. type: boolean discountable: description: Specifies if a discount is allowed for this item. type: boolean itemClassDiscountable: description: Specifies if a discount is allowed for the Item Class. type: boolean criticalInventory: description: Flag to issue a warning if this inventory item is overbooked. type: boolean price: description: The Cost of the Item. $ref: '#/components/schemas/currencyAmountType' defaultDuration: description: Define the default duration days when booking the Item. type: integer setupTime: description: Setup Time of the Item in minutes. type: number setdownTime: description: Setdown Time of the Item in minutes. type: number traceText: description: The Trace Text of the Item. type: string minLength: 0 maxLength: 2000 tracesPerDay: description: Flag to indicate that trace text will be created for each day of the Item Inventory. type: boolean itemPool: description: The Item Pool description of the Item. type: string minLength: 0 maxLength: 200 displaySequence: description: The display sequence of the Item. type: number eventTypes: description: List of Event Types for the Item. $ref: '#/components/schemas/codeListType' departments: description: List of Departments for the Item. $ref: '#/components/schemas/codeListType' attributes: description: List of Attributes of the Item. $ref: '#/components/schemas/itemAttributesType' rates: description: List of Rates of the Item. $ref: '#/components/schemas/itemRatesType' dailyInventoryItems: type: array description: List of Daily Available inventory items. maxItems: 4000 items: $ref: '#/components/schemas/dailyAvailableInventoryItemType' vendors: description: List of Vendors of the Item. $ref: '#/components/schemas/itemVendorsType' resourceNotes: description: Collection of notes which belongs to a resource (either Item or Menu or FunctionSpace). $ref: '#/components/schemas/eventResourceNotesType' itemClassDisplaySequence: description: Display sequence of Item Class. type: number usedForEvents: description: If true, the item is used for events. type: boolean usedForReservation: description: If true, the item is used for reservation. type: boolean itemFromTemplate: description: Indicates whether Item is from a Template or not. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' copyInventoryItemType: type: object description: The type describes Inventory Item Details being copied. properties: hotelId: description: Hotel code to which item code will be copied. type: string minLength: 0 maxLength: 20 itemCode: description: Item code being copied. type: string minLength: 0 maxLength: 20 copyAs: description: The code and description to be used for the item being copied. $ref: '#/components/schemas/codeDescriptionType' revenueTypes: type: object description: Request object for changing existing Revenue Types Setup Configurations. properties: revenueTypes: description: Revenue Types Setup Configurations to be changed. $ref: '#/components/schemas/revenueTypesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' revenueTypeDetailType: type: object description: Details type provides information about Catering Revenue Type Details. properties: hotelId: description: Hotel Code is used to set associated revenue type details. type: string minLength: 0 maxLength: 20 revenueMinimum: description: Indicates if this revenue type contributes to the revenue minimum. type: boolean tax: description: VAT % to calculate Net Catering Revenues. type: number minimum: 0 maximum: 100 translationTextType2000: type: object description: Contains Multiple translated texts and language codes. properties: defaultText: description: Default text with Character length from 0 to 2000. type: string minLength: 0 maxLength: 2000 translatedTexts: description: List of translated text and language codes. $ref: '#/components/schemas/translationsTextType' revenueGroupType: type: object description: Provides information about Catering Revenue Group along with Revenue Type Code. properties: code: description: Code is used to identify a Catering Revenue Group. type: string minLength: 0 maxLength: 20 translatableDescription: description: Translatable description of the Catering Revenue Group. $ref: '#/components/schemas/translationTextType200' displaySequence: description: Sequence Number of the Catering Revenue Group. type: number inactive: description: Indicates if the Catering Revenue Group is inactive. type: boolean revenueTypes: description: Collection of Catering Revenue Type Codes which are associated for a Catering Revenue Group. $ref: '#/components/schemas/revenueTypesType' managedBy: $ref: '#/components/schemas/managedByOptions' cateringMenuDetailListType: type: array description: List of Values of Catering Menu Detail. maxItems: 4000 items: $ref: '#/components/schemas/cateringMenuDetailType' revenueTypesType: type: array description: List of Revenue Types to be configured maxItems: 4000 items: $ref: '#/components/schemas/revenueTypeType' itemPoolsType: type: array description: Item Pools details for hotels. maxItems: 4000 items: $ref: '#/components/schemas/itemPoolType' eventResourceType: type: string enum: - Space - Item - Menu description: It represents Menu as Resource. itemQuantityDateType: type: object description: Item Quantity by date properties: dailyQuantity: description: Daily quantity for Item by date. type: number quantityDate: description: Date of the item quantity. type: string format: date maxLength: 8 dailyInventoryItemsType: type: array description: List of Daily Inventory Items. maxItems: 4000 items: $ref: '#/components/schemas/dailyInventoryItemType' cateringContainers: type: object description: Request object which holds modified Catering Code Containers. properties: containers: description: Collection of Catering Code Containers to be changed. $ref: '#/components/schemas/cateringCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' uniqueIDListType: type: array description: Unique Id that references an object uniquely in the system. maxItems: 4000 items: $ref: '#/components/schemas/uniqueID_Type' cateringItemRatesInfo: type: object description: Response object for fetching Catering Code's Item Rate details. properties: itemRates: description: Collection of Catering Item Rate Details. $ref: '#/components/schemas/cateringCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cateringCodeType: type: object description: Base type provides information about Catering Code which will be used for removal operation properties: codeId: description: Code ID is used to identify a Catering Code by ID. type: number code: description: Code is used to identify a Catering Code. type: string minLength: 0 maxLength: 20 translatableDescription: description: Description of the Catering Code. $ref: '#/components/schemas/translationTextType200' displaySequence: description: Catering Codes display sequence Number type: number webBookable: description: Indicator used for only WEB Code Type in Item Rate type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' itemPools: type: object description: Request object which holds modified Item Pools. properties: itemPools: description: Collection of Item Pools to be changed. $ref: '#/components/schemas/itemPoolsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' itemClassesInfo: type: object description: Response object for fetching item class. properties: itemClasses: description: Collection of item class. $ref: '#/components/schemas/itemClassesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cateringMenuClassInfoType: type: object description: Detailed attributes of Menu Class . properties: name: description: This type holds name of Menu Class. type: string minLength: 0 maxLength: 200 webBookable: description: This type tells about whether menu class is book through web or not. type: boolean inactiveDate: description: Inactive date of menu class. type: string format: date maxLength: 8 eventTypes: description: This type holds list of associated events. $ref: '#/components/schemas/codeListType' inactive: description: Return true, when this Menu Item Class will not be available to be associated to a Catering Event. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' code: description: Field for unique code identifier for Menu Class. type: string minLength: 0 maxLength: 20 cateringMenuItemListType: type: array description: List of Values of Menu Item. maxItems: 4000 items: $ref: '#/components/schemas/cateringMenuItemType' resourceCodeInfo: type: object description: Response object of newly copied resource or configuration code. properties: resourceCode: description: Newly copied resource or configuration code. type: string minLength: 0 maxLength: 20 links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' itemRatesType: type: array description: List of Item Rates. maxItems: 4000 items: $ref: '#/components/schemas/itemRateType' cateringContainersInfo: type: object description: Response object for fetching Catering Code Containers details. properties: containers: description: Collection of Catering Code Containers Details. $ref: '#/components/schemas/cateringCodesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' itemClasses: type: object description: Request object for modifying item class. properties: itemClasses: description: Collection of item class to be changed. $ref: '#/components/schemas/itemClassesType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' translationsTextType: type: array description: Language code for the translation. maxItems: 4000 items: type: object properties: value: type: string description: Used for Character Strings, length 0 to 2000. minLength: 0 maxLength: 2000 language: description: Language identification. type: string minLength: 0 maxLength: 20 description: Language code for the translation. revenueGroups: type: object description: Request object for changing existing Catering Revenue Groups Configurations. properties: revenueGroups: description: Catering Revenue Groups Configurations to be changed. $ref: '#/components/schemas/revenueGroupsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' itemIDListType: type: array description: Collection of Item Id which belongs to Item Code. maxItems: 4000 items: type: number cateringPackageRevenueType: type: object description: Type used for managing Revenue Details associated with a particular Catering Package Price Code. properties: packageEventId: description: The Catering Package Event Id asscoaited with Revenue. $ref: '#/components/schemas/uniqueID_Type' revType: description: Revenue Type associated with the Catering Package Price Code. type: string minLength: 0 maxLength: 20 orderBy: description: Sorting Order. type: integer revForecast: description: Forecasted Revenue. $ref: '#/components/schemas/currencyAmountType' revExpected: description: Expected Revenue. $ref: '#/components/schemas/currencyAmountType' costExpected: description: Expected Cost. $ref: '#/components/schemas/currencyAmountType' cateringPackageListType: type: array description: Collection of multiple Catering Packages. maxItems: 4000 items: $ref: '#/components/schemas/cateringPackageType' cateringMenuClasses: type: object description: Request object for changing Menu Classes. properties: menuClassList: description: Menu Classes to be changed $ref: '#/components/schemas/cateringMenuClassListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cateringMenuItemType: type: object description: Detailed attributes of Menu Item. properties: id: description: The menu item class unique ID $ref: '#/components/schemas/uniqueID_Type' hotelId: description: The Hotel code which the menu item class belongs to type: string minLength: 0 maxLength: 20 classInfo: description: Displays the Menu Item Name noted in the Menu Item Configuration. $ref: '#/components/schemas/codeDescriptionType' displayOrder: description: Defines the Display Order of the menu item class, to which the menu item is attached type: integer name1: description: First value of menu item which belongs to a menu item class $ref: '#/components/schemas/translationTextType2000' name2: description: Seond value of menu item which belongs to a menu item class $ref: '#/components/schemas/translationTextType2000' name3: description: Third value of menu item which belongs to a menu item class $ref: '#/components/schemas/translationTextType2000' origin1: description: The values entered here most commonly reference a Wine, Meat origin if Restaurant features a Local Farm $ref: '#/components/schemas/translationTextType2000' origin2: description: The values entered here most commonly reference a Wine, Meat origin if Restaurant features a Local Farm $ref: '#/components/schemas/translationTextType2000' menuType: description: Type of Menu -Food or Beverage $ref: '#/components/schemas/menuTypeType' custom: description: Indicates whether this menu item is custom type: boolean year: description: This value is typically the year of the Wine type: integer restriction: description: Any particular restriction description in 100 charactera type: string minLength: 0 maxLength: 100 description: description: Detailed description of menu items in 100 characters $ref: '#/components/schemas/translationTextType2000' dietaryPreferenceList: description: list of configured Dietary preferences $ref: '#/components/schemas/dietaryPrefListType' eventTypes: description: Field will be inherited values from the Menu Item Class associated for Event Types. $ref: '#/components/schemas/codeListType' responsibleDepartments: description: Department Code(s) will be displayed in the field for a particular menu item $ref: '#/components/schemas/codeListType' quickInsertCode: description: Article number in Caps of menu item type: string minLength: 0 maxLength: 20 revenueType: description: RevenueType of Menu Item type: string minLength: 0 maxLength: 20 salesPrice: description: Price of Menu Item , Numeric currency value field conforming to Currency Format for the selected Property. $ref: '#/components/schemas/currencyAmountType' cost: description: Actual Cost of Menu Item $ref: '#/components/schemas/currencyAmountType' itemConsumption: description: Selection of this notes that the price defined is charged 'as-consumed' basis type: boolean container: description: Code and description of the container to be used by Menu Item $ref: '#/components/schemas/codeDescriptionType' portion: description: Portion of the menu item $ref: '#/components/schemas/translationTextType2000' servings: description: Numeric value of servings of Menu item type: integer webBookable: description: Check of Menu Item if it is web bookable type: boolean print: description: check if Print action is required for menu item type: boolean inactive: description: Check for the status of menu item type: boolean includedYN: description: Included flag type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' cateringMenuItemsInfo: type: object description: Response object for retrieving Menu Items. properties: cateringMenuItems: description: Collection of Menu Items fetched. $ref: '#/components/schemas/cateringMenuItemListType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' itemAttributeType: type: object description: Details of the Item Attribute. properties: itemAttributeId: description: The ID of the Item Attribute. $ref: '#/components/schemas/uniqueID_Type' translatableName: description: Translatable Name of the Item Attribute. $ref: '#/components/schemas/translationTextType200' setupTime: description: The Setup Time of the Item Attribute in minutes. type: number setdownTime: description: The Setdown Time of the Item Attribute in minutes. type: number default: description: If true, it's the default Attribute for the Item. type: boolean errorInstance: title: Error Instance Details description: Complex type that contains error instance details for a REST call. type: object properties: type: type: string description: Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML). title: type: string description: Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization. status: type: integer description: HTTP status code for this occurrence of the problem, set by the origin server. detail: type: string description: Human-readable description specific to this occurrence of the problem. instance: type: string description: Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced. o:errorCode: type: string description: Application error code, which is different from HTTP error code. o:errorPath: type: string description: Path to the problem at the resource or property level. required: - type - title dietaryPrefType: type: object description: Base type provides information about Catering Revenue Types Configuration. properties: code: type: string minLength: 0 maxLength: 20 type: type: string minLength: 0 maxLength: 20 translationTextType100: type: object description: Contains Multiple translated texts and language codes. properties: defaultText: description: Default text with Character length from 0 to 100. type: string minLength: 0 maxLength: 100 translatedTexts: description: List of translated text and language codes. $ref: '#/components/schemas/translationsTextType' itemVendorType: type: object description: Details of the Item Vendor. properties: profileId: description: The ID of the vendor. $ref: '#/components/schemas/profileId' name: description: The Name of the vendor. type: string minLength: 0 maxLength: 100 leadTime: description: Lead time for ordering. type: string minLength: 0 maxLength: 200 price: description: Purchase Price. $ref: '#/components/schemas/currencyAmountType' priority: description: The Priority of the Vendor. type: number phone: description: The phone number of the Vendor. type: string minLength: 0 maxLength: 2000 fax: description: The fax number of the Vendor. type: string minLength: 0 maxLength: 2000 email: description: The email address of the Vendor. type: string minLength: 0 maxLength: 2000 dateRangeType: type: object description: Date Range with Start and End dates. properties: start: description: The starting value of the date range. type: string format: date maxLength: 8 end: description: The ending value of the date range. type: string format: date maxLength: 8 cateringMenuItemClassesInfo: type: object description: Response object for retrieving Menu Item Classes. properties: menuItemClassList: description: Collection of Menu Item Classes fetched. $ref: '#/components/schemas/cateringMenuItemClassListType' totalPages: description: Evaluated total page count based on the requested max fetch count. type: integer offset: 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. type: integer limit: description: Indicates maximum number of records a Web Service should return. type: integer hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' eventForecastListType: type: array description: Collection of multiple Event Forecasts. maxItems: 4000 items: $ref: '#/components/schemas/eventForecastType' cateringMultiChoiceMenuType: type: object properties: courseId: description: This attributes identifies the courseldd. type: integer course: description: This type holds Courses are defined for Menu. type: string minLength: 0 maxLength: 20 choiceCount: description: This type holds choice count of the Menu. type: integer courseDescription: description: This type holds choice description for Menu. $ref: '#/components/schemas/translationTextType100' courseName: description: This type holds name of the Course. $ref: '#/components/schemas/translationTextType20' itemClassType: type: object description: Provides information about the Item Class. properties: hotelId: description: Code of the Hotel. type: string minLength: 0 maxLength: 20 code: description: Code of the Item Class. type: string minLength: 0 maxLength: 20 description: description: Description of the Item Class. $ref: '#/components/schemas/translationTextType200' type: description: Item Class Type. e.g. Reservations,Events $ref: '#/components/schemas/itemClassTypeType' classId: description: ClassID of the Item Class. type: number displaySequence: description: Sequence of Item Class. type: number eventTypes: description: Event Types of Item Class. $ref: '#/components/schemas/codeListType' departments: description: Departmnents of Item Class. $ref: '#/components/schemas/codeListType' discountable: description: Indicates whether the Item Class is discountable or not. type: boolean webBookable: description: Indicates whether the Item Class is BookableViaWebsite or not. type: boolean overrideWarnings: description: Indicates whether the all items to be updated when there are warnings. type: boolean discountOverrideWarnings: description: Indicates whether the all items to be updated when there are warnings for discountable. type: boolean managedBy: $ref: '#/components/schemas/managedByOptions' forecastRevenueAmountTypeType: type: string description: Defines values for Amount Type of an event forecast revenue. enum: - FlatAmount - PerPerson checkedDiscountAvailable: type: object description: Response object to determine whether the discount is available for resort or not. properties: discountable: description: Determines whether the discount is available for resort or not. type: boolean links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' copyCateringPackagePriceType: type: object description: Request object for Copying Catering Package Price. properties: code: description: Code associated with the newly copied Catering Package Price. type: string minLength: 0 maxLength: 20 translatableDescription: description: Description of the newly copied Catering Package Price. $ref: '#/components/schemas/translationTextType200' warnings: $ref: '#/components/schemas/warningsType' cateringMenus: type: object description: Request object for changing Menu . properties: menuList: description: Menu Classes to be changed $ref: '#/components/schemas/cateringMenuListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' revenueTypeType: type: object description: Base type provides information about Catering Revenue Types Configuration. properties: code: description: Code is used to identify a Catering Revenue Type/Code. type: string minLength: 0 maxLength: 20 translatableDescription: description: Translatable Description of the Catering Revenue Types. $ref: '#/components/schemas/translationTextType200' displaySequence: description: Revenue Types display sequence Number type: number revenueGroup: description: Revenue Group type: string minLength: 0 maxLength: 20 foodAndBeverage: description: Flag for Food and Beverages. type: boolean inactive: description: Indicates if the Revenue type Code is inactive. type: boolean revenueDetails: description: Collection of Revenue details associated to a Revenue Type (Additional Details) $ref: '#/components/schemas/revenueTypeDetailsType' managedBy: $ref: '#/components/schemas/managedByOptions' cateringCodesType: type: array description: Catering Code details. maxItems: 4000 items: $ref: '#/components/schemas/cateringCodeType' inventoryItemTemplateItemsType: type: array description: This type holds a collection of inventory items which are to be grouped under a single inventory item template. maxItems: 4000 items: $ref: '#/components/schemas/inventoryItemTemplateItemType' profileId: type: object description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). properties: url: description: URL that identifies the location associated with the record identified by the UniqueID. type: string type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 20 instance: description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated. type: string minLength: 0 maxLength: 80 idContext: description: Used to identify the source of the identifier (e.g., IATA, ABTA). type: string minLength: 0 maxLength: 80 id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 idExtension: description: Additional identifying value assigned by the creating system. type: integer cateringMenuClassType: type: object description: Catering Menu Class which holds the value of menu class. properties: classId: description: This type holds Menu Class id. $ref: '#/components/schemas/uniqueID_Type' hotelId: description: The Hotel code which the menu class belongs to. type: string minLength: 0 maxLength: 20 classInfo: description: This type holds Menu class details. $ref: '#/components/schemas/cateringMenuClassInfoType' menuList: description: This type holds list of menu, along with the menu info,revenue and menu details. $ref: '#/components/schemas/cateringMenuListType' eventResourceNotesType: type: array description: Contains event resource note information. maxItems: 4000 items: $ref: '#/components/schemas/eventResourceNoteType' inventoryItemTemplateItemType: type: object description: This type holds the information of the inventory item which will be grouped in the inventory item template. properties: id: description: Specifies the ID of the item. $ref: '#/components/schemas/uniqueID_Type' name: description: Specifies the name of the item. type: string minLength: 0 maxLength: 40 articleNumber: description: Specifies the article number of the item. type: string minLength: 0 maxLength: 20 rateId: description: Specifies the identifier of the default rate for the item in the inventory item template. $ref: '#/components/schemas/uniqueID_Type' rateCode: description: Specifies the code of the default rate for the item in the inventory item template. type: string minLength: 0 maxLength: 20 rateName: description: Specifies the name of the default rate for the item in the inventory item template. type: string minLength: 0 maxLength: 200 attributeId: description: Specifies the identifier of the default attribute for the item in the inventory item template. $ref: '#/components/schemas/uniqueID_Type' attributeName: description: Specifies the name of the default attribute for the item in the inventory item template. type: string minLength: 0 maxLength: 200 classSequence: description: Specifies the sorting sequence number for the item class. type: integer sequence: description: Specifies the sorting sequence number for the item. type: integer quantity: description: Specifies the quantity of the item. type: integer inventoryItemsCreated: type: object description: Response object for creating Inventory Items Setup configurations properties: items: description: Inventory Item Setup configurations created. $ref: '#/components/schemas/inventoryItemsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cateringPackagePricingType: type: object description: Type used for managing Pricing Details associated with a particular Catering Package. properties: id: description: Unique Identifier for a Pricing detail associated with the Catering Package. $ref: '#/components/schemas/uniqueID_Type' priceCode: description: Price Code. type: string minLength: 0 maxLength: 20 description: description: Title of the Catering Package Event Note. type: string minLength: 0 maxLength: 200 sellDate: description: Selling Start/End Date associated with the Price Details. $ref: '#/components/schemas/dateTimeSpanType' blockDate: description: Booking Start/End Date associated with the Price Details. $ref: '#/components/schemas/dateTimeSpanType' marketCode: description: Market Code associated with the Price Details. type: string minLength: 0 maxLength: 20 webBookable: description: Defines if web booking is allowed. type: boolean totalPrice: description: Total Price. $ref: '#/components/schemas/currencyAmountType' flatRate: description: Defines if Flat Rate is applicable. type: boolean minAttendees: description: Minimum Attendees. type: integer maxAttendees: description: Maximum Attendees. type: integer revenueDetails: description: Collection of Revenue Details associated with the Catering Package Price Code. $ref: '#/components/schemas/cateringPackageRevenueListType' bookingType: description: Collection of configured Booking Types for the package property. type: string minLength: 0 maxLength: 20 cateringMenuType: type: object properties: id: description: This type holds menu id. $ref: '#/components/schemas/uniqueID_Type' classId: description: This type holds class id for given menu. type: string minLength: 0 maxLength: 20 hotelId: description: The Hotel code which the catering menu belongs to. type: string minLength: 0 maxLength: 20 info: description: This type holds value of Catering Menu Info. $ref: '#/components/schemas/cateringMenuInfoType' revenueList: description: This type holds revenue list. $ref: '#/components/schemas/cateringMenuRevListType' menuDetailList: description: This type holds Menu Detail List. $ref: '#/components/schemas/cateringMenuDetailListType' multiChoiceList: $ref: '#/components/schemas/cateringMultiChoiceMenuListType' menuNoteList: description: Collection of notes which belongs to a Menu. $ref: '#/components/schemas/eventResourceNotesType' managedBy: $ref: '#/components/schemas/managedByOptions' dailyInventoryItemQuantityType: type: object description: Bulk Update Inventory Item for identification. properties: itemId: description: The id of the Item. $ref: '#/components/schemas/uniqueID_Type' dailyQuantities: type: array description: List of Daily Inventory Items. maxItems: 30 items: $ref: '#/components/schemas/dailyAvailableInventoryItemType' inventoryItemsCopy: type: object description: Request object for copying Inventory Items Setup configuration properties: copyInventoryItems: description: Copy Inventory Items criteria type to copy multiple Inventory Items from one Hotel to other Hotels. $ref: '#/components/schemas/copyInventoryItemsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cateringPackage: type: object properties: pkgTmplts: description: Collection of Catering Packages. $ref: '#/components/schemas/cateringPackageListType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' cateringPackageRevenueListType: type: array description: Collection of multiple Revenue Details associated with a particular Catering Package Price Code. maxItems: 4000 items: $ref: '#/components/schemas/cateringPackageRevenueType' links: type: array items: $ref: '#/components/schemas/instanceLink' cateringMenuRevType: type: object properties: revenueType: description: This supports all Revenue Types type: string minLength: 0 maxLength: 30 type: description: This type holds value of Menu type FOOD ,BEVERAGE for the given Menu. $ref: '#/components/schemas/menuTypeType' cost: description: This type holds cost of the Menu. $ref: '#/components/schemas/currencyAmountType' internalQuote: description: This type holds internal quote for the Menu. $ref: '#/components/schemas/currencyAmountType' costMargin: description: This type holds cost of the Menu. type: number minimum: 0 maximum: 100 price: description: This type holds Price of the Menu. $ref: '#/components/schemas/currencyAmountType' priceMargin: description: This type holds price margin for the given Menu. type: number minimum: 0 maximum: 100 cateringMenuListType: type: array description: List of Values of Menu. maxItems: 4000 items: $ref: '#/components/schemas/cateringMenuType' translationTextType20: type: object description: Contains Multiple translated texts and language codes. properties: defaultText: description: Default text with Character length from 0 to 20. type: string minLength: 0 maxLength: 20 translatedTexts: description: List of translated text and language codes. $ref: '#/components/schemas/translationsTextType' cateringMenuInfoType: type: object properties: className: description: This type holds name of Menu Class Name. type: string minLength: 0 maxLength: 30 name: description: This type holds name of Menu Name. $ref: '#/components/schemas/translationTextType2000' restriction: description: This type holds Restrictionn for the given Menu. $ref: '#/components/schemas/translationTextType2000' description: description: This type holds Description for the given Menu. $ref: '#/components/schemas/translationTextType2000' dietaryList: description: This type holds DietaryList values for the given Menu. $ref: '#/components/schemas/codeListType' eventTypes: description: This type holds Event list associated with menu. $ref: '#/components/schemas/codeListType' type: description: This type holds value of Menu type FOOD ,BEVERAGE for the given Menu. $ref: '#/components/schemas/menuTypeType' quickInsertCode: description: This type holds quick insert value, v5 functionality as Article Number for the Menu. type: string minLength: 0 maxLength: 20 servingType: description: This type holds serving type value per person , per table for the given Menu. $ref: '#/components/schemas/servingType' servingSize: description: This type holds TableCapacity for the given Menu. type: string minLength: 0 maxLength: 20 includedInMenu: description: Return true, when all Menu Items added will be marked as Included and there will be a Global Price for this menu type: boolean consumptionBased: description: This type holds value of consumption, Menu items will be charged on a consumption basis. type: boolean sellDateRange: description: Menu will be available to sell for an Event for date range. $ref: '#/components/schemas/dateRangeType' eventDateRange: description: Date period which the Event will take place. $ref: '#/components/schemas/dateRangeType' menusSold: description: The total number of menus sold for the day on which the event takes place. type: integer webBookable: description: This type tells about whether menu is book through web or not. type: boolean inactive: description: Selection will note this Menu is Inactive and unable to be added to a Catering Event. type: boolean salesPrice: description: Sales Price for Menu Item in Menu Item Configuration. $ref: '#/components/schemas/currencyAmountType' includedInPrice: description: Return true means, menu item as Included in the Menu Price type: boolean multiChoice: description: Indicator of this being a multi-choice menu type: boolean courseCount: description: Define the Courses populated into the Multi Choice Menu Configuration type: integer cateringPackageResourceNoteType: type: object description: Type used for managing Resource Notes associated with a particular Catering Package Resource. properties: id: description: Unique Identifier for a Note associated with a particular Catering Package Resource. $ref: '#/components/schemas/uniqueID_Type' title: description: Title of the Catering Package Resource Note. type: string minLength: 0 maxLength: 200 comment: description: Comment associated the Catering Package Resource Note. type: string minLength: 0 maxLength: 2000 internal: description: Indiciates if this is Internal. type: boolean createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 responses: '406': description: Not acceptable. '414': description: Request URI Too Large '503': description: Service Unavailable '413': description: Request Entity Too Large '500': description: System Error content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '502': description: Bad Gateway '403': description: Forbidden '415': description: Unsupported Media Type '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '401': description: Unauthorized '405': description: Method not allowed parameters: x-hotelid: name: x-hotelid description: Mandatory parameter to identify the hotel code where the end user is logged in in: header required: true schema: type: string authKey: name: authorization description: Bearer token that needs to be passed which is generated post user authentication in: header required: true schema: type: string externalData: name: externalData description: Pass this header as true, if payload needs DVM in: header schema: type: string Accept-Language: name: Accept-Language description: Language code in: header schema: type: string x-app-key: name: x-app-key description: Client or Partner's Application Key in: header required: true schema: type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$ x-externalsystem: name: x-externalsystem description: External system code. in: header x-example: EXTERNALSYSTEMCODE schema: type: string maxLength: 40 x-originating-application: name: x-originating-application description: Customer's Integration Application Id in: header schema: type: string x-request-id: name: x-request-id description: Request Id of an incoming request in: header schema: type: string pattern: ~*[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} externalDocs: description: Find out more about Oracle Hospitality url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html