Hotelumo Hotel Operations

GetCheck hotelroom availability and prices

ReviewUse bounded,this non-person-linkedwhen room-typesomeone availabilityasks andif pricesrooms are free for onecertain tenant-owneddates hotelor andwhat a stay of atwould mostcost. 30Returns nights.the Amountsroom aretypes minorand currencyrate units.plans Guestwith records,a reservations,free room assignments,every accessnight data,for notes,the paymentsparty, channelwith references,rooms photos,left free-textand descriptions,nightly and credentialstotal areprices excluded.in minor currency units. Stays of 1–30 nights, check-in within 365 days. Not for making a booking.

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"adults":{"description":"Adults staying, from 1 to 20; defaults to 2","maximum":20,"minimum":1,"type":"integer"},"checkInDate":{"description":"Arrival date as YYYY-MM-DD, check-infrom today to 365 days ahead in the hotel's timezone","pattern":"^\\d{4}-\\d{2}-\\d ⟨3 unchanged words⟩ :"string"},"checkOutDate":{"description":"Departure date as YYYY-MM-DD, check-out1 to 30 nights after checkInDate","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"children":{"description":"Children staying, from 0 to 20; defaults to 0","maximum":20,"minimum":0,"type":"integer"},"hotelId":{"description":"24-characterHotel id: 24 lowercase hexadecimal hotel idcharacters","pattern":"^[0-9a-f]{24}$","type":"string"},"infants":{"description":"Infants staying, from 0 to 20; defaults to 0","maximum":20,"minimum":0,"type": ⟨7 unchanged words⟩ 

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"offers":{"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.","items":{"additionalProperties":false,"properties":{" ⟨100 unchanged words⟩ 100,"type":"array"},"offersAreTruncated":{"description":"True when more than 100 offers matched the search","type":"boolean"},"search":{"additionalProperties ⟨67 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":true,"title":"GetCheck hotelroom availability and prices"}

GetCount hotelarrivals, scheduledepartures summaryand stays

CountUse tenant-ownedthis reservationswhen andsomeone activeasks stayshow bybusy UTCthe dayhotel foris, oneor hotelhow overmany atarrivals, mostdepartures 31or days.in-house Returnsstays aggregatefall operationalon each day. Returns daily counts only—neverof confirmed, checked-in and checked-out stays plus reservation ortotals allocationby identifiersstatus, individualfor stay7 records,days guestfrom data,today roomby assignments,default notes,and documents,at payments,most access31 data,days; channelcounting references,stops at 500. Not for looking up a guest or credentials.reservation.

 ⟨5 unchanged words⟩ ,"properties":{"dateFrom":{"description":"Inclusive UTCFirst dateday as YYYY-MM-DD;YYYY-MM-DD (inclusive); defaults to today in UTC","pattern":"^\\d{4}-\\d{2}-\\d ⟨3 unchanged words⟩ :"string"},"dateTo":{"description":"Inclusive UTCLast dateday as YYYY-MM-DD;YYYY-MM-DD (inclusive), at most 31 days in total; defaults to six days laterafter dateFrom","pattern":"^\\d{4}-\\d{2}-\\d ⟨3 unchanged words⟩ :"string"},"hotelId":{"description":"24-characterHotel id: 24 lowercase hexadecimal hotel idcharacters","pattern":"^[0-9a-f]{24}$" ⟨6 unchanged words⟩ 

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"days":{"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.","items":{"additionalProperties":false,"properties":{" ⟨108 unchanged words⟩ ,"type":"integer"},"reservationCountIsLowerBound":{"description":"True when more than 500 reservations overlap the range","type":"boolean"},"statusCounts":{"additionalProperties":{"maximum":500,"minimum":0,"type":"integer"},"description":"Reservations overlapping the range by status, inquiries, requests, no-shows and cancellations included","propertyNames":{"enum":["INQUIRY"," ⟨18 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":true,"title":"GetCount hotelarrivals, scheduledepartures summaryand stays"}

Get room type details

GetUse boundedthis inventorywhen metadatasomeone forasks oneabout organization-ownedone room type.type, Free-textsuch descriptions,as facilities,its photos,name channelor mappings,how integrations,many credentialsguests it sleeps. Returns the room type's name, hotel and arbitrarymaximum metadataguests, areor nevernot-found. returned.Not for its prices or free dates.

 ⟨5 unchanged words⟩ ,"properties":{"roomTypeId":{"description":"24-characterRoom type id: 24 lowercase hexadecimal room-type idcharacters","pattern":"^[0-9a-f]{24}$" ⟨6 unchanged words⟩ 

 ⟨58 unchanged words⟩ :"object"},{"type":"null"}],"description":"Null when not found. Free-text descriptions, facilities, photos, channel mappings, integrations, credentials and arbitrary metadata are never returned."},"status":{"enum":["found", ⟨8 unchanged words⟩ 

 ⟨6 unchanged words⟩ "readOnlyHint":true,"title":"Get room type details"}

ListShow daily ratesprices and restrictions

ListUse 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 stay restrictions of one organization-owned rate plan over aup dateto range90 ofdays; atdays mostwithout 90a days.row Guest,use payment,the channel,plan's credential,base andprice. arbitraryNot metadatafor whether rooms are excluded.free.

 ⟨5 unchanged words⟩ ,"properties":{"dateFrom":{"description":"InclusiveFirst night as YYYY-MM-DD start(inclusive)","pattern":"^\\d{4}-\\d{2}-\\d ⟨3 unchanged words⟩ :"string"},"dateTo":{"description":"InclusiveLast night as YYYY-MM-DD end(inclusive); the range covers at most 90 days","pattern":"^\\d{4}-\\d{2}-\\d ⟨3 unchanged words⟩ :"string"},"hotelId":{"description":"24-characterHotel id: 24 lowercase hexadecimal hotel idcharacters","pattern":"^[0-9a-f]{24}$","type":"string"},"ratePlanId":{"description":"24-characterRate plan id, belonging to hotelId: 24 lowercase hexadecimal rate-plan idcharacters","pattern":"^[0-9a-f]{24}$" ⟨9 unchanged words⟩ 

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"dailyRates":{"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.","items":{"additionalProperties":false,"properties":{" ⟨79 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":true,"title":"ListShow daily ratesprices and restrictions"}

List extras and add-ons

ListUse athis boundedwhen pagesomeone ofasks thewhat activeextras add-ona /hotel extra-servicesells, catalogsuch inas thebreakfast, authenticatedparking, organization.spa, Guesttransfers chargesor fees, folioand datawhat they cost. Returns each active extra's name, displayprice colorsin minor currency units, currency, category and credentialstaxable areflag, excluded.20 per page by default. Not for what a guest bought or was charged.

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"hotelId":{"description":"Only this hotel (24 lowercase hexadecimal characters); every hotel when absent","pattern":"^[0-9a-f]{24}$","type":"string"},"limit":{"description":"Extras per page, from 1 to 100; defaults to 20","exclusiveMinimum":0,"maximum":100,"type":"integer"},"offset":{"description":"Extras to skip, from 0 to 10000; defaults to 0. For the next page pass offset + limit","maximum":10000,"minimum":0,"type": ⟨3 unchanged words⟩ 

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"extras":{"description":"Active extras; price is in integer minor currency units. Guest charges, folio data, display colors and credentials are excluded.","items":{"additionalProperties":false,"properties":{"category":{"anyOf":[{"$ref":"#/properties/extras/items/properties/name#/properties/extras/items/properties/name/anyOf/0"},{"type":"null"}],"description":"BREAKFAST, PARKING, SPA, TRANSFER, FEE or OTHER"},"currency":{"$ref":"#/properties/extras/items/properties/name"},"name" ⟨31 unchanged words⟩ :"array"},"page":{"additionalProperties":false,"description":"hasMore is true when another page exists; request it with offset + limit","properties":{"hasMore":{"type":" ⟨34 unchanged words⟩ 

 ⟨5 unchanged words⟩ false,"readOnlyHint":true,"title":"List extras and add-ons"}

List your hotels

ListUse athis boundedwhen pagesomeone ofasks non-sensitivewhich hotelhotels metadataor inproperties thethey authenticatedmanage in Hotelumo, organization.or Addresses,a phonehotel's numbers,id channelis credentials,needed. paymentReturns configurationeach hotel's id, remindername, configurationcurrency, language and timezone, 20 per page by default (no addresses or guest data). areNot excluded.for room availability.

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"limit":{"description":"Hotels per page, from 1 to 100; defaults to 20","exclusiveMinimum":0,"maximum":100,"type":"integer"},"offset":{"description":"Hotels to skip, from 0 to 10000; defaults to 0. For the next page pass offset + limit","maximum":10000,"minimum":0,"type": ⟨3 unchanged words⟩ 

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"hotels":{"description":"Hotels in the signed-in organization. Addresses, phone numbers, channel credentials, payment configuration, reminder configuration and guest data are excluded.","items":{"additionalProperties":false,"properties":{" ⟨40 unchanged words⟩ :"array"},"page":{"additionalProperties":false,"description":"hasMore is true when another page exists; request it with offset + limit","properties":{"hasMore":{"type":" ⟨34 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"List your hotels"}

List rate plans and base prices

ListUse this when someone asks what rate plans a boundedhotel pagesells, ofsuch rate-planas pricingroom-only configurationor forbreakfast-included onerates, organization-ownedand hotel.their Channel-managerbase mappingsprices. Returns each plan's title, integrationroom metadatatype, base price in minor currency units, meal plan, per-room or per-person pricing and credentialsdefault areflag, excluded.20 per page by default. Not for prices on specific dates.

 ⟨5 unchanged words⟩ ,"properties":{"hotelId":{"description":"24-characterHotel id: 24 lowercase hexadecimal hotel idcharacters","pattern":"^[0-9a-f]{24}$","type":"string"},"limit":{"description":"Rate plans per page, from 1 to 100; defaults to 20","exclusiveMinimum":0,"maximum":100,"type":"integer"},"offset":{"description":"Rate plans to skip, from 0 to 10000; defaults to 0. For the next page pass offset + limit","maximum":10000,"minimum":0,"type":"integer"},"roomTypeId":{"description":"Only this room type (24 lowercase hexadecimal characters)","pattern":"^[0-9a-f]{24}$"," ⟨6 unchanged words⟩ 

 ⟨5 unchanged words⟩ properties":{"page":{"additionalProperties":false,"description":"hasMore is true when another page exists; request it with offset + limit","properties":{"hasMore":{"type":"boolean" ⟨26 unchanged words⟩ ,"type":"object"},"ratePlans":{"description":"basePrice is in integer minor currency units. Channel-manager mappings, integration metadata and credentials are excluded.","items":{"additionalProperties":false,"properties":{" ⟨25 unchanged words⟩ {"$ref":"#/properties/ratePlans/items/properties/title"},"rateMode":{"anyOf":[{"$ref":"#/properties/ratePlans/items/properties/title#/properties/ratePlans/items/properties/title/anyOf/0"},{"type":"null"}],"description":"manual or derived"},"roomTypeId":{"anyOf":[{"pattern ⟨40 unchanged words⟩ 

 ⟨6 unchanged words⟩ "readOnlyHint":true,"title":"List rate plans and base prices"}

ListUse athis boundedwhen pagesomeone asks what kinds of room-typerooms inventorya metadatahotel inoffers theor authenticatedhow organization.many Photos,guests publiceach descriptionsroom type sleeps. Returns each room type's id, rate-planhotel, internalsname and maximum guests, channelsorted mappingsby name, and20 credentialsper arepage excluded.by default. Not for whether a room type is free on given dates.

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"hotelId":{"description":"Only this hotel (24 lowercase hexadecimal characters); every hotel when absent","pattern":"^[0-9a-f]{24}$","type":"string"},"limit":{"description":"Room types per page, from 1 to 100; defaults to 20","exclusiveMinimum":0,"maximum":100,"type":"integer"},"offset":{"description":"Room types to skip, from 0 to 10000; defaults to 0. For the next page pass offset + limit","maximum":10000,"minimum":0,"type": ⟨3 unchanged words⟩ 

 ⟨5 unchanged words⟩ properties":{"page":{"additionalProperties":false,"description":"hasMore is true when another page exists; request it with offset + limit","properties":{"hasMore":{"type":"boolean" ⟨26 unchanged words⟩ ],"type":"object"},"roomTypes":{"description":"Room types sorted by name. Photos, public descriptions, rate-plan internals, channel mappings and credentials are excluded.","items":{"additionalProperties":false,"properties":{ ⟨57 unchanged words⟩ 

ListCheck physicalroom roomsand housekeeping status

ListUse athis boundedwhen pagesomeone 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 statustype metadataand inhotel thewith authenticatedits organization.room Reservation,and occupant,housekeeping gueststatus, access-control,20 andper channelpage by default (no guest or occupant data). Not for which rooms are excluded.free on given dates.

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"hotelId":{"description":"Only this hotel (24 lowercase hexadecimal characters); every hotel when absent","pattern":"^[0-9a-f]{24}$","type":"string"},"limit":{"description":"Rooms per page, from 1 to 100; defaults to 20","exclusiveMinimum":0,"maximum":100,"type":"integer"},"offset":{"description":"Rooms to skip, from 0 to 10000; defaults to 0. For the next page pass offset + limit","maximum":10000,"minimum":0,"type":"integer"},"roomTypeId":{"description":"Only this room type (24 lowercase hexadecimal characters)","pattern":"^[0-9a-f]{24}$"," ⟨4 unchanged words⟩ 

 ⟨5 unchanged words⟩ properties":{"page":{"additionalProperties":false,"description":"hasMore is true when another page exists; request it with offset + limit","properties":{"hasMore":{"type":"boolean" ⟨26 unchanged words⟩ ,"type":"object"},"rooms":{"description":"Physical rooms sorted by name. Internal room ids, reservation, occupant, guest, access-control and channel data are excluded.","items":{"additionalProperties":false,"properties":{" ⟨9 unchanged words⟩ type":"null"}]},"housekeepingStatus":{"anyOf":[{"$ref":"#/properties/rooms/items/properties/name#/properties/rooms/items/properties/name/anyOf/0"},{"type":"null"}],"description":"CLEAN, DIRTY or INSPECTED"},"lastEditTime":{"$ref":"#/properties/rooms/items/properties/name"},"name" ⟨8 unchanged words⟩ {"$ref":"#/properties/rooms/items/properties/hotelId"},"status":{"anyOf":[{"$ref":"#/properties/rooms/items/properties/name#/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"}},"required":["hotelId","roomTypeId" ⟨15 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":true,"title":"ListCheck physicalroom roomsand housekeeping status"}

Render a bounded tenant-scoped operationalUse snapshotthis forwhen onesomeone Hotelumowants hotel.a Reservationquick countsoverview coveror andashboard aggregateof next-seven-UTC-dayone samplehotel's andoperations. neverReturns exposean individualoverview stays.card Guestwith identities,the contacthotel's details, reservation orstatus allocationcounts identifiers,for exactthe individualnext stay7 recordsdays, notesand room, documentsroom-type, occupantroom-status ids,and payments,housekeeping accesscounts data,from integrationbounded configuration,samples credentials(no guest, andstay arbitraryor metadatapayment aredata). excluded.Not for a single reservation.

 ⟨3 unchanged words⟩ ,"properties":{"hotelId":{"description":"24-characterHotel id: 24 lowercase hexadecimal hotel idcharacters","pattern":"^[0-9a-f]{24}$" ⟨6 unchanged words⟩ 

 ⟨58 unchanged words⟩ :"object"},{"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."},"housekeepingStatusCounts":{"additionalProperties":{"maximum": ⟨36 unchanged words⟩ object"},"reservations":{"additionalProperties":false,"description":"Reservations overlapping the next seven UTC days, any status, sampled up to 50; hasMore marks a lower bound","properties":{"count":{"maximum":50," ⟨29 unchanged words⟩ object"},"roomTypes":{"additionalProperties":false,"description":"Room types, sampled up to 50; hasMore marks a lower bound","properties":{"count":{"maximum":50," ⟨11 unchanged words⟩ :"object"},"rooms":{"additionalProperties":false,"description":"Physical rooms, sampled up to 100; hasMore marks a lower bound","properties":{"count":{"maximum":100 ⟨54 unchanged words⟩ 

{"destructiveHint":false,"idempotentHint":true,"openWorldHint":false,"readOnlyHint":true,"title":"Show hotel operations overview"}