Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Get the list of reservations in a property, from one year back to one year after the date.For example, if today is 19/06/2020, you will get all the reservations from 19/06/2019 to 19/06/2021.

Endpoint: https://ws.icnea.net/pricing_get_reservations.aspx?usr=a1b2c3d4e5&id=12341001

Parameter

Type/format

Required?

Description

usr

string

mandatory

API_key for your company, provided by Icnea

id

integer

mandatory

lodging_id

date_from

date yyyy-MM-dd

optional

To filter by booking date.

date_to

date yyyy-MM-dd

optional

*mandatory if you are sending date_from

start_date

date yyyy-MM-dd

optional

To filter by check-in/out date.

end_date

date yyyy-MM-dd

optional

*mandatory if you are sending start_date

By default, you will get all the reservations from one year back to one year after the date.

For example, if today is 19/06/2020, you will get all the reservations from 19/06/2019 to 19/06/2021.

But you can filter this by booking date or by check-in date.

Filter by booking date:

If you send date_from and date_to, you will get all the reservations that have been made in that interval.

It is necessary to send both fields.

Filter by check-in date:

If you send start_date and end_date, you will get all the reservations with check-in and check-out between that interval of dates. It is necessary to send both fields.

You will get a response with this information:

Code Block
languagejson
{
  "pricing_get_reservations_response": {
    "bookings": [
    {
      "lodging_id": "12341001",
      "booking_id": "1234121984",
      "status": "confirmed",
      "country": "Spain",
      "channel": "Airbnb",
      "channel_booking_id": "HMXE34234",
      "booking_date": "2017-05-23",
      "cancel_date": "",
      "arrival_date": "2017-10-05",
      "departure_date": "2017-10-08",
      "amount": "300.00",
      "booking_fee": "0.00",
      "cleaning_fee": "0.00",
      "checkin_fee": "0.00",
      "currency": "EUR",
      "dates": [{
        "date": "2017-10-05",
        "price": "100.00"
      },{
        "date": "2017-10-06",
        "price": "100.00"
      },{
        "date": "2017-10-07",
        "price": "100.00"
      }
      ]
    },{
      "lodging_id": "12341001",
      "booking_id": "1234121984",
      "status": "cancelled",
      "country": "Spain",
      "channel": "Airbnb",
      "channel_booking_id": "",
      "booking_date": "2017-05-23",
      "cancel_date": "2017-10-01",
      "arrival_date": "2017-10-05",
      "departure_date": "2017-10-08",
      "amount": "394.85",      
      "currency": "EUR"
    }]
  }
}

“amount” is the total amount of the reservation, whichs adds the price per night (that you have separated in the “dates” array) + booking fee + cleaning fee + checkin fee.

...