Sign in
Reservation

Returns a specific reservation.

Retrieves a reservation, specified by its ID.<br>You must have at least one of these scopes: 'reservations.read, reservations.manage'.

get/booking/v1/reservations/{id}

Path parameters

idstring required

Id of the reservation to be retrieved.

Query parameters

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: timeSlices, services, booker, actions, company, assignedUnits. All other values will be silently ignored.

Response

Success

idstring required

Reservation id

bookingIdstring required

Booking id

blockIdstring nullable

Block id

groupNamestring nullable

Name of the group

status'Confirmed' | 'InHouse' | 'CheckedOut' | 'Canceled' | 'NoShow' required

Status of the reservation

checkInTimestring date-time nullable

Time of check-in<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

checkOutTimestring date-time nullable

Time of check-out<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

cancellationTimestring date-time nullable

Time of cancellation, if the reservation was canceled<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

noShowTimestring date-time nullable

Time of setting no-show reservation status<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

arrivalstring date-time required

Date of arrival<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

departurestring date-time required

Date of departure<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

createdstring date-time required

Date of creation<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

modifiedstring date-time required

Date of last modification<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

adultsinteger required

Number of adults

childrenAgesinteger[] nullable

The ages of the children

commentstring nullable

Additional information and comments

guestCommentstring nullable

Additional information and comment by the guest

externalCodestring nullable

Code in external system

channelCode'Direct' | 'BookingCom' | 'Ibe' | 'ChannelManager' | 'Expedia' | 'Homelike' | 'Hrs' | 'AltoVita' | 'DesVu' | 'Gimsi' required

Channel code<br /><b>Deprecated values:</b> Homelike: Homelike channel is deprecated and no longer accepts new bookings or rate plans.

sourcestring nullable

Source of the reservation (e.g Hotels.com, Orbitz, etc.)

hasActivePaymentAccountboolean

True if the reservation has at least one active payment account, false otherwise. This is a read-only property and is not set by the client. It is used to determine if the reservation has an active payment account without having to retrieve the payment account details.

guaranteeType'PM6Hold' | 'CreditCard' | 'Prepayment' | 'Company' | 'Ota' required

The strongest guarantee for the rate plans booked in this reservation

travelPurpose'Business' | 'Leisure' nullable

The purpose of the trip, leisure or business

corporateCodestring nullable

Corporate code provided during creation. Used to find offers during amend.

allFoliosHaveInvoiceboolean

Whether all folios of a reservation have an invoice

hasCityTaxboolean required

Whether the city tax has already been added to the reservation. Set to false, if the property does not have city tax configured

promoCodestring nullable

The promo code associated with a certain special offer used to create the reservation

isPreCheckedInboolean

Indicates whether the reservation is marked as pre-checked-in or not.

isOpenForChargesboolean required

Whether the reservation can accept charges on its folios. This is purely informational and no validation is performed on this field. Defaults to true.

isUnitAssignmentLockedboolean

Indicates whether the unit assignments for this reservation are locked

Example response

