Check-in / Upsell / Upgrade

(*)  Pre-Checkin feature certification mandatory requirements.

• Use getReservations with parameters status or CheckInFrom/CheckInTo and CheckOutFrom/CheckOutTo to get reservations for your specific purpose. e.g. Today's arrivals, today's departures.*
• Use putGuest to update guest data to existing guest (Specific attention on guest document information).*
• Use postGuest to upload data for new guests. Number of adults and children is specified on every reservation, don't allow more guest than specified.*
• Use postGuestDocument to upload a file e.g. passport scan, photography.
• Use postReservationDocument to upload a file referring to the entire reservation e.g. contract.
• Use postReservationNote to post any messages into myfrontdesk reservation.

• Use putReservation with status: checked_in to check in a guest or checked_out to check out a guest. 
• Checking out a guest is currently possible only when there is no open balance, use getReservationInvoiceInformation  to confirm that the reservation has been fully paid to be able to proceed with updating the reservation status to checked_out. 
• If a room is not assigned, use getRoomsUnassigned  to see available rooms and  allocate a room prior to check-in using postRoomAssign. 

(*) Upsell Category Certification mandatory requirements, two Way Sync, any upsold products posted to myfrontdesk.

1- Post any item/service to Cloudbeds folio (Option 1 - recommended)

• Use postCustomItem with reservationID/subreservationID parameter to post a charge for an item into myfrontdesk reservation. *
  Note: You need to specify taxes in order for the taxes to apply to the custom items. 
• Use postPayment to record a payment for the charged item
• Use getPaymentMethods to see which methods are available
• If payment method is not enabled or doesn't exist in myfrontdesk account create it using postCustomPaymentMethod
• Use getHotelDetails to see the myfrontdesk account default currency. Payments and charges can only be posted in the default currency.
• If you app has the ability to delete/cancel charges use postVoidItem to sync this event with Cloudbeds.

Two Way Sync, any items sold via the upselling platform are synced back to Cloudbeds including full price and tax information for items to the folio. *

2- Use existing Cloudbeds inventory (Option 2)

• Use getItems to get the list of all available items in myfrontdesk and getItemCategories if you're looking to reflect them in your system.
• Use getItem to get the details of a single item.
• Use postItem with reservationID parameter to post a charge for an item into myfrontdesk reservation.
• Use postPayment to record a payment for the charged item.
• Use getHotelDetails to see the myfrontdesk account default currency. Payments and charges can only be posted in the default currency.
• If you app has the ability to delete/cancel charges use postVoidItem to sync that to Cloudbeds.

Amenities and Add ons where inventory is managed in Cloudbeds are pulled from live availability in real time and when booked via the upselling platform are synced back to Cloudbeds *

• Use getAvailableRoomTypes with detailedRates parameter to see the available room types and it's rates. *
• Use putReservation to change the room type or add additional rooms to a reservation. (*)
• Use postAdjustment to adjust the price of the room if needed. Only if an applicable discount is needed.  *
• Use postReservationNote to indicate the new room type that has been upgraded.

Room Upgrades are pulled from live availability in real-time and when booked via the upselling platform are synced back to Cloudbeds  *

• Use getReservationInvoiceInformation to get the amount due.
• Use postPayment to record the payment.
• Use Reservation-getReservationsWithRateDetails to see paymentCollect details and allow to charge for the amount due only if "Hotel" collects the payment.

• Use getRoomsUnassigned to get the list of the available rooms.
• Use postRoomAssign to assign a room on a reservation.

(*)  Kiosk certification mandatory requirements.

• Use getReservations with parameters status or CheckInFrom/CheckInTo and CheckOutFrom/CheckOutTo to get reservations for your specific purpose. e.g. Today's arrivals, today's departures. Only allow confirmed reservations to be checked-in *
• Use putGuest to update guest data to existing guest (Specific attention on guest document information).*
• Use postGuest to upload data for new guests. Number of adults and children is specified on every reservation, don't allow more guest than specified.*
• Use putReservation with status: checked_in to check in a guest or checked_out to check out a guest. (*) 
• Checking out a guest is currently possible only when there is no open balance, use getReservationInvoiceInformation  to confirm that the reservation has been fully paid to be able to proceed with updating the reservation status to checked_out. Alternatively, to process the outstanding payment see Charge for the stay guidelines above *
• Guests should be able to check-in and check-out using the third-party id. Use  thidPartyIdentifier to match with Cloudbeds reservationID.*
• If a room is not assigned use getRoomsUnassigned  to see available rooms and  allocate a room prior to check-in using postRoomAssign *

• Use /postEmailTemplate to create an email template with the same custom field. Myfrondesk will send out the email to the guest.
• Use the /postEmailShedule to schedule the template either based on the reservation status change or a date.

Missing a method to fully sync your product? We'd love to hear from you.

Click here to submit your requests.