Cloudbeds · JSON Structure

Cloudbeds Reservation Structure

A Cloudbeds reservation representing a guest stay across one or more rooms at a Cloudbeds-managed property.

Type: Properties: 0
HospitalityHotelsPMSProperty ManagementChannel ManagerBooking EnginePayments

Reservation is a JSON Structure definition published by Cloudbeds.

Meta-schema:

JSON Structure

Raw ↑
{
  "name": "Reservation",
  "description": "A Cloudbeds reservation representing a guest stay across one or more rooms at a Cloudbeds-managed property.",
  "fields": [
    { "name": "reservationID", "type": "string", "required": true, "description": "Cloudbeds reservation identifier" },
    { "name": "propertyID", "type": "string", "required": true, "description": "Cloudbeds property identifier" },
    { "name": "guestID", "type": "string", "required": false, "description": "Primary guest identifier" },
    { "name": "guestName", "type": "string", "required": false, "description": "Primary guest full name" },
    { "name": "status", "type": "string", "required": true, "description": "Status: confirmed, not_confirmed, in_house, checked_out, cancelled, no_show" },
    { "name": "source", "type": "string", "required": false, "description": "Booking source channel (direct, booking_com, expedia, airbnb, etc.)" },
    { "name": "startDate", "type": "date", "required": true, "description": "Check-in date" },
    { "name": "endDate", "type": "date", "required": true, "description": "Check-out date" },
    { "name": "rooms", "type": "array<object>", "required": false, "description": "Rooms reserved with roomID, roomTypeID, adults, children, ratePlanID" },
    { "name": "subtotal", "type": "number", "required": false, "description": "Reservation subtotal before taxes and fees" },
    { "name": "taxes", "type": "number", "required": false, "description": "Total taxes applied" },
    { "name": "total", "type": "number", "required": false, "description": "Total reservation amount" },
    { "name": "currency", "type": "string", "required": false, "description": "ISO 4217 currency code" },
    { "name": "balance", "type": "number", "required": false, "description": "Outstanding balance owed" },
    { "name": "dateCreated", "type": "datetime", "required": false, "description": "Creation timestamp" },
    { "name": "dateModified", "type": "datetime", "required": false, "description": "Last modification timestamp" }
  ]
}