Hotelumo Hotel Operations
See your hotel's room availability, rates, housekeeping and upcoming arrivals and departures.
Sollte ich dies verwenden
Qualität und Sicherheit
Basierend auf einer automatisierten Analyse der Tool-Definitionen und der Einhaltung des Protokolls.
Kontextkosten
Dies ist die ungefähre Anzahl der Tokens, die jedes Mal verbraucht werden, wenn die Tools des Servers in den Kontext eines Modells geladen werden. Höhere Werte verringern die Aufmerksamkeit, die für andere Aufgaben verfügbar ist.
Installieren
Installation mit einem Klick
Fügen Sie dies Ihrer Datei `claude_desktop_config.json` hinzu:
{
"mcpServers": {
"hotelumo": {
"url": "https://mcp.hotelumo.com/mcp"
}
}
}Remote-Endpunkte
https://mcp.hotelumo.com/mcpstreamable-httpWas es kann
Tool-Inventar
Tools (11)
🟢list_hotels(limit, offset)
Use this when someone asks which hotels or properties they manage in Hotelumo, or a hotel's id is needed. Returns each hotel's id, name, currency, language and timezone, 20 per page by default (no addresses or guest data). Not for room availability.
Eingabe-Schema
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100,
"description": "Hotels per page, from 1 to 100; defaults to 20"
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "Hotels to skip, from 0 to 10000; defaults to 0. For the next page pass offset + limit"
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Ausgabe-Schema
{
"type": "object",
"properties": {
"hotels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-f]{24}$"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"currency": {
"$ref": "#/properties/hotels/items/properties/name"
},
"locale": {
"$ref": "#/properties/hotels/items/properties/name"
},
"timezone": {
"$ref": "#/properties/hotels/items/properties/name"
},
"lastEditTime": {
"$ref": "#/properties/hotels/items/properties/name"
}
},
"required": [
"id",
"name",
"currency",
"locale",
"timezone",
"lastEditTime"
],
"additionalProperties": false
},
"maxItems": 100,
"description": "Hotels in the signed-in organization. Addresses, phone numbers, channel credentials, payment configuration, reminder configuration and guest data are excluded."
},
"page": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"returned": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"hasMore": {
"type": "boolean"
}
},
"required": [
"limit",
"offset",
"returned",
"hasMore"
],
"additionalProperties": false,
"description": "hasMore is true when another page exists; request it with offset + limit"
}
},
"required": [
"hotels",
"page"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢get_hotel(hotelId)
Use this when someone asks about one hotel's setup, such as its default check-in and check-out times, currency, country or timezone. Returns the hotel's name, currency, language, timezone, country code and default check-in and check-out times, or not-found. Not for room availability or prices.
Eingabe-Schema
{
"type": "object",
"properties": {
"hotelId": {
"type": "string",
"pattern": "^[0-9a-f]{24}$",
"description": "Hotel id: 24 lowercase hexadecimal characters"
}
},
"required": [
"hotelId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Ausgabe-Schema
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"found",
"not-found"
]
},
"hotel": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-f]{24}$"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"currency": {
"$ref": "#/properties/hotel/anyOf/0/properties/name"
},
"locale": {
"$ref": "#/properties/hotel/anyOf/0/properties/name"
},
"timezone": {
"$ref": "#/properties/hotel/anyOf/0/properties/name"
},
"countryCode": {
"$ref": "#/properties/hotel/anyOf/0/properties/name"
},
"checkInDefaultTime": {
"$ref": "#/properties/hotel/anyOf/0/properties/name"
},
"checkOutDefaultTime": {
"$ref": "#/properties/hotel/anyOf/0/properties/name"
},
"lastEditTime": {
"$ref": "#/properties/hotel/anyOf/0/properties/name"
}
},
"required": [
"id",
"name",
"currency",
"locale",
"timezone",
"countryCode",
"checkInDefaultTime",
"checkOutDefaultTime",
"lastEditTime"
],
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "Operational hotel metadata; null when not found. Contact details, addresses, integrations, credentials, payment configuration, reminders and guest data are never returned."
}
},
"required": [
"status",
"hotel"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢get_hotel_availability(hotelId, checkInDate, checkOutDate, adults, children, ...)
Use this when someone asks if rooms are free for certain dates or what a stay would cost. Returns the room types and rate plans with a free room every night for the party, with rooms left and nightly and total prices in minor currency units. Stays of 1–30 nights, check-in within 365 days. Not for making a booking.
Eingabe-Schema
{
"type": "object",
"properties": {
"hotelId": {
"type": "string",
"pattern": "^[0-9a-f]{24}$",
"description": "Hotel id: 24 lowercase hexadecimal characters"
},
"checkInDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Arrival date as YYYY-MM-DD, from today to 365 days ahead in the hotel's timezone"
},
"checkOutDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Departure date as YYYY-MM-DD, 1 to 30 nights after checkInDate"
},
"adults": {
"type": "integer",
"minimum": 1,
"maximum": 20,
"description": "Adults staying, from 1 to 20; defaults to 2"
},
"children": {
"type": "integer",
"minimum": 0,
"maximum": 20,
"description": "Children staying, from 0 to 20; defaults to 0"
},
"infants": {
"type": "integer",
"minimum": 0,
"maximum": 20,
"description": "Infants staying, from 0 to 20; defaults to 0"
}
},
"required": [
"hotelId",
"checkInDate",
"checkOutDate"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Ausgabe-Schema
{
"type": "object",
"properties": {
"search": {
"type": "object",
"properties": {
"checkInDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"checkOutDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"nights": {
"type": "integer",
"minimum": 1,
"maximum": 30
},
"adults": {
"type": "integer",
"minimum": 1,
"maximum": 20
},
"children": {
"type": "integer",
"minimum": 0,
"maximum": 20
},
"infants": {
"type": "integer",
"minimum": 0,
"maximum": 20
}
},
"required": [
"checkInDate",
"checkOutDate",
"nights",
"adults",
"children",
"infants"
],
"additionalProperties": false
},
"offers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"roomTypeId": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9a-f]{24}$"
},
{
"type": "null"
}
]
},
"roomTypeName": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"ratePlanId": {
"$ref": "#/properties/offers/items/properties/roomTypeId"
},
"ratePlanTitle": {
"$ref": "#/properties/offers/items/properties/roomTypeName"
},
"mealPlan": {
"$ref": "#/properties/offers/items/properties/roomTypeName"
},
"sellMode": {
"$ref": "#/properties/offers/items/properties/roomTypeName"
},
"availableRooms": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100000
},
{
"type": "null"
}
]
},
"nightlyRate": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1000000000000
},
{
"type": "null"
}
]
},
"totalPrice": {
"$ref": "#/properties/offers/items/properties/nightlyRate"
},
"currency": {
"$ref": "#/properties/offers/items/properties/roomTypeName"
},
"nightlyRates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"price": {
"$ref": "#/properties/offers/items/properties/nightlyRate"
}
},
"required": [
"date",
"price"
],
"additionalProperties": false
},
"maxItems": 30
}
},
"required": [
"roomTypeId",
"roomTypeName",
"ratePlanId",
"ratePlanTitle",
"mealPlan",
"sellMode",
"availableRooms",
"nightlyRate",
"totalPrice",
"currency",
"nightlyRates"
],
"additionalProperties": false
},
"maxItems": 100,
"description": "One row per bookable room type and rate plan with a free room every night. Amounts are integer minor currency units (12000 is 120.00 in a two-decimal currency). Guest records, reservations, room assignments, access data, notes, payments, channel references, photos, free-text descriptions and credentials are excluded."
},
"offersAreTruncated": {
"type": "boolean",
"description": "True when more than 100 offers matched the search"
}
},
"required": [
"search",
"offers",
"offersAreTruncated"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢get_hotel_schedule_summary(hotelId, dateFrom, dateTo)
Use this when someone asks how busy the hotel is, or how many arrivals, departures or in-house stays fall on each day. Returns daily counts of confirmed, checked-in and checked-out stays plus reservation totals by status, for 7 days from today by default and at most 31 days; counting stops at 500. Not for looking up a guest or reservation.
Eingabe-Schema
{
"type": "object",
"properties": {
"hotelId": {
"type": "string",
"pattern": "^[0-9a-f]{24}$",
"description": "Hotel id: 24 lowercase hexadecimal characters"
},
"dateFrom": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "First day as YYYY-MM-DD (inclusive); defaults to today in UTC"
},
"dateTo": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Last day as YYYY-MM-DD (inclusive), at most 31 days in total; defaults to six days after dateFrom"
}
},
"required": [
"hotelId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Ausgabe-Schema
{
"type": "object",
"properties": {
"hotel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-f]{24}$"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"timezone": {
"$ref": "#/properties/hotel/properties/name"
}
},
"required": [
"id",
"name",
"timezone"
],
"additionalProperties": false
},
"range": {
"type": "object",
"properties": {
"dateFrom": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"dateTo": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
},
"required": [
"dateFrom",
"dateTo"
],
"additionalProperties": false
},
"reservationCount": {
"type": "integer",
"minimum": 0,
"maximum": 500
},
"reservationCountIsLowerBound": {
"type": "boolean",
"description": "True when more than 500 reservations overlap the range"
},
"statusCounts": {
"type": "object",
"additionalProperties": {
"type": "integer",
"minimum": 0,
"maximum": 500
},
"propertyNames": {
"enum": [
"INQUIRY",
"REQUESTED",
"CONFIRMED",
"CHECKED_IN",
"CHECKED_OUT",
"NO_SHOW",
"CANCELED",
"UNSPECIFIED"
]
},
"description": "Reservations overlapping the range by status, inquiries, requests, no-shows and cancellations included"
},
"days": {
"type": "array",
"items": {
"type": "object",
"properties": {
"day": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"arrivals": {
"type": "integer",
"minimum": 0,
"maximum": 500
},
"departures": {
"type": "integer",
"minimum": 0,
"maximum": 500
},
"inHouseReservations": {
"type": "integer",
"minimum": 0,
"maximum": 500
}
},
"required": [
"day",
"arrivals",
"departures",
"inHouseReservations"
],
"additionalProperties": false
},
"maxItems": 31,
"description": "One row per day. arrivals, departures and inHouseReservations count confirmed, checked-in and checked-out stays; a stay is not in-house on its checkout day. Reservation or allocation identifiers, individual stay records, guest data, room assignments, notes, documents, payments, access data, channel references and credentials are never returned."
}
},
"required": [
"hotel",
"range",
"reservationCount",
"reservationCountIsLowerBound",
"statusCounts",
"days"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢list_room_types(hotelId, limit, offset)
Use this when someone asks what kinds of rooms a hotel offers or how many guests each room type sleeps. Returns each room type's id, hotel, name and maximum guests, sorted by name, 20 per page by default. Not for whether a room type is free on given dates.
Eingabe-Schema
{
"type": "object",
"properties": {
"hotelId": {
"type": "string",
"pattern": "^[0-9a-f]{24}$",
"description": "Only this hotel (24 lowercase hexadecimal characters); every hotel when absent"
},
"limit": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100,
"description": "Room types per page, from 1 to 100; defaults to 20"
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "Room types to skip, from 0 to 10000; defaults to 0. For the next page pass offset + limit"
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Ausgabe-Schema
{
"type": "object",
"properties": {
"roomTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-f]{24}$"
},
"hotelId": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9a-f]{24}$"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"maxGuests": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"lastEditTime": {
"$ref": "#/properties/roomTypes/items/properties/name"
}
},
"required": [
"id",
"hotelId",
"name",
"maxGuests",
"lastEditTime"
],
"additionalProperties": false
},
"maxItems": 100,
"description": "Room types sorted by name. Photos, public descriptions, rate-plan internals, channel mappings and credentials are excluded."
},
"page": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"returned": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"hasMore": {
"type": "boolean"
}
},
"required": [
"limit",
"offset",
"returned",
"hasMore"
],
"additionalProperties": false,
"description": "hasMore is true when another page exists; request it with offset + limit"
}
},
"required": [
"roomTypes",
"page"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢get_room_type(roomTypeId)
Use this when someone asks about one room type, such as its name or how many guests it sleeps. Returns the room type's name, hotel and maximum guests, or not-found. Not for its prices or free dates.
Eingabe-Schema
{
"type": "object",
"properties": {
"roomTypeId": {
"type": "string",
"pattern": "^[0-9a-f]{24}$",
"description": "Room type id: 24 lowercase hexadecimal characters"
}
},
"required": [
"roomTypeId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Ausgabe-Schema
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"found",
"not-found"
]
},
"roomType": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-f]{24}$"
},
"hotelId": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9a-f]{24}$"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"maxGuests": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"lastEditTime": {
"$ref": "#/properties/roomType/anyOf/0/properties/name"
}
},
"required": [
"id",
"hotelId",
"name",
"maxGuests",
"lastEditTime"
],
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "Null when not found. Free-text descriptions, facilities, photos, channel mappings, integrations, credentials and arbitrary metadata are never returned."
}
},
"required": [
"status",
"roomType"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢list_rooms(hotelId, roomTypeId, limit, offset)
Use this when someone asks which rooms are clean, dirty or inspected, or which are out of order or out of service. Returns each physical room's name or number, room type and hotel with its room and housekeeping status, 20 per page by default (no guest or occupant data). Not for which rooms are free on given dates.
Eingabe-Schema
{
"type": "object",
"properties": {
"hotelId": {
"type": "string",
"pattern": "^[0-9a-f]{24}$",
"description": "Only this hotel (24 lowercase hexadecimal characters); every hotel when absent"
},
"roomTypeId": {
"type": "string",
"pattern": "^[0-9a-f]{24}$",
"description": "Only this room type (24 lowercase hexadecimal characters)"
},
"limit": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100,
"description": "Rooms per page, from 1 to 100; defaults to 20"
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "Rooms to skip, from 0 to 10000; defaults to 0. For the next page pass offset + limit"
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Ausgabe-Schema
{
"type": "object",
"properties": {
"rooms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"hotelId": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9a-f]{24}$"
},
{
"type": "null"
}
]
},
"roomTypeId": {
"$ref": "#/properties/rooms/items/properties/hotelId"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"$ref": "#/properties/rooms/items/properties/name/anyOf/0"
},
{
"type": "null"
}
],
"description": "AVAILABLE (in service, not a statement about occupancy), OUT_OF_ORDER or OUT_OF_SERVICE"
},
"housekeepingStatus": {
"anyOf": [
{
"$ref": "#/properties/rooms/items/properties/name/anyOf/0"
},
{
"type": "null"
}
],
"description": "CLEAN, DIRTY or INSPECTED"
},
"lastEditTime": {
"$ref": "#/properties/rooms/items/properties/name"
}
},
"required": [
"hotelId",
"roomTypeId",
"name",
"status",
"housekeepingStatus",
"lastEditTime"
],
"additionalProperties": false
},
"maxItems": 100,
"description": "Physical rooms sorted by name. Internal room ids, reservation, occupant, guest, access-control and channel data are excluded."
},
"page": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"returned": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"hasMore": {
"type": "boolean"
}
},
"required": [
"limit",
"offset",
"returned",
"hasMore"
],
"additionalProperties": false,
"description": "hasMore is true when another page exists; request it with offset + limit"
}
},
"required": [
"rooms",
"page"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢list_rate_plans(hotelId, roomTypeId, limit, offset)
Use this when someone asks what rate plans a hotel sells, such as room-only or breakfast-included rates, and their base prices. Returns each plan's title, room type, base price in minor currency units, meal plan, per-room or per-person pricing and default flag, 20 per page by default. Not for prices on specific dates.
Eingabe-Schema
{
"type": "object",
"properties": {
"hotelId": {
"type": "string",
"pattern": "^[0-9a-f]{24}$",
"description": "Hotel id: 24 lowercase hexadecimal characters"
},
"roomTypeId": {
"type": "string",
"pattern": "^[0-9a-f]{24}$",
"description": "Only this room type (24 lowercase hexadecimal characters)"
},
"limit": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100,
"description": "Rate plans per page, from 1 to 100; defaults to 20"
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "Rate plans to skip, from 0 to 10000; defaults to 0. For the next page pass offset + limit"
}
},
"required": [
"hotelId"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Ausgabe-Schema
{
"type": "object",
"properties": {
"ratePlans": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-f]{24}$"
},
"roomTypeId": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9a-f]{24}$"
},
{
"type": "null"
}
]
},
"title": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"basePrice": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1000000000000
},
{
"type": "null"
}
]
},
"currency": {
"$ref": "#/properties/ratePlans/items/properties/title"
},
"mealPlan": {
"$ref": "#/properties/ratePlans/items/properties/title"
},
"sellMode": {
"$ref": "#/properties/ratePlans/items/properties/title"
},
"rateMode": {
"anyOf": [
{
"$ref": "#/properties/ratePlans/items/properties/title/anyOf/0"
},
{
"type": "null"
}
],
"description": "manual or derived"
},
"isDefault": {
"type": "boolean"
}
},
"required": [
"id",
"roomTypeId",
"title",
"basePrice",
"currency",
"mealPlan",
"sellMode",
"rateMode",
"isDefault"
],
"additionalProperties": false
},
"maxItems": 100,
"description": "basePrice is in integer minor currency units. Channel-manager mappings, integration metadata and credentials are excluded."
},
"page": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"returned": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"hasMore": {
"type": "boolean"
}
},
"required": [
"limit",
"offset",
"returned",
"hasMore"
],
"additionalProperties": false,
"description": "hasMore is true when another page exists; request it with offset + limit"
}
},
"required": [
"ratePlans",
"page"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢list_daily_rates(hotelId, ratePlanId, dateFrom, dateTo)
Use this when someone asks what a rate costs on specific nights, or about minimum stays, stop-sell or closed-to-arrival dates. Returns the stored per-day price and restrictions of one rate plan over up to 90 days; days without a row use the plan's base price. Not for whether rooms are free.
Eingabe-Schema
{
"type": "object",
"properties": {
"hotelId": {
"type": "string",
"pattern": "^[0-9a-f]{24}$",
"description": "Hotel id: 24 lowercase hexadecimal characters"
},
"ratePlanId": {
"type": "string",
"pattern": "^[0-9a-f]{24}$",
"description": "Rate plan id, belonging to hotelId: 24 lowercase hexadecimal characters"
},
"dateFrom": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "First night as YYYY-MM-DD (inclusive)"
},
"dateTo": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Last night as YYYY-MM-DD (inclusive); the range covers at most 90 days"
}
},
"required": [
"hotelId",
"ratePlanId",
"dateFrom",
"dateTo"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Ausgabe-Schema
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"found",
"not-found"
]
},
"dailyRates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ratePlanId": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9a-f]{24}$"
},
{
"type": "null"
}
]
},
"date": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
{
"type": "null"
}
]
},
"price": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1000000000000
},
{
"type": "null"
}
]
},
"minStay": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 365
},
{
"type": "null"
}
]
},
"closedToArrival": {
"type": "boolean"
},
"closedToDeparture": {
"type": "boolean"
},
"stopSell": {
"type": "boolean"
}
},
"required": [
"ratePlanId",
"date",
"price",
"minStay",
"closedToArrival",
"closedToDeparture",
"stopSell"
],
"additionalProperties": false
},
"maxItems": 90,
"description": "Stored per-day rows sorted by date; a date without a row sells at the plan's base price. price is in integer minor currency units. Guest, payment, channel, credential and arbitrary metadata are excluded."
}
},
"required": [
"status",
"dailyRates"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢list_extras(hotelId, limit, offset)
Use this when someone asks what extras a hotel sells, such as breakfast, parking, spa, transfers or fees, and what they cost. Returns each active extra's name, price in minor currency units, currency, category and taxable flag, 20 per page by default. Not for what a guest bought or was charged.
Eingabe-Schema
{
"type": "object",
"properties": {
"hotelId": {
"type": "string",
"pattern": "^[0-9a-f]{24}$",
"description": "Only this hotel (24 lowercase hexadecimal characters); every hotel when absent"
},
"limit": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100,
"description": "Extras per page, from 1 to 100; defaults to 20"
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "Extras to skip, from 0 to 10000; defaults to 0. For the next page pass offset + limit"
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Ausgabe-Schema
{
"type": "object",
"properties": {
"extras": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"price": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 1000000000000
},
{
"type": "null"
}
]
},
"currency": {
"$ref": "#/properties/extras/items/properties/name"
},
"taxable": {
"type": "boolean"
},
"category": {
"anyOf": [
{
"$ref": "#/properties/extras/items/properties/name/anyOf/0"
},
{
"type": "null"
}
],
"description": "BREAKFAST, PARKING, SPA, TRANSFER, FEE or OTHER"
}
},
"required": [
"name",
"price",
"currency",
"taxable",
"category"
],
"additionalProperties": false
},
"maxItems": 100,
"description": "Active extras; price is in integer minor currency units. Guest charges, folio data, display colors and credentials are excluded."
},
"page": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"returned": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"hasMore": {
"type": "boolean"
}
},
"required": [
"limit",
"offset",
"returned",
"hasMore"
],
"additionalProperties": false,
"description": "hasMore is true when another page exists; request it with offset + limit"
}
},
"required": [
"extras",
"page"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢show_hotel_overview(hotelId)
Use this when someone wants a quick overview or dashboard of one hotel's operations. Returns an overview card with the hotel's details, reservation status counts for the next 7 days, and room, room-type, room-status and housekeeping counts from bounded samples (no guest, stay or payment data). Not for a single reservation.
Eingabe-Schema
{
"type": "object",
"properties": {
"hotelId": {
"type": "string",
"pattern": "^[0-9a-f]{24}$",
"description": "Hotel id: 24 lowercase hexadecimal characters"
}
},
"required": [
"hotelId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Ausgabe-Schema
{
"type": "object",
"properties": {
"hotel": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-f]{24}$"
},
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"currency": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"locale": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"timezone": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"currency",
"locale",
"timezone"
],
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "Null when not found. Guest identities, contact details, reservation or allocation identifiers, individual stay records, notes, documents, occupant ids, payments, access data, integration configuration, credentials and arbitrary metadata are excluded."
},
"scheduleRange": {
"type": "object",
"properties": {
"dateFrom": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"dateTo": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
},
"required": [
"dateFrom",
"dateTo"
],
"additionalProperties": false
},
"reservations": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"minimum": 0,
"maximum": 50
},
"hasMore": {
"type": "boolean"
}
},
"required": [
"count",
"hasMore"
],
"additionalProperties": false,
"description": "Reservations overlapping the next seven UTC days, any status, sampled up to 50; hasMore marks a lower bound"
},
"rooms": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"hasMore": {
"type": "boolean"
}
},
"required": [
"count",
"hasMore"
],
"additionalProperties": false,
"description": "Physical rooms, sampled up to 100; hasMore marks a lower bound"
},
"roomTypes": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"minimum": 0,
"maximum": 50
},
"hasMore": {
"type": "boolean"
}
},
"required": [
"count",
"hasMore"
],
"additionalProperties": false,
"description": "Room types, sampled up to 50; hasMore marks a lower bound"
},
"reservationStatusCounts": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"INQUIRY",
"REQUESTED",
"CONFIRMED",
"CHECKED_IN",
"CHECKED_OUT",
"NO_SHOW",
"CANCELED",
"UNSPECIFIED"
]
},
"additionalProperties": {
"type": "integer",
"minimum": 0,
"maximum": 50
}
},
"roomStatusCounts": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"AVAILABLE",
"OUT_OF_ORDER",
"OUT_OF_SERVICE",
"UNSPECIFIED"
]
},
"additionalProperties": {
"type": "integer",
"minimum": 0,
"maximum": 100
}
},
"housekeepingStatusCounts": {
"type": "object",
"propertyNames": {
"type": "string",
"enum": [
"CLEAN",
"DIRTY",
"INSPECTED",
"UNSPECIFIED"
]
},
"additionalProperties": {
"type": "integer",
"minimum": 0,
"maximum": 100
}
}
},
"required": [
"hotel",
"scheduleRange",
"reservations",
"rooms",
"roomTypes",
"reservationStatusCounts",
"roomStatusCounts",
"housekeepingStatusCounts"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Community
Nachweis