Offer

Returns offers for a specific rate plan.

Calculates and returns available offers for a specific rate plan, arrival and departure date.<br>You must have at least one of these scopes: 'offers.read, reservations.manage'.<br>For fine-grained clients, you must have this permission: 'core.offers.read'.

get/booking/v0-nsfw/rate-plan-offers

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/v0-nsfw/rate-plan-offers
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: offers.read, reservations.manage, admin

Query parameters

ratePlanIdstring required

The rate plan ID

arrivalstring required

Date and optional time of arrival<br />Specify either a pure date or a date and time in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

departurestring required

Date and optional time of departure. Cannot be more than 5 years after arrival.<br />Specify either a pure date or a date and time in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

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

The channel code

adultsinteger required

The number of adults you want offers for

childrenAgesinteger[]

The ages of the children you want offers for

includeUnavailableboolean

Return also offers that are currently not publicly bookable as restrictions are violated. By default only available offers are returned

overridePricesnumber[]

Desired prices for each timeslice

Response

Success.

Example response

{
  "property": {
    "id": "MUC",
    "code": "MUC",
    "name": "Demo Hotel Munich",
    "description": "This is the demo hotel Munich"
  },
  "offers": [
    {
      "arrival": "2026-11-01T17:00:00+01:00",
      "departure": "2026-11-03T11:00:00+01:00",
      "unitGroup": {
        "id": "MUC-SGL",
        "code": "SGL",
        "name": "Standard",
        "description": "Standard",
        "maxPersons": 1,
        "rank": 2,
        "type": "BedRoom"
      },
      "minGuaranteeType": "PM6Hold",
      "availableUnits": 4,
      "ratePlan": {
        "id": "MUC-NONREF_SGL",
        "code": "NONREF",
        "name": "Non Refundable",
        "description": "Non Refundable",
        "isSubjectToCityTax": false
      },
      "totalGrossAmount": {
        "amount": 279,
        "currency": "EUR"
      },
      "cancellationFee": {
        "code": "FLEX",
        "name": "Flexible",
        "description": "Free cancellation.",
        "dueDateTime": "2026-11-01T17:00:00+01:00",
        "fee": {
          "amount": 279,
          "currency": "EUR"
        }
      },
      "noShowFee": {
        "code": "NOSHOW",
        "name": "Non Refundable",
        "description": "No free no-show",
        "fee": {
          "amount": 279,
          "currency": "EUR"
        }
      },
      "timeSlices": [
        {
          "from": "2026-11-01T17:00:00+01:00",
          "to": "2026-11-02T11:00:00+01:00",
          "availableUnits": 4,
          "baseAmount": {
            "grossAmount": 107,
            "netAmount": 100,
            "vatType": "Reduced",
            "vatPercent": 7,
            "currency": "EUR"
          },
          "totalGrossAmount": {
            "amount": 117,
            "currency": "EUR"
          },
          "includedServices": [
            {
              "service": {
                "id": "MUC-WLAN"
              },
              "serviceDate": "2026-11-01",
              "count": 1,
              "availableCount": 5,
              "amount": {
                "grossAmount": 10,
                "netAmount": 8.4,
                "vatType": "Normal",
                "vatPercent": 19,
                "currency": "EUR"
              },
              "pricingMode": "Included",
              "taxes": [
                {
                  "taxDefinitionCode": "SERVICE-TAX",
                  "amount": {
                    "grossAmount": 2,
                    "netAmount": 2,
                    "vatType": "Without",
                    "vatPercent": 0,
                    "currency": "EUR"
                  },
                  "remittedBy": "Hotel"
                }
              ]
            }
          ]
        },
        {
          "from": "2026-11-02T11:00:00+01:00",
          "to": "2026-11-03T11:00:00+01:00",
          "availableUnits": 5,
          "baseAmount": {
            "grossAmount": 107,
            "netAmount": 100,
            "vatType": "Reduced",
            "vatPercent": 7,
            "currency": "EUR"
          },
          "totalGrossAmount": {
            "amount": 142,
            "currency": "EUR"
          },
          "includedServices": [
            {
              "service": {
                "id": "MUC-WLAN"
              },
              "serviceDate": "2026-11-02",
              "count": 1,
              "availableCount": 5,
              "amount": {
                "grossAmount": 10,
                "netAmount": 8.4,
                "vatType": "Normal",
                "vatPercent": 19,
                "currency": "EUR"
              },
              "pricingMode": "Included",
              "taxes": [
                {
                  "taxDefinitionCode": "SERVICE-TAX",
                  "amount": {
                    "grossAmount": 2,
                    "netAmount": 2,
                    "vatType": "Without",
                    "vatPercent": 0,
                    "currency": "EUR"
                  },
                  "remittedBy": "Hotel"
                }
              ]
            },
            {
              "service": {
                "id": "MUC-CLEANING"
              },
              "serviceDate": "2026-11-02",
              "count": 1,
              "availableCount": 2,
              "amount": {
                "grossAmount": 25,
                "netAmount": 21.01,
                "vatType": "Normal",
                "vatPercent": 19,
                "currency": "EUR"
              },
              "pricingMode": "Additional"
            }
          ]
        }
      ],
      "services": [
        {
          "service": {
            "id": "MUC-PARKING",
            "code": "PARKING",
            "name": "Parking",
            "description": "Parking spot per night",
            "pricingUnit": "Room",
            "defaultGrossPrice": {
              "amount": 20,
              "currency": "EUR"
            }
          },
          "count": 1,
          "availableCount": 3,
          "totalAmount": {
            "grossAmount": 20,
            "netAmount": 16.81,
            "vatType": "Normal",
            "vatPercent": 19,
            "currency": "EUR"
          },
          "prePaymentAmount": {
            "amount": 0,
            "currency": "EUR"
          },
          "dates": [
            {
              "serviceDate": "2026-11-01",
              "amount": {
                "grossAmount": 20,
                "netAmount": 16.81,
                "vatType": "Normal",
                "vatPercent": 19,
                "currency": "EUR"
              },
              "isDefaultDate": true,
              "isMandatory": false,
              "availableCount": 3,
              "taxes": [
                {
                  "taxDefinitionCode": "PARKING-TAX",
                  "amount": {
                    "grossAmount": 2,
                    "netAmount": 2,
                    "vatType": "Without",
                    "vatPercent": 0,
                    "currency": "EUR"
                  },
                  "remittedBy": "Hotel"
                }
              ]
            }
          ]
        }
      ],
      "taxDetails": [
        {
          "vatType": "Reduced",
          "vatPercent": 7,
          "net": {
            "amount": 200,
            "currency": "EUR"
          },
          "tax": {
            "amount": 14,
            "currency": "EUR"
          }
        },
        {
          "vatType": "Normal",
          "vatPercent": 19,
          "net": {
            "amount": 54.62,
            "currency": "EUR"
          },
          "tax": {
            "amount": 10.38,
            "currency": "EUR"
          }
        }
      ],
      "isCorporate": false,
      "prePaymentAmount": {
        "amount": 0,
        "currency": "EUR"
      },
      "cityTaxes": [
        {
          "id": "MUC-TAX",
          "code": "TAX",
          "name": "City tax",
          "totalGrossAmount": {
            "amount": 119,
            "currency": "EUR"
          },
          "dates": [
            {
              "serviceDate": "2021-08-27",
              "amount": {
                "grossAmount": 119,
                "netAmount": 100,
                "vatType": "Normal",
                "vatPercent": 19,
                "currency": "EUR"
              }
            }
          ]
        }
      ]
    },
    {
      "arrival": "2026-11-01T17:00:00+01:00",
      "departure": "2026-11-03T11:00:00+01:00",
      "unitGroup": {
        "id": "MUC-SGL",
        "code": "SGL",
        "name": "Standard",
        "description": "Standard",
        "maxPersons": 1,
        "rank": 2,
        "type": "BedRoom"
      },
      "minGuaranteeType": "Prepayment",
      "availableUnits": 4,
      "ratePlan": {
        "id": "MUC-FLEX_SGL",
        "code": "FLEX",
        "name": "Flexible",
        "description": "Flexible",
        "isSubjectToCityTax": false
      },
      "totalGrossAmount": {
        "amount": 503,
        "currency": "EUR"
      },
      "cancellationFee": {
        "code": "NONREF",
        "name": "Non Refundable",
        "description": "Full stay amount due 24 hours after booking.",
        "dueDateTime": "2026-10-31T12:12:37.4447906+01:00",
        "fee": {
          "amount": 503,
          "currency": "EUR"
        }
      },
      "noShowFee": {
        "code": "NOSHOW",
        "name": "Non Refundable",
        "description": "No free no-show",
        "fee": {
          "amount": 503,
          "currency": "EUR"
        }
      },
      "timeSlices": [
        {
          "from": "2026-11-01T17:00:00+01:00",
          "to": "2026-11-02T11:00:00+01:00",
          "availableUnits": 4,
          "baseAmount": {
            "grossAmount": 214,
            "netAmount": 200,
            "vatType": "Reduced",
            "vatPercent": 7,
            "currency": "EUR"
          },
          "totalGrossAmount": {
            "amount": 224,
            "currency": "EUR"
          },
          "includedServices": [
            {
              "service": {
                "id": "MUC-WLAN"
              },
              "serviceDate": "2026-11-01",
              "count": 1,
              "availableCount": 5,
              "amount": {
                "grossAmount": 10,
                "netAmount": 8.4,
                "vatType": "Normal",
                "vatPercent": 19,
                "currency": "EUR"
              },
              "pricingMode": "Included",
              "taxes": [
                {
                  "taxDefinitionCode": "SERVICE-TAX",
                  "amount": {
                    "grossAmount": 2,
                    "netAmount": 2,
                    "vatType": "Without",
                    "vatPercent": 0,
                    "currency": "EUR"
                  },
                  "remittedBy": "Hotel"
                }
              ]
            }
          ]
        },
        {
          "from": "2026-11-02T11:00:00+01:00",
          "to": "2026-11-03T11:00:00+01:00",
          "availableUnits": 5,
          "baseAmount": {
            "grossAmount": 214,
            "netAmount": 200,
            "vatType": "Reduced",
            "vatPercent": 7,
            "currency": "EUR"
          },
          "totalGrossAmount": {
            "amount": 249,
            "currency": "EUR"
          },
          "includedServices": [
            {
              "service": {
                "id": "MUC-WLAN"
              },
              "serviceDate": "2026-11-02",
              "count": 1,
              "availableCount": 5,
              "amount": {
                "grossAmount": 10,
                "netAmount": 8.4,
                "vatType": "Normal",
                "vatPercent": 19,
                "currency": "EUR"
              },
              "pricingMode": "Included",
              "taxes": [
                {
                  "taxDefinitionCode": "SERVICE-TAX",
                  "amount": {
                    "grossAmount": 2,
                    "netAmount": 2,
                    "vatType": "Without",
                    "vatPercent": 0,
                    "currency": "EUR"
                  },
                  "remittedBy": "Hotel"
                }
              ]
            },
            {
              "service": {
                "id": "MUC-CLEANING"
              },
              "serviceDate": "2026-11-02",
              "count": 1,
              "availableCount": 2,
              "amount": {
                "grossAmount": 25,
                "netAmount": 21.01,
                "vatType": "Normal",
                "vatPercent": 19,
                "currency": "EUR"
              },
              "pricingMode": "Additional"
            }
          ]
        }
      ],
      "services": [
        {
          "service": {
            "id": "MUC-SPA",
            "code": "SPA",
            "name": "Spa access",
            "description": "Spa access per stay",
            "pricingUnit": "Person",
            "defaultGrossPrice": {
              "amount": 30,
              "currency": "EUR"
            }
          },
          "count": 1,
          "availableCount": 2,
          "totalAmount": {
            "grossAmount": 30,
            "netAmount": 25.21,
            "vatType": "Normal",
            "vatPercent": 19,
            "currency": "EUR"
          },
          "prePaymentAmount": {
            "amount": 0,
            "currency": "EUR"
          },
          "dates": [
            {
              "serviceDate": "2026-11-01",
              "amount": {
                "grossAmount": 30,
                "netAmount": 25.21,
                "vatType": "Normal",
                "vatPercent": 19,
                "currency": "EUR"
              },
              "isDefaultDate": true,
              "isMandatory": false,
              "availableCount": 2
            }
          ]
        }
      ],
      "taxDetails": [
        {
          "vatType": "Reduced",
          "vatPercent": 7,
          "net": {
            "amount": 400,
            "currency": "EUR"
          },
          "tax": {
            "amount": 28,
            "currency": "EUR"
          }
        },
        {
          "vatType": "Normal",
          "vatPercent": 19,
          "net": {
            "amount": 63.02,
            "currency": "EUR"
          },
          "tax": {
            "amount": 11.98,
            "currency": "EUR"
          }
        }
      ],
      "isCorporate": false,
      "prePaymentAmount": {
        "amount": 503,
        "currency": "EUR"
      }
    }
  ]
}

Changes

No operation changes recorded.