Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Next »

GET https://ws.icnea.net/analytics/availability/

Use this endpoint to retrieve all reservations for a specific property manager or listing.


QUERY PARAMS

usr string required

API_key for your company, provided by Icnea.

client_id integer required

Property Manager ID

listing_id integer

start_date string

end_date string


RESPONSES

200

{  
  "analytics_reservations_response": {
    "reservations": [
      {
        "listing_id": 12341001,
        "unit_id": 1
        "booking_id": "102100",
        "status": "confirmed",
        "channel": "",
        "guest_country": "ES",
        "booking_date": "2024-12-12",
        "cancellation_date": "",
        "arrival_date": "2025-05-01",
        "departure_date": "2025-05-08",
        "nights": 7,
        "total_amount": 220.00,
        "currency": "EUR"
      },
      {
        "listing_id": 12341003,
        "unit_id": 1
        "booking_id": "100003",
        "status": "cancelled",
        "channel": "Airbnb",
        "guest_country": "DK",
        "booking_date": "2024-05-03",
        "cancellation_date": "2025-01-03",
        "arrival_date": "2025-01-05",
        "departure_date": "2025-01-07",
        "nights": 2,
        "total_amount": 120.34,
        "currency": "EUR"
      }
    ] 
  }
}

Field

Type

Description

listing_id

integer

unit_id

integer

booking_id

string

status

string

channel

string

guest_country

string

booking_date

date

cancellation_date

date

arrival_date

date

departure_date

date

nights

integer

total_amount

decimal

currency

string

400

{  
  "analytics_reservations_response": {
    "error_code": "",
    "error_message": ""
  }
}

Field

Type

Description

error_code

string

Icnea internal error_id to help with debugging.

error_message

string

Human readable description of error.

  • No labels