Link

Getting offers

In order to get stay offers, call the following endpoint:

GET /booking/v1/offers

{
  {
  "offers": [
    {
      "ratePlan": { "name": "Non Refundable", ... },
      "unitGroup": { "name": "Single", ... },
      "minGuaranteeType": "Prepayment",
      "availableUnits": 22,
      "totalGrossAmount": { "amount": 151, "currency": "EUR" },
      "cancellationFee": { "code": "STR", "fee": { "amount": 151, "currency": "EUR" }, ... },
      "noShowFee": { "code": "NOSHOW", "fee": { "amount": 151, "currency": "EUR" } },
      "prePaymentGrossAmount": { "amount": 151, "currency": "EUR" },
      "cityTax": { "grossAmount": 21.4, "netAmount": 20, ... },
      "timeSlices": [
        ...
      ],
      "services": [
        ...
      ]
      "lineItems": [
        ...
      ],
      "taxDetails": [
        ...
      ],
      ...
    },
    ...
  ]
}
}

Depending on the rate plan setup in apaleo, you could get services for some offers. Such services are “mandatory”, and they are set up as “additional” services included in the rate plan. Booking such rate plans, mandatory services will be booked as extras and they cannot be removed. An example, would be a cleaning fee at the end of the stay. Since they have an influence on the offer price, you might want to display them to the guests during the booking process.

Once the stay offer has been selected, you can get service offers for the selected rate plan by calling the following endpoint:

GET /booking/v1/service-offers

{
  "services": [
    {
      "service": { "name": "Breakfast", "pricingUnit": "Person", ... },
      "count": 1,
      "totalAmount": { "grossAmount": 20, "netAmount": 16.81, ... },
      "prePaymentGrossAmount": { "amount": 20, "currency": "EUR" },
      "dates": [
        {
          "serviceDate": "2019-10-11",
          "amount": { "grossAmount": 20, "netAmount": 16.81, ... },
          "isDefaultDate": true
        }
      ]
    },
    ...
  ]
}

The user should be able to select one or more stay offers and optionally add service offers as extras to his or her reservation.

You can calculate the amount that needs to be pre-paid by summing up the prePaymentGrossAmount for all the selected offers including the service offers.


If you want to show a grand total including all fees and the city tax to the booker, you would have to sum up the amounts of all reservations, services and the respecitive city tax and fees. The totalGrossAmount of the reservation and the totalAmount of the services are without city tax and fees. When creating the booking apaleo will add the city tax and fees automatically.