{
"openapi": "3.0.0",
"info": {
"title": "Hopa API prod",
"description": "API for Quick Booking Engine (under active development, some things may change)",
"version": "1.0.0"
},
"paths": {
"/api/calendar": {
"get": {
"tags": [
"Calendar"
],
"operationId": "get_app_calendar_getroomcalendardata",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "asArray",
"in": "query",
"description": "Return data as array instead of object",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "code",
"in": "query",
"description": "Provide a promotion Code",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "numberOfAdults",
"in": "query",
"description": "Provide a promotion Code",
"required": false,
"schema": {
"type": "integer",
"default": 1
}
}
],
"responses": {
"200": {
"description": "Get Prices to display in Calendar",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CalendarResponse"
}
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Calendar"
],
"operationId": "head_app_calendar_getroomcalendardata",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "asArray",
"in": "query",
"description": "Return data as array instead of object",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "code",
"in": "query",
"description": "Provide a promotion Code",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "numberOfAdults",
"in": "query",
"description": "Provide a promotion Code",
"required": false,
"schema": {
"type": "integer",
"default": 1
}
}
],
"responses": {
"200": {
"description": "Get Prices to display in Calendar",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CalendarResponse"
}
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/calendar/package/{packageId}": {
"get": {
"tags": [
"Calendar"
],
"operationId": "get_app_calendar_getpackagecalendardata",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "asArray",
"in": "query",
"description": "Return data as array instead of object",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "packageId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Get Prices to display in Calendar",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CalendarResponse"
}
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Calendar"
],
"operationId": "head_app_calendar_getpackagecalendardata",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "asArray",
"in": "query",
"description": "Return data as array instead of object",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "packageId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Get Prices to display in Calendar",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CalendarResponse"
}
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/calendar/voucher/{voucherCode}": {
"get": {
"tags": [
"Calendar"
],
"operationId": "get_app_calendar_getvouchercalendardata",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "asArray",
"in": "query",
"description": "Return data as array instead of object",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "voucherCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Get Prices to display in Calendar",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CalendarResponse"
}
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Calendar"
],
"operationId": "head_app_calendar_getvouchercalendardata",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "asArray",
"in": "query",
"description": "Return data as array instead of object",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "voucherCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Get Prices to display in Calendar",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CalendarResponse"
}
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/content": {
"get": {
"tags": [
"Content"
],
"operationId": "get_app_content_getcontent",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"$ref": "#/components/schemas/ContentResponse"
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Content"
],
"operationId": "head_app_content_getcontent",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"$ref": "#/components/schemas/ContentResponse"
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/content/faq": {
"get": {
"tags": [
"Content"
],
"operationId": "get_app_content_getfaq",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FAQGroup"
}
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Content"
],
"operationId": "head_app_content_getfaq",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FAQGroup"
}
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/content/rates": {
"get": {
"tags": [
"Content"
],
"operationId": "get_app_content_getrates",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RateResponse"
}
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Content"
],
"operationId": "head_app_content_getrates",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RateResponse"
}
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/content/favicon": {
"get": {
"tags": [
"Content"
],
"operationId": "get_api_favicon",
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/create/offerWithVariants": {
"post": {
"tags": [
"Create"
],
"operationId": "post_app_create_createofferwithvariants",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"requestBody": {
"description": "Create Offer with multiple variants\n\t\t
\u26a0\ufe0f\u26a0\ufe0f Caution: Use either rooms OR roomsSimplified. When using roomsSimplified the prices will be refetched from the system and may have changed since the time you initially received them. You can provide the price which will be used to verify the price and will trigger an error if they don't match \u26a0\ufe0f\u26a0\ufe0f",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OfferImport"
}
}
}
},
"responses": {
"200": {
"description": "Offer created",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOfferRes"
}
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Create"
],
"operationId": "head_app_create_createofferwithvariants",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"requestBody": {
"description": "Create Offer with multiple variants\n\t\t
\u26a0\ufe0f\u26a0\ufe0f Caution: Use either rooms OR roomsSimplified. When using roomsSimplified the prices will be refetched from the system and may have changed since the time you initially received them. You can provide the price which will be used to verify the price and will trigger an error if they don't match \u26a0\ufe0f\u26a0\ufe0f",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OfferImport"
}
}
}
},
"responses": {
"200": {
"description": "Offer created",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOfferRes"
}
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/create/offer": {
"post": {
"tags": [
"Create"
],
"operationId": "post_app_create_createoffer",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"requestBody": {
"description": "Create Offer\n\t\t
\u26a0\ufe0f\u26a0\ufe0f Caution: Use either rooms OR roomsSimplified. When using roomsSimplified the prices will be refetched from the system and may have changed since the time you initially received them. You can provide the price which will be used to verify the price and will trigger an error if they don't match \u26a0\ufe0f\u26a0\ufe0f",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReservationImport"
}
}
}
},
"responses": {
"200": {
"description": "Offer created",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOfferRes"
}
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Create"
],
"operationId": "head_app_create_createoffer",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"requestBody": {
"description": "Create Offer\n\t\t
\u26a0\ufe0f\u26a0\ufe0f Caution: Use either rooms OR roomsSimplified. When using roomsSimplified the prices will be refetched from the system and may have changed since the time you initially received them. You can provide the price which will be used to verify the price and will trigger an error if they don't match \u26a0\ufe0f\u26a0\ufe0f",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReservationImport"
}
}
}
},
"responses": {
"200": {
"description": "Offer created",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOfferRes"
}
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/create/reservation": {
"post": {
"tags": [
"Create"
],
"operationId": "post_app_create_createreservation",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"requestBody": {
"description": "Create Reservation\n\t\t
\u26a0\ufe0f\u26a0\ufe0f Caution: Use either rooms OR roomsSimplified. When using roomsSimplified the prices will be refetched from the system and may have changed since the time you initially received them. You can provide the price which will be used to verify the price and will trigger an error if they don't match \u26a0\ufe0f\u26a0\ufe0f",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReservationImport"
}
}
}
},
"responses": {
"200": {
"description": "Reservation created",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOfferRes"
}
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Create"
],
"operationId": "head_app_create_createreservation",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"requestBody": {
"description": "Create Reservation\n\t\t
\u26a0\ufe0f\u26a0\ufe0f Caution: Use either rooms OR roomsSimplified. When using roomsSimplified the prices will be refetched from the system and may have changed since the time you initially received them. You can provide the price which will be used to verify the price and will trigger an error if they don't match \u26a0\ufe0f\u26a0\ufe0f",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReservationImport"
}
}
}
},
"responses": {
"200": {
"description": "Reservation created",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOfferRes"
}
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/extra": {
"get": {
"tags": [
"Extra"
],
"operationId": "get_app_extra_getextras",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"responses": {
"200": {
"description": "Get Extras",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtraResponse"
}
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Extra"
],
"operationId": "head_app_extra_getextras",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"responses": {
"200": {
"description": "Get Extras",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtraResponse"
}
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/extra/available": {
"post": {
"tags": [
"Extra"
],
"operationId": "post_app_extra_getextrasprices",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"requestBody": {
"description": "Get the available extras for the provided reservation, including the calculated price inside the priceConfig.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReservationImport"
}
}
}
},
"responses": {
"200": {
"description": "Get the available extras for the provided reservation, including the calculated price inside the priceConfig.",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtraResponse"
}
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Extra"
],
"operationId": "head_app_extra_getextrasprices",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"requestBody": {
"description": "Get the available extras for the provided reservation, including the calculated price inside the priceConfig.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReservationImport"
}
}
}
},
"responses": {
"200": {
"description": "Get the available extras for the provided reservation, including the calculated price inside the priceConfig.",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtraResponse"
}
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/localization/translation/{language}": {
"get": {
"tags": [
"Localization"
],
"operationId": "get_app_localization_getlanguages",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "language",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"$ref": "#/components/schemas/Translation"
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Localization"
],
"operationId": "head_app_localization_getlanguages",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "language",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"$ref": "#/components/schemas/Translation"
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/packages/available": {
"get": {
"tags": [
"Package"
],
"operationId": "get_app_package_getpackages",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"responses": {
"200": {
"description": "Returns a list of available packages",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackageAvailResponse"
}
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Package"
],
"operationId": "head_app_package_getpackages",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"responses": {
"200": {
"description": "Returns a list of available packages",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackageAvailResponse"
}
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/packages/{packageId}": {
"get": {
"tags": [
"Package"
],
"operationId": "get_app_package_get",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "packageId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"$ref": "#/components/schemas/PackageEntity"
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Package"
],
"operationId": "head_app_package_get",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "packageId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"$ref": "#/components/schemas/PackageEntity"
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/paymentLink": {
"post": {
"tags": [
"PaymentLink"
],
"operationId": "post_app_paymentlink_createpaymentlink",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"requestBody": {
"description": "Generate a Payment Link. When the payment is completed, the reservation will be immediately created and the webhook will be called.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentLinkBody"
}
}
}
},
"responses": {
"200": {
"description": "Create Redirect Payment Link",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOfferRes"
}
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"PaymentLink"
],
"operationId": "head_app_paymentlink_createpaymentlink",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"requestBody": {
"description": "Generate a Payment Link. When the payment is completed, the reservation will be immediately created and the webhook will be called.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentLinkBody"
}
}
}
},
"responses": {
"200": {
"description": "Create Redirect Payment Link",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateOfferRes"
}
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/paymentLink/redirect": {
"get": {
"tags": [
"PaymentLink"
],
"operationId": "get_app_paymentlink_paymentlinkredirect",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "resId",
"in": "query",
"description": "Reservation identifier",
"required": true,
"schema": {
"type": "string",
"example": "1234567890"
}
}
],
"responses": {
"default": {
"description": ""
}
}
},
"head": {
"tags": [
"PaymentLink"
],
"operationId": "head_app_paymentlink_paymentlinkredirect",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "resId",
"in": "query",
"description": "Reservation identifier",
"required": true,
"schema": {
"type": "string",
"example": "1234567890"
}
}
],
"responses": {
"default": {
"description": ""
}
}
}
},
"/api/plan": {
"get": {
"tags": [
"Plan"
],
"operationId": "get_app_plan_getplan",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "arrival",
"in": "query",
"description": "Date of arrival in Y-m-d",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "departure",
"in": "query",
"description": "Date of departure in Y-m-d",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "numberOfAdults",
"in": "query",
"description": "Number of adults",
"required": false,
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "childrenAges",
"in": "query",
"description": "Semicolon seperated list of children ages, ex. 4;10 for a 4 and 10 years old child",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "code",
"in": "query",
"description": "Promotion or voucher code",
"required": false,
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"$ref": "#/components/schemas/PlanResponse"
}
},
"type": "object"
}
}
}
}
}
},
"post": {
"tags": [
"Plan"
],
"operationId": "post_app_plan_getplanbyconfig",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"requestBody": {
"description": "Get plans for multiple rooms",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanConfig"
}
}
}
},
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"$ref": "#/components/schemas/PlanResponse"
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Plan"
],
"operationId": "head_app_plan_getplan",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "arrival",
"in": "query",
"description": "Date of arrival in Y-m-d",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "departure",
"in": "query",
"description": "Date of departure in Y-m-d",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "numberOfAdults",
"in": "query",
"description": "Number of adults",
"required": false,
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "childrenAges",
"in": "query",
"description": "Semicolon seperated list of children ages, ex. 4;10 for a 4 and 10 years old child",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "code",
"in": "query",
"description": "Promotion or voucher code",
"required": false,
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"$ref": "#/components/schemas/PlanResponse"
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/plan/packages": {
"get": {
"tags": [
"Plan"
],
"operationId": "get_app_plan_getavailablepackages",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"$ref": "#/components/schemas/PlanResponseRooms"
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Plan"
],
"operationId": "head_app_plan_getavailablepackages",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"$ref": "#/components/schemas/PlanResponseRooms"
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/plan/voucher/{code}": {
"get": {
"tags": [
"Plan"
],
"operationId": "get_app_plan_getvoucher",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "arrival",
"in": "query",
"description": "Date of arrival in Y-m-d",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "departure",
"in": "query",
"description": "Date of departure in Y-m-d",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "numberOfAdults",
"in": "query",
"description": "Number of adults",
"required": false,
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "childrenAges",
"in": "query",
"description": "Semicolon seperated list of children ages, ex. 4;10 for a 4 and 10 years old child",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "code",
"in": "query",
"description": "Promotion or voucher code",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "code",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"$ref": "#/components/schemas/PlanResponseRooms"
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Plan"
],
"operationId": "head_app_plan_getvoucher",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "arrival",
"in": "query",
"description": "Date of arrival in Y-m-d",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "departure",
"in": "query",
"description": "Date of departure in Y-m-d",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "numberOfAdults",
"in": "query",
"description": "Number of adults",
"required": false,
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "childrenAges",
"in": "query",
"description": "Semicolon seperated list of children ages, ex. 4;10 for a 4 and 10 years old child",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "code",
"in": "query",
"description": "Promotion or voucher code",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "code",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"$ref": "#/components/schemas/PlanResponseRooms"
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/plan/multiProperty": {
"post": {
"tags": [
"Plan"
],
"operationId": "post_app_plan_getplanmultiproperty",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "multiProperties",
"in": "query",
"description": "Semicolon seperated list of hotel IDs",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "arrival",
"in": "query",
"description": "Date of arrival in Y-m-d",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "arrival",
"in": "query",
"description": "Date of arrival in Y-m-d",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "departure",
"in": "query",
"description": "Date of departure in Y-m-d",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "numberOfAdults",
"in": "query",
"description": "Number of adults",
"required": false,
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "childrenAges",
"in": "query",
"description": "Semicolon seperated list of children ages, ex. 4;10 for a 4 and 10 years old child",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "code",
"in": "query",
"description": "Promotion or voucher code",
"required": false,
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanResponseMultiProperty"
}
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Plan"
],
"operationId": "head_app_plan_getplanmultiproperty",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "multiProperties",
"in": "query",
"description": "Semicolon seperated list of hotel IDs",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "arrival",
"in": "query",
"description": "Date of arrival in Y-m-d",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "arrival",
"in": "query",
"description": "Date of arrival in Y-m-d",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "departure",
"in": "query",
"description": "Date of departure in Y-m-d",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "numberOfAdults",
"in": "query",
"description": "Number of adults",
"required": false,
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "childrenAges",
"in": "query",
"description": "Semicolon seperated list of children ages, ex. 4;10 for a 4 and 10 years old child",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "code",
"in": "query",
"description": "Promotion or voucher code",
"required": false,
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanResponseMultiProperty"
}
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/plan/rooms": {
"post": {
"tags": [
"Plan"
],
"operationId": "post_app_plan_getplanbyroom",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"requestBody": {
"description": "Get the best price for multiple rooms for a certain period",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanRoomConfig"
}
}
}
}
},
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanRoomConfigResponse"
}
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Plan"
],
"operationId": "head_app_plan_getplanbyroom",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"requestBody": {
"description": "Get the best price for multiple rooms for a certain period",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanRoomConfig"
}
}
}
}
},
"responses": {
"200": {
"description": "Example Response",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanRoomConfigResponse"
}
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/promotions": {
"get": {
"tags": [
"Promotion"
],
"operationId": "get_app_promo_getpromos",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"responses": {
"200": {
"description": "Get Extras",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RatePromotionEntity"
}
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Promotion"
],
"operationId": "head_app_promo_getpromos",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
}
],
"responses": {
"200": {
"description": "Get Extras",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RatePromotionEntity"
}
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/vouchers/{voucherCode}/validate": {
"get": {
"tags": [
"Voucher"
],
"operationId": "get_app_voucher_getvalidatevoucher",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "voucherCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Validate Promo code",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"properties": {
"state": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Voucher not found"
},
"redirectTo": {
"type": "integer",
"example": "2076"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Voucher"
],
"operationId": "head_app_voucher_getvalidatevoucher",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "voucherCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Validate Promo code",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"properties": {
"state": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Voucher not found"
},
"redirectTo": {
"type": "integer",
"example": "2076"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"/api/vouchers/{voucherCode}": {
"get": {
"tags": [
"Voucher"
],
"operationId": "get_app_voucher_getvoucher",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "voucherCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Fetch voucher information.",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"$ref": "#/components/schemas/VoucherEntity"
}
},
"type": "object"
}
}
}
}
}
},
"head": {
"tags": [
"Voucher"
],
"operationId": "head_app_voucher_getvoucher",
"parameters": [
{
"$ref": "#/components/parameters/general-hotel-id"
},
{
"name": "voucherCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Fetch voucher information.",
"content": {
"application/json": {
"schema": {
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"$ref": "#/components/schemas/VoucherEntity"
}
},
"type": "object"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Meta": {
"properties": {
"errors": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
},
"isCached": {
"type": "boolean",
"nullable": true,
"default": false
},
"cacheExpire": {
"type": "string",
"format": "date-time",
"nullable": true
},
"other": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
}
},
"type": "object"
},
"CalendarResponse": {
"properties": {
"roomId": {
"type": "integer",
"default": 0
},
"rateId": {
"type": "integer",
"default": 0
},
"date": {
"type": "string",
"default": ""
},
"price": {
"type": "integer",
"default": 0
},
"inventory": {
"type": "integer",
"default": 0
},
"minOcc": {
"type": "integer",
"default": 0
},
"maxOcc": {
"type": "integer",
"default": 0
},
"cta": {
"type": "boolean",
"default": false
},
"ctd": {
"type": "boolean",
"default": false
},
"currency": {
"type": "string",
"default": ""
},
"hotelId": {
"type": "integer",
"default": 0
},
"minStay": {
"type": "integer",
"default": 0
}
},
"type": "object"
},
"TranslationString": {
"properties": {
"en": {
"type": "string",
"default": ""
},
"de": {
"type": "string",
"default": ""
},
"fr": {
"type": "string",
"default": ""
},
"it": {
"type": "string",
"default": ""
},
"es": {
"type": "string",
"default": ""
},
"pt": {
"type": "string",
"default": ""
},
"ru": {
"type": "string",
"default": ""
},
"cn": {
"type": "string",
"default": ""
},
"jp": {
"type": "string",
"default": ""
},
"nl": {
"type": "string",
"default": ""
},
"cz": {
"type": "string",
"default": ""
},
"sk": {
"type": "string",
"default": ""
}
},
"type": "object"
},
"Picture": {
"required": [
"width",
"height",
"category",
"alt"
],
"properties": {
"url": {
"type": "string",
"nullable": true
},
"width": {
"type": "integer"
},
"height": {
"type": "integer"
},
"category": {
"type": "integer"
},
"alt": {
"$ref": "#/components/schemas/TranslationString"
}
},
"type": "object"
},
"PictureSizes": {
"required": [
"sizeOriginal",
"size300",
"size600",
"size800",
"size1000",
"size1920"
],
"properties": {
"sizeOriginal": {
"$ref": "#/components/schemas/Picture"
},
"size300": {
"$ref": "#/components/schemas/Picture"
},
"size600": {
"$ref": "#/components/schemas/Picture"
},
"size800": {
"$ref": "#/components/schemas/Picture"
},
"size1000": {
"$ref": "#/components/schemas/Picture"
},
"size1920": {
"$ref": "#/components/schemas/Picture"
}
},
"type": "object"
},
"Address": {
"required": [
"company",
"street",
"streetNumber",
"zip",
"city",
"cityId",
"country",
"countryId"
],
"properties": {
"company": {
"type": "string"
},
"street": {
"type": "string"
},
"streetNumber": {
"type": "string"
},
"zip": {
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"city": {
"type": "string"
},
"cityId": {
"type": "integer"
},
"country": {
"type": "string"
},
"countryId": {
"type": "integer"
}
},
"type": "object"
},
"ContactInfo": {
"properties": {
"email": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"whatsappNumber": {
"type": "string",
"nullable": true
}
},
"type": "object"
},
"TimeFrame": {
"properties": {
"start": {
"type": "string",
"nullable": true
},
"end": {
"type": "string",
"nullable": true
}
},
"type": "object"
},
"Coordinates": {
"properties": {
"latitude": {
"nullable": true,
"oneOf": [
{
"type": "number",
"format": "float"
},
{
"type": "string"
}
]
},
"longitude": {
"nullable": true,
"oneOf": [
{
"type": "number",
"format": "float"
},
{
"type": "string"
}
]
}
},
"type": "object"
},
"Reviews": {
"required": [
"rating",
"numberOfReviews"
],
"properties": {
"rating": {
"type": "number",
"format": "float"
},
"numberOfReviews": {
"type": "integer"
}
},
"type": "object"
},
"HotelContent": {
"required": [
"name",
"headerPicture",
"summerPictures",
"winterPictures",
"additionalPictures",
"logo",
"address",
"contactInfo",
"checkIn",
"checkOut",
"coordinates",
"taxes",
"advantages"
],
"properties": {
"name": {
"type": "string"
},
"welcomeMessage": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/TranslationString"
}
]
},
"description": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/TranslationString"
}
]
},
"headerPicture": {
"$ref": "#/components/schemas/PictureSizes"
},
"summerPictures": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PictureSizes"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PictureSizes"
}
}
]
},
"winterPictures": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PictureSizes"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PictureSizes"
}
}
]
},
"additionalPictures": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PictureSizes"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PictureSizes"
}
}
]
},
"logo": {
"$ref": "#/components/schemas/PictureSizes"
},
"address": {
"$ref": "#/components/schemas/Address"
},
"contactInfo": {
"$ref": "#/components/schemas/ContactInfo"
},
"checkIn": {
"$ref": "#/components/schemas/TimeFrame"
},
"checkOut": {
"$ref": "#/components/schemas/TimeFrame"
},
"coordinates": {
"$ref": "#/components/schemas/Coordinates"
},
"reviews": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/Reviews"
}
]
},
"taxes": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/TranslationString"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/TranslationString"
}
}
]
},
"advantages": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/TranslationString"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/TranslationString"
}
}
]
},
"facilities": {
"nullable": true,
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
]
},
"roomSizeGroups": {
"nullable": true,
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
},
"filterOptions": {
"nullable": true,
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": [
"squareMeters",
"view",
"balconyType",
"bedTypes",
"bathroom"
]
}
},
"type": "object"
},
"RoomFilter": {
"required": [
"squareMeters",
"bedTypes",
"view",
"bathroom",
"balconyType",
"floor",
"building",
"kitchen",
"airConditioning"
],
"properties": {
"squareMeters": {
"oneOf": [
{
"type": "number",
"format": "float"
},
{
"type": "integer"
}
]
},
"bedTypes": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
]
},
"view": {
"type": "string"
},
"bathroom": {
"type": "string"
},
"balcony": {
"type": "boolean",
"default": false
},
"balconyType": {
"type": "string"
},
"floor": {
"type": "string"
},
"building": {
"type": "string"
},
"kitchen": {
"type": "string"
},
"airConditioning": {
"type": "string"
}
},
"type": "object"
},
"Tag": {
"required": [
"bgColor",
"translationValues",
"icon"
],
"properties": {
"bgColor": {
"type": "string"
},
"textColor": {
"type": "string",
"default": "text-primary"
},
"title": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/TranslationString"
}
]
},
"translationKey": {
"type": "string",
"nullable": true
},
"translationValues": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
]
},
"icon": {
"type": "string"
}
},
"type": "object"
},
"RoomContent": {
"required": [
"id",
"name",
"description",
"shortDescription",
"roomFilter"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"$ref": "#/components/schemas/TranslationString"
},
"description": {
"$ref": "#/components/schemas/TranslationString"
},
"shortDescription": {
"$ref": "#/components/schemas/TranslationString"
},
"roomFilter": {
"$ref": "#/components/schemas/RoomFilter"
},
"minimumAdults": {
"type": "integer",
"default": 1
},
"maximumAdults": {
"type": "integer",
"default": 1
},
"minimumChildren": {
"type": "integer",
"default": 0
},
"maximumChildren": {
"type": "integer",
"default": 0
},
"minimumPersons": {
"type": "integer",
"default": 1
},
"maximumPersons": {
"type": "integer",
"default": 1
},
"wbeUpgradeHighlights": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
},
"showInUnavailableRequests": {
"type": "boolean",
"default": false
},
"pictures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PictureSizes"
},
"default": []
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
},
"default": []
},
"facilities": {
"nullable": true,
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
},
"sequence": {
"type": "integer",
"default": 0
}
},
"type": "object"
},
"ContentResponse": {
"required": [
"hotel",
"rooms"
],
"properties": {
"hotel": {
"$ref": "#/components/schemas/HotelContent"
},
"rooms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoomContent"
}
}
},
"type": "object"
},
"FAQTopicEntity": {
"required": [
"id",
"name",
"linkHotel"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"linkHotel": {
"type": "integer"
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"type": "object"
},
"FAQEntity": {
"required": [
"id",
"question",
"answer",
"linkGroup",
"linkHotel"
],
"properties": {
"id": {
"type": "integer"
},
"question": {
"type": "string"
},
"answer": {
"type": "string"
},
"linkGroup": {
"type": "integer"
},
"linkHotel": {
"type": "integer"
},
"active": {
"type": "boolean",
"default": true
},
"sort": {
"type": "integer",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"type": "object"
},
"FAQGroup": {
"required": [
"group"
],
"properties": {
"group": {
"$ref": "#/components/schemas/FAQTopicEntity"
},
"questions": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/FAQEntity"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/FAQEntity"
}
}
],
"default": []
}
},
"type": "object"
},
"RateResponse": {
"required": [
"name",
"description",
"key"
],
"properties": {
"id": {
"type": "integer",
"nullable": true
},
"name": {
"$ref": "#/components/schemas/TranslationString"
},
"description": {
"$ref": "#/components/schemas/TranslationString"
},
"additionalInfo": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/TranslationString"
}
]
},
"pool": {
"type": "boolean",
"default": false
},
"package": {
"type": "boolean",
"default": false
},
"key": {
"type": "string"
}
},
"type": "object"
},
"Guest": {
"required": [
"age"
],
"properties": {
"firstName": {
"type": "string",
"nullable": true,
"default": ""
},
"lastName": {
"type": "string",
"nullable": true,
"default": ""
},
"age": {
"type": "integer"
}
},
"type": "object"
},
"PlanType": {
"type": "string",
"enum": [
"rate",
"package",
"promotion",
"voucher"
]
},
"Tax": {
"required": [
"name",
"amount"
],
"properties": {
"name": {
"$ref": "#/components/schemas/TranslationString"
},
"amount": {
"type": "number",
"format": "float"
}
},
"type": "object"
},
"PriceLogger": {
"properties": {
"log": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
},
"logDuplicateCheck": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
},
"messages": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
},
"messagesDuplicateCheck": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
}
},
"type": "object"
},
"DayPrice": {
"required": [
"date",
"metaInfo",
"priceLog",
"priceWithTaxes",
"taxAmount"
],
"properties": {
"date": {
"type": "string"
},
"originalPrice": {
"type": "number",
"format": "float",
"default": 0
},
"price": {
"type": "number",
"format": "float",
"default": 0
},
"taxes": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Tax"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Tax"
}
}
],
"default": []
},
"channelPrice": {
"type": "number",
"format": "float",
"default": 0
},
"priceWithoutDiscount": {
"type": "number",
"format": "float",
"default": 0
},
"closedToArrival": {
"type": "boolean",
"default": false
},
"closedToDeparture": {
"type": "boolean",
"default": false
},
"inventory": {
"type": "integer",
"default": 0
},
"minStay": {
"type": "integer",
"default": 1
},
"guarantee": {
"type": "integer",
"default": 1
},
"metaInfo": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
]
},
"additionalNight": {
"type": "boolean",
"default": false
},
"infoSink": {
"nullable": true,
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
]
},
"priceLog": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceLogger"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PriceLogger"
}
}
]
},
"priceWithTaxes": {
"type": "number",
"format": "float"
},
"taxAmount": {
"type": "number",
"format": "float"
}
},
"type": "object"
},
"AdditionalCost": {
"required": [
"price",
"type",
"name"
],
"properties": {
"price": {
"type": "number",
"format": "float"
},
"priceWithoutDiscount": {
"type": "number",
"format": "float",
"default": 0
},
"type": {
"type": "string"
},
"name": {
"$ref": "#/components/schemas/TranslationString"
}
},
"type": "object"
},
"PlanExtras": {
"required": [
"id",
"priceConfigId"
],
"properties": {
"id": {
"type": "integer"
},
"priceConfigId": {
"type": "integer"
},
"manualPrice": {
"type": "boolean",
"default": false
},
"manualPriceValue": {
"type": "number",
"format": "float",
"nullable": true
},
"manualPriceType": {
"type": "string",
"nullable": true
}
},
"type": "object"
},
"Booker": {
"required": [
"invoiceAddress",
"address",
"fullName"
],
"properties": {
"salutation": {
"type": "string",
"nullable": true,
"default": ""
},
"title": {
"type": "string",
"nullable": true,
"default": ""
},
"segment": {
"type": "string",
"default": "NONE"
},
"loyaltyNumber": {
"type": "string",
"nullable": true
},
"nationality": {
"type": "string",
"nullable": true
},
"travelAgent": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true,
"default": ""
},
"lastName": {
"type": "string",
"nullable": true,
"default": ""
},
"invoiceAddressSame": {
"type": "boolean",
"default": false
},
"invoiceAddress": {
"$ref": "#/components/schemas/Address"
},
"address": {
"$ref": "#/components/schemas/Address"
},
"phone": {
"type": "string",
"nullable": true,
"default": ""
},
"emails": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
},
"email": {
"type": "string",
"default": ""
},
"emailConfirm": {
"type": "string",
"default": ""
},
"language": {
"type": "string",
"default": ""
},
"remarks": {
"type": "string",
"nullable": true,
"default": ""
},
"stays": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
},
"source": {
"type": "string",
"default": ""
},
"fullName": {
"type": "string"
}
},
"type": "object"
},
"Plan": {
"required": [
"roomId",
"name",
"description",
"conditions",
"additionalInfo",
"rateSequence",
"timestamp",
"hash",
"totalPrice",
"totalDayPrices",
"totalAdditionalCosts",
"totalPriceChannel",
"totalOriginalPrice",
"totalPriceWithoutDiscount",
"taxAmount",
"closedToArrival",
"closedToDeparture",
"guarantee",
"inventory",
"minStay",
"memberOnly"
],
"properties": {
"planType": {
"$ref": "#/components/schemas/PlanType"
},
"id": {
"type": "string",
"default": "-1"
},
"roomId": {
"type": "string"
},
"name": {
"$ref": "#/components/schemas/TranslationString"
},
"roomName": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/TranslationString"
}
]
},
"metaRateId": {
"type": "integer",
"default": -1
},
"dayPrices": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/DayPrice"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/DayPrice"
}
}
],
"default": []
},
"description": {
"$ref": "#/components/schemas/TranslationString"
},
"conditions": {
"$ref": "#/components/schemas/TranslationString"
},
"additionalInfo": {
"$ref": "#/components/schemas/TranslationString"
},
"isCancelable": {
"type": "boolean",
"default": false
},
"lastCancelableDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"requiresCreditCard": {
"type": "boolean",
"default": true
},
"meal": {
"type": "string",
"default": "GLOBAL.NONE"
},
"additionalCosts": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalCost"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/AdditionalCost"
}
}
],
"default": []
},
"upgradeSuggestions": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
},
"promotionCode": {
"type": "string",
"default": ""
},
"promotionId": {
"type": "integer",
"nullable": true
},
"rateSequence": {
"type": "integer"
},
"promoType": {
"type": "string",
"default": "percentage"
},
"taxes": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Tax"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Tax"
}
}
],
"default": []
},
"tags": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Tag"
}
}
],
"default": []
},
"rateTags": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Tag"
}
}
],
"default": []
},
"extras": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanExtras"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PlanExtras"
}
}
],
"default": []
},
"pictures": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PictureSizes"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PictureSizes"
}
}
],
"default": []
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"numberOfAdults": {
"type": "integer",
"default": 1
},
"childrenAges": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
},
"code": {
"type": "string",
"default": ""
},
"hash": {
"type": "string"
},
"hashVersion": {
"type": "integer",
"default": 2
},
"companyDetails": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/Booker"
}
]
},
"points": {
"type": "integer",
"default": 0
},
"totalPrice": {
"type": "number",
"format": "float"
},
"totalDayPrices": {
"type": "number",
"format": "float"
},
"totalAdditionalCosts": {
"type": "number",
"format": "float"
},
"totalPriceChannel": {
"type": "number",
"format": "float"
},
"totalOriginalPrice": {
"type": "number",
"format": "float"
},
"totalPriceWithoutDiscount": {
"type": "number",
"format": "float"
},
"taxAmount": {
"type": "number",
"format": "float"
},
"closedToArrival": {
"type": "boolean"
},
"closedToDeparture": {
"type": "boolean"
},
"guarantee": {
"type": "integer"
},
"inventory": {
"type": "integer"
},
"minStay": {
"type": "integer"
},
"memberOnly": {
"type": "boolean"
}
},
"type": "object"
},
"RoomImport": {
"required": [
"plan"
],
"properties": {
"quantity": {
"type": "integer",
"default": 1
},
"guests": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Guest"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Guest"
}
}
],
"default": []
},
"remarks": {
"type": "string",
"default": ""
},
"plan": {
"$ref": "#/components/schemas/Plan"
}
},
"type": "object"
},
"RoomImportSimplified": {
"required": [
"roomId",
"arrival",
"departure",
"rateId"
],
"properties": {
"quantity": {
"type": "integer",
"default": 1
},
"guests": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Guest"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Guest"
}
}
],
"default": []
},
"remarks": {
"type": "string",
"default": ""
},
"roomId": {
"type": "integer"
},
"arrival": {
"type": "string"
},
"departure": {
"type": "string"
},
"promoCode": {
"description": "If one room uses a promo code, all the other rooms will use the same promo code. There is also only one promo code per reservation allowed.",
"type": "string",
"nullable": true,
"default": ""
},
"rateId": {
"type": "string",
"example": "PXXXX or RXXXX"
},
"price": {
"description": "Optional expected price used for validation. If provided and it differs from the current price, the request fails with a 'Price mismatch' error.",
"type": "number",
"format": "float",
"nullable": true
}
},
"type": "object"
},
"ExtraImportSimplified": {
"properties": {
"id": {
"type": "integer",
"default": -1
},
"priceConfigId": {
"type": "integer",
"default": 0
},
"quantity": {
"type": "integer",
"default": 1
},
"excludedKeys": {
"description": "The extras are normally added for the whole reservation, in case you want to exclude some dates, rooms or guests, you can provide a list of keys here.\n\t\tEach entry represents an combination using the following format:\n\t\td: date, r: room, g: guest.\n\t\tExamples:\n\t\t[\"d:2026-01-29_r:0_g:0\", \"d:2026-01-29_r:0\", \"d:2026-01-29\"]",
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
}
},
"type": "object"
},
"ReservationBaseImport": {
"properties": {
"resId": {
"description": "Reservation id will be a random number if left empty",
"type": "string",
"example": "1321358435",
"nullable": true,
"default": ""
},
"rooms": {
"nullable": true,
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/RoomImport"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/RoomImport"
}
}
],
"default": []
},
"roomsSimplified": {
"description": "\u26a0\ufe0f Caution: The prices will be refetched from the system and may have changed since the time you initially received them. You can provide the price which will be used to verify the price and will trigger an Error if they don't match",
"nullable": true,
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/RoomImportSimplified"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/RoomImportSimplified"
}
}
],
"default": []
},
"extrasSimplified": {
"nullable": true,
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtraImportSimplified"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ExtraImportSimplified"
}
}
],
"default": []
},
"privateRemarks": {
"type": "string",
"nullable": true,
"default": ""
},
"publicRemarks": {
"type": "string",
"nullable": true,
"default": ""
},
"priceOverwrite": {
"type": "number",
"format": "float",
"nullable": true
}
},
"type": "object"
},
"VariantImport": {
"required": [
"name",
"reservation"
],
"properties": {
"name": {
"type": "string"
},
"reservation": {
"$ref": "#/components/schemas/ReservationBaseImport"
}
},
"type": "object"
},
"BookerImport": {
"required": [
"firstName",
"lastName",
"address",
"email",
"language"
],
"properties": {
"salutation": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"segment": {
"type": "string",
"nullable": true,
"default": "NONE",
"enum": [
"NONE",
"LEISURE",
"BUSINESS",
"BUSINESS_CODE",
"LEISURE_GROUP"
]
},
"loyaltyNumber": {
"type": "string",
"nullable": true
},
"nationality": {
"type": "string",
"nullable": true
},
"invoiceAddress": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/Address"
}
]
},
"address": {
"$ref": "#/components/schemas/Address"
},
"phone": {
"type": "string",
"nullable": true
},
"email": {
"type": "string"
},
"language": {
"type": "string"
},
"remarks": {
"type": "string",
"nullable": true
}
},
"type": "object"
},
"ReservationConfigImport": {
"properties": {
"emailGuest": {
"type": "boolean",
"default": true
},
"emailHotel": {
"type": "boolean",
"default": true
},
"valueVoucherCode": {
"type": "string",
"nullable": true,
"default": ""
},
"offerValidUntil": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"type": "object"
},
"OfferImport": {
"required": [
"variants",
"booker",
"config"
],
"properties": {
"offerId": {
"type": "string",
"nullable": true
},
"variants": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/VariantImport"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/VariantImport"
}
}
]
},
"groupName": {
"type": "string",
"nullable": true
},
"booker": {
"$ref": "#/components/schemas/BookerImport"
},
"config": {
"$ref": "#/components/schemas/ReservationConfigImport"
}
},
"type": "object"
},
"CreateOfferRes": {
"required": [
"link"
],
"properties": {
"link": {
"type": "string"
}
},
"type": "object"
},
"ReservationImport": {
"required": [
"booker",
"config"
],
"properties": {
"booker": {
"$ref": "#/components/schemas/BookerImport"
},
"config": {
"$ref": "#/components/schemas/ReservationConfigImport"
},
"source": {
"description": "Custom source that can be used to filter by in the statistics",
"type": "string",
"example": "MyApp",
"nullable": true,
"default": ""
},
"resId": {
"type": "string",
"nullable": true
},
"rooms": {
"nullable": true,
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/RoomImport"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/RoomImport"
}
}
]
},
"roomsSimplified": {
"description": "\u26a0\ufe0f Caution: The prices will be refetched from the system and may have changed since the time you initially received them. You can provide the price which will be used to verify the price and will trigger an Error if they don't match",
"nullable": true,
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/RoomImportSimplified"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/RoomImportSimplified"
}
}
]
},
"extrasSimplified": {
"nullable": true,
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtraImportSimplified"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ExtraImportSimplified"
}
}
]
},
"privateRemarks": {
"type": "string",
"nullable": true
},
"publicRemarks": {
"type": "string",
"nullable": true
},
"priceOverwrite": {
"type": "number",
"format": "float",
"nullable": true
}
},
"type": "object"
},
"PackageEntity": {
"required": [
"id",
"linkHotel",
"isActive",
"name",
"description",
"sequenceNumber",
"roomConfig",
"extraConfig",
"rateConfig",
"rateCode",
"compareRate",
"additionalNightRate",
"priceConfig",
"directDiscount",
"dateRange",
"openArrival",
"openDepart",
"release",
"maxOccupancy",
"inventory",
"reserveRooms",
"cancelMode",
"cancelFreeText",
"isActiveCache"
],
"properties": {
"id": {
"type": "integer"
},
"linkHotel": {
"type": "integer"
},
"isActive": {
"type": "integer"
},
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"subHeader": {
"type": "string",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
},
"category": {
"type": "string",
"nullable": true
},
"picture": {
"type": "string",
"nullable": true
},
"sequenceNumber": {
"type": "integer"
},
"roomConfig": {
"type": "string"
},
"extraConfig": {
"type": "string"
},
"rateConfig": {
"type": "string"
},
"rateCode": {
"type": "string"
},
"compareRate": {
"type": "string"
},
"additionalNightRate": {
"type": "string"
},
"priceConfig": {
"type": "string"
},
"additionalCosts": {
"type": "string",
"nullable": true
},
"directDiscount": {
"type": "boolean"
},
"dateRange": {
"type": "string"
},
"blockPeriods": {
"type": "string",
"nullable": true
},
"bookValidPeriods": {
"type": "string",
"nullable": true
},
"bookBlockPeriods": {
"type": "string",
"nullable": true
},
"weekdayFilter": {
"type": "string",
"nullable": true
},
"openArrival": {
"type": "string"
},
"openDepart": {
"type": "string"
},
"release": {
"type": "integer"
},
"maxOccupancy": {
"type": "integer"
},
"inventory": {
"type": "integer"
},
"reserveRooms": {
"type": "integer"
},
"cancelMode": {
"type": "integer"
},
"cancelFreeText": {
"type": "string"
},
"isActiveCache": {
"type": "integer"
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"type": "object"
},
"RatePromotionEntity": {
"required": [
"id",
"linkHotel",
"rebateCode",
"rebateType",
"rebateMode",
"rebateFactor",
"guarantee",
"overwriteInventoryWithRoomQuota",
"ignoreDirectSales",
"poolMode",
"minStay",
"maxStay",
"fallbackRate",
"isCorporate",
"rateCode",
"showDirectSalesRates",
"corporate"
],
"properties": {
"id": {
"type": "integer"
},
"linkHotel": {
"type": "integer"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"rebateCode": {
"type": "string"
},
"rebateType": {
"type": "integer"
},
"rebateMode": {
"title": "0 => per day, 1 => per stay",
"type": "integer"
},
"rebateFactorRate": {
"type": "string",
"nullable": true
},
"rebateFactor": {
"type": "number",
"format": "float"
},
"guarantee": {
"type": "integer"
},
"bookValidPeriods": {
"type": "string",
"nullable": true
},
"bookBlockPeriods": {
"type": "string",
"nullable": true
},
"resValidPeriods": {
"type": "string",
"nullable": true
},
"resBlockPeriods": {
"type": "string",
"nullable": true
},
"resWeekDays": {
"type": "string",
"nullable": true
},
"compatible": {
"type": "string",
"nullable": true
},
"roomFilter": {
"type": "string",
"nullable": true
},
"roomQuota": {
"type": "string",
"nullable": true
},
"overwriteInventoryWithRoomQuota": {
"type": "boolean"
},
"roomMinPrice": {
"type": "string",
"nullable": true
},
"ignoreDirectSales": {
"type": "boolean"
},
"poolMode": {
"type": "integer"
},
"platformDisplay": {
"type": "string",
"default": [
"reservation-desk",
"wbe"
]
},
"extraConfig": {
"type": "string",
"default": [
-1
]
},
"minStay": {
"type": "integer"
},
"maxStay": {
"type": "integer"
},
"fallbackRate": {
"type": "integer"
},
"isCorporate": {
"type": "boolean"
},
"logo": {
"type": "string",
"nullable": true
},
"addressFirstName": {
"type": "string",
"nullable": true
},
"addressLastName": {
"type": "string",
"nullable": true
},
"addressCompany": {
"type": "string",
"nullable": true
},
"addressStreet": {
"type": "string",
"nullable": true
},
"addressZIP": {
"type": "string",
"nullable": true
},
"addressCity": {
"type": "string",
"nullable": true
},
"addressCountry": {
"type": "string",
"nullable": true
},
"addressMail": {
"type": "string",
"nullable": true
},
"addressPhone": {
"type": "string",
"nullable": true
},
"rateCode": {
"type": "string"
},
"showDirectSalesRates": {
"type": "integer"
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"corporate": {
"type": "boolean"
}
},
"type": "object"
},
"EntityPeriod": {
"required": [
"start",
"end",
"label"
],
"properties": {
"start": {
"type": "string",
"format": "date-time"
},
"end": {
"type": "string",
"format": "date-time"
},
"label": {
"type": "string"
}
},
"type": "object"
},
"ExtraCostType": {
"type": "string",
"enum": [
"once_per_guest",
"night_and_guest",
"once_per_room",
"night_and_room",
"night_and_stay",
"guest_choice"
]
},
"ExtraPriceBreakDown": {
"required": [
"multiplier",
"price"
],
"properties": {
"multiplier": {
"type": "integer"
},
"price": {
"type": "number",
"format": "float"
}
},
"type": "object"
},
"ExtraDetailedPriceBreakDown": {
"required": [
"quantity",
"price"
],
"properties": {
"date": {
"type": "string",
"nullable": true
},
"room": {
"nullable": true,
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"guest": {
"nullable": true,
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"quantity": {
"type": "integer"
},
"price": {
"type": "number",
"format": "float"
}
},
"type": "object"
},
"ExtraCalculatedPrice": {
"properties": {
"priceBreakDown": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtraPriceBreakDown"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ExtraPriceBreakDown"
}
}
],
"default": []
},
"detailedPriceBreakDown": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtraDetailedPriceBreakDown"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ExtraDetailedPriceBreakDown"
}
}
],
"default": []
},
"price": {
"type": "number",
"format": "float",
"default": 0
},
"extraQuantity": {
"type": "integer",
"default": 1
},
"excludedKeysBySystem": {
"description": "Some extras are only applicable to specific combinations. This property defines the combinations for which the extra is NOT available.\n\t\tEach entry represents an invalid combination using the following format:\n\t\td: date, r: room, g: guest.\n\t\t\n\t\tExamples:\n\t\t[\"d:2026-01-29_r:0_g:0\", \"d:2026-01-29_r:0\", \"d:2026-01-29\"]",
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
}
},
"type": "object"
},
"ExtraCostChild": {
"required": [
"from",
"to",
"price",
"comparePrice"
],
"properties": {
"from": {
"type": "integer"
},
"to": {
"type": "integer"
},
"price": {
"type": "number",
"format": "float"
},
"comparePrice": {
"type": "number",
"format": "float"
}
},
"type": "object"
},
"ExtraCost": {
"required": [
"type",
"price",
"comparePrice",
"name",
"childPrice"
],
"properties": {
"id": {
"type": "integer",
"default": 0
},
"type": {
"$ref": "#/components/schemas/ExtraCostType"
},
"price": {
"type": "string"
},
"comparePrice": {
"type": "string"
},
"name": {
"$ref": "#/components/schemas/TranslationString"
},
"calculatedPrice": {
"description": "Only works with api/extra/available, will be otherwise null",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ExtraCalculatedPrice"
}
]
},
"childPrice": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtraCostChild"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ExtraCostChild"
}
}
]
}
},
"type": "object"
},
"ExtraResponse": {
"required": [
"tags",
"roomCompatibility",
"rateCompatibility",
"packageCompatibilityFromPackages",
"packageCompatibilityFromPromos",
"linkHotel",
"sequenceNumber",
"internName",
"publicName",
"publicDescription",
"publicShortDescription",
"pictureList",
"release",
"validPeriods",
"blockPeriods",
"stayThroughPeriods",
"minStay",
"maxStay",
"priceSteps",
"childPricing",
"quantityBase",
"quantityMax",
"wbeMode",
"wbeVersion",
"wbeDisplay",
"platformDisplay",
"included",
"guestConfigurable",
"guestConfigurableNights",
"guestConfigurableRooms",
"guestConfigurableGuests",
"shiftDays",
"minAge",
"mandatory",
"blockPeriodMode",
"priceConfig"
],
"properties": {
"priceConfigID": {
"type": "integer",
"default": 0
},
"manualPrice": {
"type": "boolean",
"default": false
},
"manualPriceValue": {
"type": "number",
"format": "float",
"nullable": true
},
"manualPriceType": {
"type": "string",
"nullable": true
},
"packageCompatibility": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
},
"promoCompatibility": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
},
"tags": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
]
},
"roomCompatibility": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
]
},
"rateCompatibility": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
]
},
"price": {
"type": "number",
"format": "float",
"default": 0
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"packageCompatibilityFromPackages": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PackageEntity"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PackageEntity"
}
}
]
},
"packageCompatibilityFromPromos": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/RatePromotionEntity"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/RatePromotionEntity"
}
}
]
},
"id": {
"type": "integer",
"nullable": true
},
"linkHotel": {
"type": "integer"
},
"sequenceNumber": {
"type": "integer"
},
"internName": {
"type": "string"
},
"publicName": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "object",
"additionalProperties": {
"type": "string"
}
}
]
},
"publicDescription": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "object",
"additionalProperties": {
"type": "string"
}
}
]
},
"publicShortDescription": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "object",
"additionalProperties": {
"type": "string"
}
}
]
},
"pictureList": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PictureSizes"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PictureSizes"
}
}
]
},
"release": {
"type": "integer"
},
"validPeriods": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityPeriod"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/EntityPeriod"
}
}
]
},
"blockPeriods": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityPeriod"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/EntityPeriod"
}
}
]
},
"stayThroughPeriods": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityPeriod"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/EntityPeriod"
}
}
]
},
"minStay": {
"type": "integer"
},
"maxStay": {
"type": "integer"
},
"priceSteps": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
]
},
"childPricing": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
]
},
"quantityBase": {
"type": "integer"
},
"quantityMax": {
"type": "integer"
},
"wbeMode": {
"type": "integer"
},
"wbeVersion": {
"type": "integer"
},
"wbeDisplay": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
]
},
"platformDisplay": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
]
},
"included": {
"type": "boolean"
},
"guestConfigurable": {
"type": "boolean"
},
"guestConfigurableNights": {
"type": "boolean"
},
"guestConfigurableRooms": {
"type": "boolean"
},
"guestConfigurableGuests": {
"type": "boolean"
},
"shiftDays": {
"type": "integer"
},
"minAge": {
"type": "integer"
},
"mandatory": {
"type": "boolean"
},
"blockPeriodMode": {
"type": "integer"
},
"priceConfig": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ExtraCost"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ExtraCost"
}
}
]
}
},
"type": "object"
},
"Translation": {
"description": "Translation",
"required": [
"key"
],
"properties": {
"key": {
"description": "Translation Key",
"type": "string",
"example": "Translation"
}
},
"type": "object"
},
"PackageAvailResponse": {
"required": [
"id",
"name",
"active",
"subHeader",
"desc",
"bestPrice",
"from",
"to"
],
"properties": {
"id": {
"description": "Package ID",
"type": "integer"
},
"name": {
"$ref": "#/components/schemas/TranslationString"
},
"active": {
"description": "Package active status",
"type": "string"
},
"subHeader": {
"$ref": "#/components/schemas/TranslationString"
},
"desc": {
"$ref": "#/components/schemas/TranslationString"
},
"picture": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PictureSizes"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PictureSizes"
}
}
],
"default": []
},
"bestPrice": {
"description": "Package best price",
"type": "number",
"format": "float"
},
"from": {
"description": "Package availability start date",
"type": "string"
},
"to": {
"description": "Package availability end date",
"type": "string"
},
"order": {
"description": "Package order",
"type": "integer",
"default": 0
}
},
"type": "object"
},
"PaymentLinkBody": {
"required": [
"webhook",
"reservation",
"validUntil"
],
"properties": {
"webhook": {
"description": "URL that will be triggered when the reservation is created.\n\tPayload Example: {\"resId\":\"XXXXXXXXXX\",\"state\":\"created\",\"link\":\"https:\\/\\/wbe.res-online.net\\/XXXX\\/reservation\\/XXXXXXXXX\\/XXXXXX@mail.com\"}\n\t",
"type": "string",
"example": "https://example.com/webhook"
},
"reservation": {
"$ref": "#/components/schemas/ReservationImport"
},
"validUntil": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"PlanResponseRooms": {
"required": [
"plans"
],
"properties": {
"plans": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Plan"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Plan"
}
}
]
}
},
"type": "object"
},
"PlanResponse": {
"required": [
"roomConfigs",
"inventories"
],
"properties": {
"roomConfigs": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanResponseRooms"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PlanResponseRooms"
}
}
]
},
"inventories": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
]
}
},
"type": "object"
},
"RoomConfig": {
"properties": {
"numberOfAdults": {
"type": "integer",
"default": 1
},
"childrenAges": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
}
},
"type": "object"
},
"PlanConfig": {
"required": [
"roomConfigs",
"arrival",
"departure"
],
"properties": {
"code": {
"type": "string",
"default": ""
},
"roomConfigs": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/RoomConfig"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/RoomConfig"
}
}
]
},
"arrival": {
"type": "string",
"format": "date-time"
},
"departure": {
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"PlanResponseMultiProperty": {
"required": [
"hotelId"
],
"properties": {
"hotelId": {
"type": "integer"
},
"plans": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Plan"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Plan"
}
}
],
"default": []
}
},
"type": "object"
},
"PlanRoomConfig": {
"required": [
"roomId"
],
"properties": {
"roomId": {
"type": "integer"
},
"numberOfDays": {
"type": "integer",
"default": 1
},
"numberOfAdults": {
"oneOf": [
{
"type": "array",
"items": {
"type": "integer"
}
},
{
"type": "object",
"additionalProperties": {
"type": "integer"
}
}
],
"default": [
1
]
}
},
"type": "object"
},
"CalendarItem": {
"properties": {
"roomId": {
"type": "integer",
"default": 0
},
"rateId": {
"type": "string",
"default": "-1"
},
"metaRateId": {
"type": "integer",
"default": -1
},
"date": {
"type": "string",
"default": ""
},
"price": {
"type": "integer",
"default": 0
},
"inventory": {
"type": "integer",
"default": 0
},
"closedToArrival": {
"type": "boolean",
"default": false
},
"closedToDeparture": {
"type": "boolean",
"default": false
},
"hotelId": {
"type": "integer",
"default": 0
},
"minStay": {
"type": "integer",
"default": 0
},
"possibleDepartures": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
},
"log": {
"oneOf": [
{
"type": "array",
"items": {
"nullable": true
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
}
}
],
"default": []
},
"tryCounter": {
"type": "integer",
"default": 0
}
},
"type": "object"
},
"PlanRoomConfigResponse": {
"required": [
"roomId",
"numberOfDays",
"numberOfAdults"
],
"properties": {
"cheapestDay": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/CalendarItem"
}
]
},
"roomId": {
"type": "integer"
},
"numberOfDays": {
"type": "integer"
},
"numberOfAdults": {
"oneOf": [
{
"type": "array",
"items": {
"type": "integer"
}
},
{
"type": "object",
"additionalProperties": {
"type": "integer"
}
}
]
}
},
"type": "object"
},
"VoucherEntity": {
"required": [
"id",
"linkDomain",
"linkTemplate",
"name",
"description",
"state",
"price",
"numNights",
"numGuests",
"importDate"
],
"properties": {
"id": {
"type": "integer"
},
"linkDomain": {
"type": "integer"
},
"linkTemplate": {
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"channel": {
"type": "string",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"state": {
"type": "integer"
},
"price": {
"type": "number",
"format": "float"
},
"numNights": {
"type": "integer"
},
"numGuests": {
"type": "integer"
},
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"buyerName": {
"type": "string",
"nullable": true
},
"buyerLastName": {
"type": "string",
"nullable": true
},
"buyerAdress": {
"type": "string",
"nullable": true
},
"buyerZIP": {
"type": "string",
"nullable": true
},
"buyerCity": {
"type": "string",
"nullable": true
},
"buyerCountry": {
"type": "string",
"nullable": true
},
"buyerMail": {
"type": "string",
"nullable": true
},
"buyerPhone": {
"type": "string",
"nullable": true
},
"buyerRemark": {
"type": "string",
"nullable": true
},
"guestName": {
"type": "string",
"nullable": true
},
"guestAdress": {
"type": "string",
"nullable": true
},
"guestZIP": {
"type": "string",
"nullable": true
},
"guestCity": {
"type": "string",
"nullable": true
},
"guestCountry": {
"type": "string",
"nullable": true
},
"guestMail": {
"type": "string",
"nullable": true
},
"guestPhone": {
"type": "string",
"nullable": true
},
"guestRemarks": {
"type": "string",
"nullable": true
},
"resId": {
"type": "string",
"nullable": true
},
"resBookedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"resArrival": {
"type": "string",
"format": "date-time",
"nullable": true
},
"resNights": {
"type": "integer",
"nullable": true
},
"resRoomType": {
"type": "integer",
"nullable": true
},
"resSurcharge": {
"type": "number",
"format": "float",
"nullable": true
},
"resNotes": {
"type": "string",
"nullable": true
},
"saleDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"importDate": {
"type": "string",
"format": "date-time"
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"type": "object"
}
},
"parameters": {
"general-hotel-id": {
"name": "hotelId",
"in": "query",
"description": "Hotel Id",
"required": false,
"schema": {
"type": "string",
"default": 2076
}
}
},
"securitySchemes": {
"basic": {
"type": "http",
"description": "Use demo:password as credentials for testing.",
"scheme": "basic",
"x-default-password": "password",
"x-default-username": "demo"
}
}
},
"security": [
{
"basic": []
}
],
"tags": [
{
"name": "Calendar"
},
{
"name": "Content"
},
{
"name": "Create"
},
{
"name": "Extra"
},
{
"name": "Localization"
},
{
"name": "Package"
},
{
"name": "PaymentLink"
},
{
"name": "Plan"
},
{
"name": "Promotion"
},
{
"name": "Voucher"
}
]
}