{
  "id": "XPGMSXGF-1",
  "bookingId": "XPGMSXGF",
  "status": "Confirmed",
  "unit": {
    "id": "MUC-MTA",
    "name": "A.101",
    "description": "Single room",
    "unitGroupId": "MUC-SGL"
  },
  "property": {
    "id": "MUC",
    "code": "MUC",
    "name": "Demo Hotel Munich",
    "description": "This is the demo hotel Munich"
  },
  "ratePlan": {
    "id": "MUC-NONREF_SGL",
    "code": "NONREF",
    "name": "Non Refundable",
    "description": "Non Refundable",
    "isSubjectToCityTax": false
  },
  "unitGroup": {
    "id": "MUC-SGL",
    "code": "SGL",
    "name": "Single",
    "description": "Single",
    "type": "BedRoom"
  },
  "totalGrossAmount": {
    "amount": 222,
    "currency": "EUR"
  },
  "arrival": "2026-09-03T17:00:00+02:00",
  "departure": "2026-09-05T11:00:00+02:00",
  "created": "2026-09-01T13:40:59.7493356+02:00",
  "modified": "2026-09-01T13:40:59.7493356+02:00",
  "adults": 1,
  "childrenAges": [
    6
  ],
  "externalCode": "812864414|369",
  "channelCode": "BookingCom",
  "primaryGuest": {
    "title": "Mr",
    "gender": "Male",
    "firstName": "Jon",
    "middleInitial": "D",
    "lastName": "Doe",
    "email": "john.d@doe.com",
    "phone": "+4989123343",
    "address": {
      "addressLine1": "My Street 5",
      "postalCode": "12453",
      "city": "MyCity",
      "countryCode": "GB"
    },
    "vehicleRegistration": {
      "number": "APA322",
      "countryCode": "DE"
    }
  },
  "paymentAccount": {
    "accountNumber": "1111",
    "accountHolder": "John Doe",
    "expiryMonth": "8",
    "expiryYear": "2018",
    "paymentMethod": "visa",
    "payerEmail": "s.hopper@test.com",
    "isVirtual": false,
    "isActive": false
  },
  "hasActivePaymentAccount": false,
  "registeredCard": {
    "cardNumber": "1111",
    "cardHolder": "John Doe",
    "expiryMonth": "8",
    "expiryYear": "2018",
    "paymentMethod": "visa",
    "payerEmail": "s.hopper@test.com",
    "note": "Credit card will be available after 2025-06-23 10:00:00",
    "isVirtual": false
  },
  "timeSlices": [
    {
      "from": "2026-09-03T17:00:00+02:00",
      "to": "2026-09-04T11:00:00+02:00",
      "serviceDate": "2026-09-03",
      "ratePlan": {
        "id": "MUC-NONREF_SGL",
        "code": "NONREF",
        "name": "Non Refundable",
        "description": "Non Refundable",
        "isSubjectToCityTax": false
      },
      "unitGroup": {
        "id": "MUC-SGL",
        "code": "SGL",
        "name": "Single",
        "description": "Single",
        "type": "BedRoom"
      },
      "unit": {
        "id": "MUC-MTA",
        "name": "A.101",
        "description": "Single room",
        "unitGroupId": "MUC-SGL"
      },
      "baseAmount": {
        "grossAmount": 65,
        "netAmount": 60.75,
        "vatType": "Reduced",
        "vatPercent": 7,
        "currency": "EUR"
      },
      "totalGrossAmount": {
        "amount": 86,
        "currency": "EUR"
      },
      "includedServices": [
        {
          "service": {
            "id": "MUC-BRKF",
            "code": "BRKF",
            "name": "Breakfast",
            "description": "Best breakfast on this side of the Weißwurstäquator."
          },
          "serviceDate": "2026-09-04",
          "count": 0,
          "amount": {
            "grossAmount": 9.99,
            "netAmount": 8.39,
            "vatType": "Normal",
            "vatPercent": 19,
            "currency": "EUR"
          },
          "bookedAsExtra": false
        }
      ]
    },
    {
      "from": "2026-09-04T17:00:00+02:00",
      "to": "2026-09-05T11:00:00+02:00",
      "serviceDate": "2026-09-04",
      "ratePlan": {
        "id": "MUC-NONREF_SGL",
        "code": "NONREF",
        "name": "Non Refundable",
        "description": "Non Refundable",
        "isSubjectToCityTax": false
      },
      "unitGroup": {
        "id": "MUC-SGL",
        "code": "SGL",
        "name": "Single",
        "description": "Single",
        "type": "BedRoom"
      },
      "unit": {
        "id": "MUC-MTA",
        "name": "A.101",
        "description": "Single room",
        "unitGroupId": "MUC-SGL"
      },
      "baseAmount": {
        "grossAmount": 91.01,
        "netAmount": 85.06,
        "vatType": "Reduced",
        "vatPercent": 7,
        "currency": "EUR"
      },
      "totalGrossAmount": {
        "amount": 101,
        "currency": "EUR"
      },
      "includedServices": [
        {
          "service": {
            "id": "MUC-BRKF",
            "code": "BRKF",
            "name": "Breakfast",
            "description": "Best breakfast on this side of the Weißwurstäquator."
          },
          "serviceDate": "2026-09-05",
          "count": 0,
          "amount": {
            "grossAmount": 9.99,
            "netAmount": 8.39,
            "vatType": "Normal",
            "vatPercent": 19,
            "currency": "EUR"
          },
          "bookedAsExtra": false
        }
      ]
    }
  ],
  "guaranteeType": "CreditCard",
  "cancellationFee": {
    "id": "MUC-FLEX",
    "code": "FLEX",
    "name": "Flexible",
    "description": "Free cancellation.",
    "dueDateTime": "2026-09-03T17:00:00+02:00",
    "fee": {
      "amount": 202,
      "currency": "EUR"
    }
  },
  "noShowFee": {
    "id": "MUC-NOSHOW",
    "code": "NOSHOW",
    "name": "Non Refundable",
    "description": "No free no-show",
    "fee": {
      "amount": 202,
      "currency": "EUR"
    }
  },
  "balance": {
    "amount": -222,
    "currency": "EUR"
  },
  "validationMessages": [
    {
      "category": "OfferNotAvailable",
      "code": "RatePlanRestrictionsViolated",
      "message": "The restrictions of the rate plan are not considered"
    }
  ],
  "company": {
    "id": "MUC-UMBRELLA",
    "code": "UMBRELLA",
    "name": "Umbrella Corp.",
    "canCheckOutOnAr": false
  },
  "corporateCode": "UMBRELLA_DBL",
  "allFoliosHaveInvoice": false,
  "taxDetails": [
    {
      "vatType": "Null",
      "vatPercent": 0,
      "net": {
        "amount": 10,
        "currency": "EUR"
      },
      "tax": {
        "amount": 10,
        "currency": "EUR"
      }
    }
  ],
  "hasCityTax": true,
  "commission": {
    "commissionAmount": {
      "amount": 10,
      "currency": "EUR"
    },
    "beforeCommissionAmount": {
      "amount": 100,
      "currency": "EUR"
    }
  },
  "payableAmount": {
    "guest": {
      "amount": 10,
      "currency": "EUR"
    }
  },
  "isPreCheckedIn": false,
  "isOpenForCharges": true,
  "externalReferences": {
    "globalDistributionSystemId": "A2PA6WHY",
    "onlineTravelAgencyId": "5247241379",
    "onlineBookingToolId": "APA_HQL-C26181420|WAW-MUN-BC2-1U1",
    "channelManagerId": "123295310",
    "centralReservationSystemId": "91200088",
    "legacyId": "988232144060772"
  },
  "isUnitAssignmentLocked": false
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.