Sign in
Booking

Returns a specific booking.

Retrieves a booking with all its reservations.<br>You must have at least one of these scopes: 'reservations.read, reservations.manage'.

get/booking/v1/bookings/{id}

Path parameters

idstring required

Id of the booking to be retrieved.

Query parameters

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: property, unitGroup, ratePlan, services, reservations, propertyValues. All other values will be silently ignored.

Response

Success

idstring required

Booking id

groupIdstring nullable

Group id

hasActivePaymentAccountboolean

True if the booking 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 booking has an active payment account without having to retrieve the payment account details.

commentstring nullable

Additional information and comments

bookerCommentstring nullable

Additional information and comment by the booker

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>

Example response

{
  "id": "XPGMSXGF",
  "booker": {
    "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"
    }
  },
  "paymentAccount": {
    "accountNumber": "1111",
    "accountHolder": "John Doe",
    "expiryMonth": "8",
    "expiryYear": "2018",
    "paymentMethod": "visa",
    "payerEmail": "s.hopper@test.com",
    "isVirtual": false,
    "isActive": false
  },
  "hasActivePaymentAccount": true,
  "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
  },
  "comment": "The comment from the front desk or reservation office",
  "bookerComment": "The comment from the booker provided via the booking channel",
  "created": "0001-01-01T00:00:00Z",
  "modified": "0001-01-01T00:00:00Z",
  "reservations": [
    {
      "id": "XPGMSXGF-1",
      "status": "Confirmed",
      "externalCode": "345343345|334",
      "channelCode": "BookingCom",
      "paymentAccount": {
        "accountNumber": "1111",
        "accountHolder": "John Doe",
        "expiryMonth": "8",
        "expiryYear": "2018",
        "paymentMethod": "visa",
        "payerEmail": "s.hopper@test.com",
        "isVirtual": false,
        "isActive": false
      },
      "hasActivePaymentAccount": true,
      "arrival": "2026-09-03T17:00:00+02:00",
      "departure": "2026-09-05T11:00:00+02:00",
      "adults": 1,
      "childrenAges": [
        6
      ],
      "totalGrossAmount": {
        "amount": 130,
        "currency": "EUR"
      },
      "property": {
        "id": "MUC",
        "code": "MUC",
        "name": "Demo Hotel Munich",
        "description": "This is the demo hotel Munich"
      },
      "ratePlan": {
        "id": "MUC-NONREF_DBL",
        "code": "NONREF",
        "name": "Non Refundable",
        "description": "Non Refundable",
        "isSubjectToCityTax": false
      },
      "unitGroup": {
        "id": "MUC-DBL",
        "code": "DBL",
        "name": "Double",
        "description": "Double",
        "type": "BedRoom"
      },
      "guestComment": "The comment from the guest provided via the booking channel",
      "cancellationFee": {
        "id": "MUC-FLE",
        "code": "FLE",
        "name": "Flexible",
        "description": "Free cancellation until 36 hours before arrival.",
        "dueDateTime": "2026-09-03T17:00:00+02:00",
        "fee": {
          "amount": 30,
          "currency": "EUR"
        }
      },
      "noShowFee": {
        "id": "MUC-NONREF",
        "code": "NONREF",
        "name": "Non Refundable",
        "description": "No free no-show",
        "fee": {
          "amount": 130,
          "currency": "EUR"
        }
      },
      "company": {
        "id": "MUC-UMBRELLA",
        "code": "UMBRELLA",
        "name": "Umbrella Corp.",
        "canCheckOutOnAr": true
      },
      "isPreCheckedIn": false,
      "isOpenForCharges": true,
      "externalReferences": {
        "globalDistributionSystemId": "A2PA6WHY",
        "onlineTravelAgencyId": "5247241379",
        "onlineBookingToolId": "APA_HQL-C26181420|WAW-MUN-BC2-1U1",
        "channelManagerId": "123295310",
        "centralReservationSystemId": "91200088",
        "legacyId": "988232144060772"
      }
    }
  ]
}

Changes

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