ChatBedsРазработчикам
Справочник API

Эта страница ещё не переведена, поэтому вы читаете английскую версию.

Front desk

Today's arrivals, departures and guests in house; check guests in and out, and mark no-shows.

The front desk operations work on bookings exactly as the hotel's own front desk does: a room must be assigned and ready before check-in, the bill must be settled before check-out, and every change shows on the tape chart, alerts the staff and is kept on the booking's history as your app's.

Arrivals, departures and in house

GET/properties/{property_id}/arrivals
Scope reservations:readOperation frontDesk.arrivals
GET/properties/{property_id}/departures
Scope reservations:readOperation frontDesk.departures
GET/properties/{property_id}/in-house
Scope reservations:readOperation frontDesk.inHouse

Arrivals are the bookings arriving on a day (checked in already or not yet); departures, those leaving on a day; in house, everyone checked in now, including a guest who should have left already. Each answers a list of reservation objects.

property_id uuid (path)required
The property.
date date (query)
Arrivals and departures only. Default: today at the hotel, in its own time zone.
Request
curl "https://app.chatbeds.app/partner/v1/properties/19306340-c7cf-465a-93d3-0b7873a7e85d/arrivals?date=2026-11-05" \
  -H "Authorization: Bearer cbk_••••"
200 OK
{
  "reservations": [
    {
      "id": "a589df05-30ad-4ee5-9832-16ff6c2c1d0e",
      "ref": "A589DF",
      "status": "confirmed",
      "arrival": "2026-11-05",
      "departure": "2026-11-07",
      "guest": { "first_name": "Sara", "last_name": "Khan", "email": null, "phone": "+923001234567" },
      "unit": { "id": "89951b18-48c5-4096-8942-290d555eb236", "name": "101" },
      "total": 200.0,
      "paid": 0.0,
      "balance": 200.0
    }
  ],
  "date": "2026-11-05"
}

Reservations are shown trimmed; each is the whole object. date is null for in house.

Check in

POST/reservations/{reservation_id}/check-in
Scope frontdesk:writeOperation frontDesk.checkIn

Checks the guest in to the room assigned to the booking. The room is then occupied and housekeeping is told. The answer is the updated reservation, and a warning when the room wasn't marked clean yet.

reservation_id uuid (path)required
The booking.
Request
curl -X POST "https://app.chatbeds.app/partner/v1/reservations/a589df05-30ad-4ee5-9832-16ff6c2c1d0e/check-in" \
  -H "Authorization: Bearer cbk_••••" \
  -H "Idempotency-Key: BK-104233-check-in"
200 OK
{
  "reservation": { "id": "a589df05-30ad-4ee5-9832-16ff6c2c1d0e", "status": "checked_in", "unit": { "name": "101" } },
  "warning": null
}

Errors

StatusWhen
409The booking isn't confirmed, arrives on a later day, has no room assigned yet, or its room is still occupied
403The app token lacks frontdesk:write
404Not a booking of this property

Check out

POST/reservations/{reservation_id}/check-out
Scope frontdesk:writeOperation frontDesk.checkOut

Checks the guest out. The room goes to housekeeping as dirty, and the hotel's invoice is made (when the hotel invoices at check-out).

The bill is settled first

Hotels ask guests to settle the bill before they leave. While the booking still owes, check-out answers 409 with "code": "balance_due": take the payment (record it with folio.addPayment, send a payment link), or let the hotel bill the guest's company, then check out again. Only the hotel's manager can let a guest leave owing, in ChatBeds itself. A hotel can turn this rule off; GET /capabilities tells you under features.settle_before_check_out.

reservation_id uuid (path)required
The booking.
Request
r = requests.post(f"{BASE}/reservations/{reservation_id}/check-out", headers=HEADERS)
if r.status_code == 409 and r.json().get("code") == "balance_due":
    folio = requests.get(f"{BASE}/reservations/{reservation_id}/folio", headers=HEADERS).json()["folio"]
    requests.post(f"{BASE}/reservations/{reservation_id}/folio/payments", headers=HEADERS,
                  json={"amount": folio["balance"], "method": "CARD", "reference": "POS-7731"})
    r = requests.post(f"{BASE}/reservations/{reservation_id}/check-out", headers=HEADERS)
409 Conflict
{
  "detail": "Sara Khan still owes USD 200.00. Settle the bill before check-out: take the payment, or bill it to the guest's company account. A manager can let them leave owing it, with a reason.",
  "code": "balance_due"
}
200 OK
{
  "reservation": { "id": "a589df05-30ad-4ee5-9832-16ff6c2c1d0e", "status": "checked_out", "balance": 0.0 },
  "invoice": "INV-2026-000184",
  "nights_early": 0
}

nights_early counts the nights given back when the guest leaves before their departure date; the charges stay as they are (refunding them is the hotel's decision).

Mark a no-show

POST/reservations/{reservation_id}/no-show
Scope frontdesk:writeOperation frontDesk.noShow

The guest never came. The room is released and the booking's status becomes no_show. The stay's charges come off and the hotel's no-show fee goes on, as its cancellation policy says, unless you send fee.

reservation_id uuid (path)required
The booking. It must be confirmed and its arrival day must have come.
fee number
The fee to charge instead of the policy's. 0 charges nothing.
Request
curl -X POST "https://app.chatbeds.app/partner/v1/reservations/a589df05-30ad-4ee5-9832-16ff6c2c1d0e/no-show" \
  -H "Authorization: Bearer cbk_••••" \
  -H "Content-Type: application/json" \
  -d '{"fee": 0}'
200 OK
{ "reservation": { "id": "a589df05-30ad-4ee5-9832-16ff6c2c1d0e", "status": "no_show" }, "fee": 0.0 }

Webhooks

Check-in and check-out send reservation.modified, as before, and also reservation.checked_in and reservation.checked_out to the apps that turn them on. A no-show sends reservation.cancelled and reservation.no_show.

Что-то создаёте?

На этой странице