APapaleo
Booking

Creates a booking for one or more reservations.

Changed on

Creates a booking taking a list of reservations as input.<br>You must have at least one of these scopes: 'reservations.create, reservations.manage'.<br>For fine-grained clients, you must have this permission: 'core.bookings.create'.

post/booking/v1/bookings

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/booking/v1/bookings
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: reservations.create, reservations.manage, admin

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Request body

commentstring nullable

Additional information and comments

bookerCommentstring nullable

Additional information and comments by the booker

transactionReferencestring nullable

The reference of a payment transaction. This should be set when a payment transaction has been initiated and should be used to complete the transaction upon reservation creation. When set, the payment transaction completion is always triggered regardless of the reservation guarantee type and payment automation settings.

Example request

{
  "paymentAccount": {
    "accountNumber": "1111",
    "accountHolder": "John Doe",
    "expiryMonth": "8",
    "expiryYear": "2018",
    "paymentMethod": "visa",
    "payerEmail": "s.hopper@test.com",
    "payerReference": "4ea6462b-cca3-4c17-a035-c7b5132db83c",
    "isVirtual": false
  },
  "booker": {
    "title": "Mr",
    "gender": "Male",
    "firstName": "Jon",
    "middleInitial": "D",
    "lastName": "Doe",
    "email": "john.d@doe.com",
    "phone": "+4989123343",
    "address": {
      "addressLine1": "My Street 1",
      "postalCode": "12453",
      "city": "MyCity",
      "countryCode": "GB"
    }
  },
  "reservations": [
    {
      "arrival": "2026-10-17",
      "departure": "2026-10-19",
      "adults": 1,
      "childrenAges": [
        6
      ],
      "guestComment": "I need a wake up service",
      "channelCode": "Direct",
      "primaryGuest": {
        "title": "Mr",
        "gender": "Male",
        "firstName": "Jon",
        "middleInitial": "D",
        "lastName": "Doe",
        "email": "john.d@doe.com",
        "phone": "+4989123343",
        "address": {
          "addressLine1": "My Street 1",
          "postalCode": "12453",
          "city": "MyCity",
          "countryCode": "GB"
        },
        "vehicleRegistration": {
          "number": "APA322",
          "countryCode": "DE"
        }
      },
      "guaranteeType": "Prepayment",
      "travelPurpose": "Business",
      "timeSlices": [
        {
          "ratePlanId": "MUC-NONREF-FAMILY"
        },
        {
          "ratePlanId": "MUC-NONREF-FAMILY"
        }
      ],
      "services": [
        {
          "serviceId": "MUC-BRKF"
        },
        {
          "serviceId": "MUC-YOGA",
          "dates": [
            {
              "serviceDate": "2026-10-18",
              "amount": {
                "amount": 35,
                "currency": "EUR"
              }
            }
          ]
        }
      ],
      "prePaymentAmount": {
        "amount": 50,
        "currency": "EUR"
      },
      "externalReferences": {
        "globalDistributionSystemId": "A2PA6WHY",
        "onlineTravelAgencyId": "5247241379",
        "onlineBookingToolId": "APA_HQL-C26181420|WAW-MUN-BC2-1U1",
        "channelManagerId": "123295310",
        "centralReservationSystemId": "91200088"
      }
    },
    {
      "arrival": "2026-10-18",
      "departure": "2026-10-20",
      "adults": 1,
      "childrenAges": [
        6
      ],
      "channelCode": "Direct",
      "primaryGuest": {
        "title": "Mr",
        "gender": "Male",
        "firstName": "Eric",
        "middleInitial": "E",
        "lastName": "Steinmetz",
        "email": "eric.e@steinmetz.com",
        "phone": "+4989123343",
        "address": {
          "addressLine1": "My Street 1",
          "postalCode": "12453",
          "city": "MyCity",
          "countryCode": "GB"
        },
        "vehicleRegistration": {
          "number": "APA322",
          "countryCode": "DE"
        }
      },
      "guaranteeType": "CreditCard",
      "timeSlices": [
        {
          "ratePlanId": "BER-FLEX-DBL",
          "totalAmount": {
            "amount": 120,
            "currency": "EUR"
          }
        },
        {
          "ratePlanId": "BER-FLEX-DBL",
          "totalAmount": {
            "amount": 125,
            "currency": "EUR"
          }
        }
      ],
      "companyId": "BER-UMBRELLA",
      "commission": {
        "commissionAmount": {
          "amount": 20,
          "currency": "EUR"
        },
        "beforeCommissionAmount": {
          "amount": 100,
          "currency": "EUR"
        }
      },
      "externalReferences": {
        "globalDistributionSystemId": "A2PA6WHY",
        "onlineTravelAgencyId": "5247241379",
        "onlineBookingToolId": "APA_HQL-C26181420|WAW-MUN-BC2-1U1",
        "channelManagerId": "123295310",
        "centralReservationSystemId": "91200088"
      }
    }
  ],
  "transactionReference": "564578124534890J"
}

Response

All new reservations were created.

idstring required

Booking id

Example response

{
  "id": "XPGMSXGF",
  "reservationIds": [
    {
      "id": "XPGMSXGF-1"
    },
    {
      "id": "XPGMSXGF-2"
    }
  ]
}

Changes