Offer

Returns offers with rates and availabilities for the specified range.

Calculates and returns offers per time slice for multiple rate plans, arrival and departure date. The rate plans must belong to the same unit group and have the same time slice definition. Each time slice is priced as its own arrival, independent of the requested range. Prices are for adults only.<br>You must have at least one of these scopes: 'offer-index.read, offers.read'.<br>For fine-grained clients, you must have this permission: 'core.offers.read'.

get/booking/v0-nsfw/offer-index-bulk

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/offer-index-bulk
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: offer-index.read, offers.read, admin

Query parameters

ratePlanIdsstring[] required
fromstring required

<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>

tostring required

<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' required
pageNumberinteger

Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.

pageSizeinteger

Items per page. Default: 500. Maximum: 500.

Response

Success.

Example response

{
  "ratePlans": [
    {
      "timeSlices": [
        {
          "offers": [
            {
              "prices": [
                {
                  "price": {
                    "grossAmount": 100,
                    "beforeTax": 91.57,
                    "afterTax": 101.71,
                    "taxes": {
                      "tax": 8.43,
                      "cityTax": 1.71
                    },
                    "currency": "USD"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Changes

No operation changes recorded.