Lodgify API

Getting started

The Lodgify API allows the user to perform certains operations through a REST requests, like create new bookings or obtain a list of the new ones The list of operations provided by the API will increase over time, but for now the only available API operations are related to the Reservation System

There are no request limits on the API calls, but any abuse detected will have a blocked access to the API

All the request and responses will only accept and return JSON format.

Authorization

To make authorizad calls on Lodgify API operations, you need to provide a API key in the call. There are two different types of API Keys, one with read and others with write permission. The read API keys only allow the user to call GET requests, any other request type (POST, PUT, etc..) will be blocked

To obtain your API Keys you can get in touch with us at help@lodgify.com and we will provide you a pair of read and write keys.

Once you have a valid API Key, you need to include it on the API request in a HTTP header named X-ApiKey

Localization

Some of the API responses can be returned on specific languages, for example the list of countries in German. If no language is defined then all responses will be in English

To configure a request to be returned with a specific language you need to add a Accept-Language http header with one of the language codes from the next table

Language	Code
English	en
German	de
Spanish	es
Italian	it

Errors

When a request to the API fails, it will return a 500 http response with a json object containing more information about the error. The error object contains a message and a code, which can be used to determine the main cause of the error. A list of all posible error codes can be found on the Annex

Example of returned error object

{
    "message": "Authorization has been denied for this request.",
    "code": 999,
    "correlation_id": "00000000-0000-0000-0000-000000000000",
    "event_id":"5c5c1e7351cb4c3089200fa8985bfa63"
}

AvailabilityApi

All the operations that affect the availability calendars can be found on this group. An Api key is required for authentication and authorization.

v1/availability GET

Lists availability information for a given period

Request Information

https://api.lodgify.com/v1/availability?periodStart={periodStart}&periodEnd={periodEnd}&propertyId={propertyId}&roomTypeId={roomTypeId}&CombineRoomTypes={CombineRoomTypes}&BookingsOnly={BookingsOnly}&IncludeBookingIds={IncludeBookingIds}&ModifiedSince={ModifiedSince}

URI Parameters

Name	Description	Type	Additional information
periodStart	Period start date	date	Required
periodEnd	Period end date	date	Required
propertyId	Property Identifier	integer	Required
roomTypeId	Room type Identified (optional). If not specified all room types will be listed.	integer	None.
CombineRoomTypes	Get room type results totalized by house	boolean	None.
BookingsOnly	Retrieve only booking information. Only valid for room type queries.	boolean	None.
IncludeBookingIds	Retrieve booking Ids. Only valid for room type queries.	boolean	None.
ModifiedSince	Retrieve within the given period, only the sub-periods that were modified since the specified date up to 6 months before today. Only valid for room type queries.	date	None.

Response Information

Resource Description

Collection of AvailabilityDto

Name	Description	Type	Additional information
PropertyId	The property Identifier the availability period references to	integer	None.
RoomTypeId	Room type Identifier	integer	None.
PeriodStart	Period starting date	date	None.
PeriodEnd	Period ending date (is included in period)	date	None.
Available	Number of units available	integer	None.
TotalUnits	Number of total units of this room type	integer	None.
IsAvailable	True if the period is not closed and there are units left unoccupied	boolean	None.
BookingIds	List of Booking Ids on the period	Collection of integer	None.
ClosedPeriodId	Closed Period Id for this period	integer	None.

Response Formats

application/json, text/json

[
  {
    "property_id": 1,
    "room_type_id": 2,
    "period_start": "2020-04-07",
    "period_end": "2020-04-07",
    "available": 5,
    "total_units": 6,
    "is_available": true,
    "booking_ids": [
      1,
      2
    ],
    "closed_period_id": 1
  },
  {
    "property_id": 1,
    "room_type_id": 2,
    "period_start": "2020-04-07",
    "period_end": "2020-04-07",
    "available": 5,
    "total_units": 6,
    "is_available": true,
    "booking_ids": [
      1,
      2
    ],
    "closed_period_id": 1
  }
]

v1/availability/{propertyId} GET

Lists availability information for a given period

Request Information

https://api.lodgify.com/v1/availability/{propertyId}?periodStart={periodStart}&periodEnd={periodEnd}&roomTypeId={roomTypeId}&CombineRoomTypes={CombineRoomTypes}&BookingsOnly={BookingsOnly}&IncludeBookingIds={IncludeBookingIds}&ModifiedSince={ModifiedSince}

URI Parameters

Name	Description	Type	Additional information
periodStart	Period start date	date	Required
periodEnd	Period end date	date	Required
propertyId	Property Identifier	integer	Required
roomTypeId	Room type Identified (optional). If not specified all room types will be listed.	integer	None.
CombineRoomTypes	Get room type results totalized by house	boolean	None.
BookingsOnly	Retrieve only booking information. Only valid for room type queries.	boolean	None.
IncludeBookingIds	Retrieve booking Ids. Only valid for room type queries.	boolean	None.
ModifiedSince	Retrieve within the given period, only the sub-periods that were modified since the specified date up to 6 months before today. Only valid for room type queries.	date	None.

Response Information

Resource Description

Collection of AvailabilityDto

Name	Description	Type	Additional information
PropertyId	The property Identifier the availability period references to	integer	None.
RoomTypeId	Room type Identifier	integer	None.
PeriodStart	Period starting date	date	None.
PeriodEnd	Period ending date (is included in period)	date	None.
Available	Number of units available	integer	None.
TotalUnits	Number of total units of this room type	integer	None.
IsAvailable	True if the period is not closed and there are units left unoccupied	boolean	None.
BookingIds	List of Booking Ids on the period	Collection of integer	None.
ClosedPeriodId	Closed Period Id for this period	integer	None.

Response Formats

application/json, text/json

[
  {
    "property_id": 1,
    "room_type_id": 2,
    "period_start": "2020-04-07",
    "period_end": "2020-04-07",
    "available": 5,
    "total_units": 6,
    "is_available": true,
    "booking_ids": [
      1,
      2
    ],
    "closed_period_id": 1
  },
  {
    "property_id": 1,
    "room_type_id": 2,
    "period_start": "2020-04-07",
    "period_end": "2020-04-07",
    "available": 5,
    "total_units": 6,
    "is_available": true,
    "booking_ids": [
      1,
      2
    ],
    "closed_period_id": 1
  }
]

v1/availability/{propertyId}/{roomTypeId} GET

Lists availability information for a given period

Request Information

https://api.lodgify.com/v1/availability/{propertyId}/{roomTypeId}?periodStart={periodStart}&periodEnd={periodEnd}&CombineRoomTypes={CombineRoomTypes}&BookingsOnly={BookingsOnly}&IncludeBookingIds={IncludeBookingIds}&ModifiedSince={ModifiedSince}

URI Parameters

Name	Description	Type	Additional information
periodStart	Period start date	date	Required
periodEnd	Period end date	date	Required
propertyId	Property Identifier	integer	Required
roomTypeId	Room type Identified (optional). If not specified all room types will be listed.	integer	None.
CombineRoomTypes	Get room type results totalized by house	boolean	None.
BookingsOnly	Retrieve only booking information. Only valid for room type queries.	boolean	None.
IncludeBookingIds	Retrieve booking Ids. Only valid for room type queries.	boolean	None.
ModifiedSince	Retrieve within the given period, only the sub-periods that were modified since the specified date up to 6 months before today. Only valid for room type queries.	date	None.

Response Information

Resource Description

Collection of AvailabilityDto

Name	Description	Type	Additional information
PropertyId	The property Identifier the availability period references to	integer	None.
RoomTypeId	Room type Identifier	integer	None.
PeriodStart	Period starting date	date	None.
PeriodEnd	Period ending date (is included in period)	date	None.
Available	Number of units available	integer	None.
TotalUnits	Number of total units of this room type	integer	None.
IsAvailable	True if the period is not closed and there are units left unoccupied	boolean	None.
BookingIds	List of Booking Ids on the period	Collection of integer	None.
ClosedPeriodId	Closed Period Id for this period	integer	None.

Response Formats

application/json, text/json

[
  {
    "property_id": 1,
    "room_type_id": 2,
    "period_start": "2020-04-07",
    "period_end": "2020-04-07",
    "available": 5,
    "total_units": 6,
    "is_available": true,
    "booking_ids": [
      1,
      2
    ],
    "closed_period_id": 1
  },
  {
    "property_id": 1,
    "room_type_id": 2,
    "period_start": "2020-04-07",
    "period_end": "2020-04-07",
    "available": 5,
    "total_units": 6,
    "is_available": true,
    "booking_ids": [
      1,
      2
    ],
    "closed_period_id": 1
  }
]

v1/availability/{propertyId}/{roomTypeId}/set POST

Sets the number of units available for a room type

Request Information

https://api.lodgify.com/v1/availability/{propertyId}/{roomTypeId}/set

URI Parameters

Name	Description	Type	Additional information
propertyId		integer	Required
roomTypeId		integer	Required

Body Parameters

AvailabilitySetDto

Name	Description	Type	Additional information
PeriodStart	The start date of the period	date	None.
PeriodEnd	The end date of the period	date	None.
Available	The number of available units	integer	None.

Request Formats

application/json, text/json

{
  "period_start": "2020-04-07",
  "period_end": "2020-04-07",
  "available": 3
}

Response Information

Resource Description

AvailabilityApi_v2

Availability related operations can be found in these endpoints

v2/availability GET

Availability calendar for a period

Request Information

https://api.lodgify.com/v2/availability?start={start}&end={end}&propertyId={propertyId}&roomTypeId={roomTypeId}&updatedSince={updatedSince}&includeDetails={includeDetails}

URI Parameters

Name	Description	Type	Additional information
start	Calendar start date	date	Required
end	Calendar end date	date	Required
propertyId	Property Id (optional). If not specified all properties of the user will be listed.	integer	None.
roomTypeId	Room type Id (optional). If not specified all room types of the property will be listed.	integer	None.
updatedSince	Return only the periods that were updated since the specified date.	date	None.
includeDetails	Include booking status	boolean	Default value is False

Response Information

Resource Description

Availability calendar

Collection of CalendarDto

Name	Type	Additional information
UserId	integer	None.
PropertyId	integer	None.
RoomTypeId	integer	None.
Periods	Collection of PeriodDto	None.

Response Formats

application/json, text/json

[
  {
    "user_id": 1,
    "property_id": 2,
    "room_type_id": 3,
    "periods": [
      {
        "start": "0001-01-01",
        "end": "0001-01-01",
        "available": 1,
        "closed_period": {
          "id": 1
        },
        "bookings": [
          {
            "id": 1,
            "status": "sample string 2"
          },
          {
            "id": 1,
            "status": "sample string 2"
          }
        ],
        "channel_calendars": [
          {
            "id": 1
          },
          {
            "id": 1
          }
        ]
      },
      {
        "start": "0001-01-01",
        "end": "0001-01-01",
        "available": 1,
        "closed_period": {
          "id": 1
        },
        "bookings": [
          {
            "id": 1,
            "status": "sample string 2"
          },
          {
            "id": 1,
            "status": "sample string 2"
          }
        ],
        "channel_calendars": [
          {
            "id": 1
          },
          {
            "id": 1
          }
        ]
      }
    ]
  },
  {
    "user_id": 1,
    "property_id": 2,
    "room_type_id": 3,
    "periods": [
      {
        "start": "0001-01-01",
        "end": "0001-01-01",
        "available": 1,
        "closed_period": {
          "id": 1
        },
        "bookings": [
          {
            "id": 1,
            "status": "sample string 2"
          },
          {
            "id": 1,
            "status": "sample string 2"
          }
        ],
        "channel_calendars": [
          {
            "id": 1
          },
          {
            "id": 1
          }
        ]
      },
      {
        "start": "0001-01-01",
        "end": "0001-01-01",
        "available": 1,
        "closed_period": {
          "id": 1
        },
        "bookings": [
          {
            "id": 1,
            "status": "sample string 2"
          },
          {
            "id": 1,
            "status": "sample string 2"
          }
        ],
        "channel_calendars": [
          {
            "id": 1
          },
          {
            "id": 1
          }
        ]
      }
    ]
  }
]

v2/availability/{propertyId} GET

Availability calendar for a period

Request Information

https://api.lodgify.com/v2/availability/{propertyId}?start={start}&end={end}&roomTypeId={roomTypeId}&updatedSince={updatedSince}&includeDetails={includeDetails}

URI Parameters

Name	Description	Type	Additional information
start	Calendar start date	date	Required
end	Calendar end date	date	Required
propertyId	Property Id (optional). If not specified all properties of the user will be listed.	integer	None.
roomTypeId	Room type Id (optional). If not specified all room types of the property will be listed.	integer	None.
updatedSince	Return only the periods that were updated since the specified date.	date	None.
includeDetails	Include booking status	boolean	Default value is False

Response Information

Resource Description

Availability calendar

Collection of CalendarDto

Name	Type	Additional information
UserId	integer	None.
PropertyId	integer	None.
RoomTypeId	integer	None.
Periods	Collection of PeriodDto	None.

Response Formats

application/json, text/json

[
  {
    "user_id": 1,
    "property_id": 2,
    "room_type_id": 3,
    "periods": [
      {
        "start": "0001-01-01",
        "end": "0001-01-01",
        "available": 1,
        "closed_period": {
          "id": 1
        },
        "bookings": [
          {
            "id": 1,
            "status": "sample string 2"
          },
          {
            "id": 1,
            "status": "sample string 2"
          }
        ],
        "channel_calendars": [
          {
            "id": 1
          },
          {
            "id": 1
          }
        ]
      },
      {
        "start": "0001-01-01",
        "end": "0001-01-01",
        "available": 1,
        "closed_period": {
          "id": 1
        },
        "bookings": [
          {
            "id": 1,
            "status": "sample string 2"
          },
          {
            "id": 1,
            "status": "sample string 2"
          }
        ],
        "channel_calendars": [
          {
            "id": 1
          },
          {
            "id": 1
          }
        ]
      }
    ]
  },
  {
    "user_id": 1,
    "property_id": 2,
    "room_type_id": 3,
    "periods": [
      {
        "start": "0001-01-01",
        "end": "0001-01-01",
        "available": 1,
        "closed_period": {
          "id": 1
        },
        "bookings": [
          {
            "id": 1,
            "status": "sample string 2"
          },
          {
            "id": 1,
            "status": "sample string 2"
          }
        ],
        "channel_calendars": [
          {
            "id": 1
          },
          {
            "id": 1
          }
        ]
      },
      {
        "start": "0001-01-01",
        "end": "0001-01-01",
        "available": 1,
        "closed_period": {
          "id": 1
        },
        "bookings": [
          {
            "id": 1,
            "status": "sample string 2"
          },
          {
            "id": 1,
            "status": "sample string 2"
          }
        ],
        "channel_calendars": [
          {
            "id": 1
          },
          {
            "id": 1
          }
        ]
      }
    ]
  }
]

v2/availability/{propertyId}/{roomTypeId} GET

Availability calendar for a period

Request Information

https://api.lodgify.com/v2/availability/{propertyId}/{roomTypeId}?start={start}&end={end}&updatedSince={updatedSince}&includeDetails={includeDetails}

URI Parameters

Name	Description	Type	Additional information
start	Calendar start date	date	Required
end	Calendar end date	date	Required
propertyId	Property Id (optional). If not specified all properties of the user will be listed.	integer	None.
roomTypeId	Room type Id (optional). If not specified all room types of the property will be listed.	integer	None.
updatedSince	Return only the periods that were updated since the specified date.	date	None.
includeDetails	Include booking status	boolean	Default value is False

Response Information

Resource Description

Availability calendar

Collection of CalendarDto

Name	Type	Additional information
UserId	integer	None.
PropertyId	integer	None.
RoomTypeId	integer	None.
Periods	Collection of PeriodDto	None.

Response Formats

application/json, text/json

[
  {
    "user_id": 1,
    "property_id": 2,
    "room_type_id": 3,
    "periods": [
      {
        "start": "0001-01-01",
        "end": "0001-01-01",
        "available": 1,
        "closed_period": {
          "id": 1
        },
        "bookings": [
          {
            "id": 1,
            "status": "sample string 2"
          },
          {
            "id": 1,
            "status": "sample string 2"
          }
        ],
        "channel_calendars": [
          {
            "id": 1
          },
          {
            "id": 1
          }
        ]
      },
      {
        "start": "0001-01-01",
        "end": "0001-01-01",
        "available": 1,
        "closed_period": {
          "id": 1
        },
        "bookings": [
          {
            "id": 1,
            "status": "sample string 2"
          },
          {
            "id": 1,
            "status": "sample string 2"
          }
        ],
        "channel_calendars": [
          {
            "id": 1
          },
          {
            "id": 1
          }
        ]
      }
    ]
  },
  {
    "user_id": 1,
    "property_id": 2,
    "room_type_id": 3,
    "periods": [
      {
        "start": "0001-01-01",
        "end": "0001-01-01",
        "available": 1,
        "closed_period": {
          "id": 1
        },
        "bookings": [
          {
            "id": 1,
            "status": "sample string 2"
          },
          {
            "id": 1,
            "status": "sample string 2"
          }
        ],
        "channel_calendars": [
          {
            "id": 1
          },
          {
            "id": 1
          }
        ]
      },
      {
        "start": "0001-01-01",
        "end": "0001-01-01",
        "available": 1,
        "closed_period": {
          "id": 1
        },
        "bookings": [
          {
            "id": 1,
            "status": "sample string 2"
          },
          {
            "id": 1,
            "status": "sample string 2"
          }
        ],
        "channel_calendars": [
          {
            "id": 1
          },
          {
            "id": 1
          }
        ]
      }
    ]
  }
]

BookingsApi

All the booking and enquiry related operations can be found on this group. All those operations need to provide a Api key to authenticate and authorize the user.

v1/reservation GET

Returns a paged list of all the bookings and enquiries on the inbox

Request Information

https://api.lodgify.com/v1/reservation?offset={offset}&limit={limit}&status={status}&trash={trash}&propertyId={propertyId}&periodStart={periodStart}&periodEnd={periodEnd}&modifiedSince={modifiedSince}

URI Parameters

Name	Description	Type	Additional information
offset	Pagination: number of elements you want to skip on th results.	integer	Default value is 0
limit	Pagination: number of elements per page. this value cannot be greater than 50	integer	Default value is 10
status	Filter the results to only return the Bookings/Enquiries mathing the status. Optional	string	None.
trash	Filter the results to only return the Bookings/Enquiries in the trash. Optional	boolean	Default value is False
propertyId	Filter the results to only return the Bookings/Enquiries from the specified property. Optional	integer	None.
periodStart	Filter the results to only return the Bookings/Enquiries within the period. Optional	date	None.
periodEnd	Filter the results to only return the Bookings/Enquiries within the period. Optional	date	None.
modifiedSince	Filter the results to only return the Bookings/Enquiries modified after the specified date. Optional	date	None.

Response Information

Resource Description

Paged list with the elements. It contains a List of Items, a total count of all the elements and a links to the next and previous resource pages

PagedResultOfBookingDto

Name	Type	Additional information
Items	Collection of BookingDto	None.
Total	integer	None.
Next	string	None.
Previous	string	None.

Response Formats

application/json, text/json

{
  "items": [
    {
      "id": 0,
      "type": null,
      "booking_type": null,
      "status": null,
      "source": null,
      "source_text": null,
      "guest": {
        "id": "f669b661-1204-4cc1-8454-5b027c53b079",
        "country_name": null,
        "name": "John Doe",
        "email": "johndoe@lodgify.com",
        "phone": "456789123",
        "country_code": null
      },
      "arrival": "2013-03-01",
      "departure": "2013-03-15",
      "people": null,
      "property_id": 18043,
      "property_name": null,
      "rooms": [
        {
          "name": null,
          "room_type_id": 22097,
          "people": 1
        }
      ],
      "created_at": "0001-01-01T00:00:00",
      "is_replied": false,
      "updated_at": "0001-01-01T00:00:00",
      "is_deleted": false,
      "date_deleted": null,
      "total_amount": null,
      "total_paid": 0.0,
      "amount_to_pay": null,
      "currency": null
    }
  ],
  "total": 2,
  "next": "",
  "previous": ""
}

v1/reservation/booking POST

Creates a new booking with the data passed as Json

Request Information

https://api.lodgify.com/v1/reservation/booking?from={from}

URI Parameters

Name	Description	Type	Additional information
from	Optionally you can create a Booking from a Enquiry. We call this upgrade a enquiry. You still need to send all the booking information, but doing this way, all the messages will be saved on the new booking	integer	None.

Body Parameters

Object with the data for the new Booking should be a CreateBookingDto

CreateBookingDto

Name	Description	Type	Additional information
Source	Source of the booking. if not provided Manual is used	BookingSource	None.
SourceText	Source Text for the booking	string	None.
Arrival	Arrival date with the format yyyy-MM-dd	date	None.
Departure	Departure date with the format yyyy-MM-dd	date	None.
PropertyId	Property Identifier	integer	None.
Status	Status of the booking. If not provided Open is used	BookingStatusDto	None.
Rooms	List of rooms booked	Collection of CreateBookingRoomTypeDto	None.
Guest	Guest information	CreateBookingGuestDto	None.
Messages	List of messages attached to the booking. Optional	Collection of CreateBookingMessageDto	None.
PaymentType	(Obsolete. Use payment_website_id instead.) Payment type asociated with the booking. Optional, default value is None	string	None.
PaymentAddress	(Obsolete. Use payment_website_id instead.) Payment Address. Only if the Payment Type used supports it (eg. Paypal)	string	None.
PaymentWebsiteId	Id of the website chosen as the payment gateway for this booking.	integer	None.
IpCreated	Optional. Ip from where the booking is created. If not provided will be used the Ip from where the API is called	string	None.
Total	Total Amount for the booking, leave null to allow lodgify do his own Quote calculations. If something is passed then no calculations will be made. If a total value is defined, then a CurrencyCode should be defined.	decimal number	None.
CurrencyCode	CurrencyCode for the Total amount. If no currency code is defined then we will default the currency to the currency defined for the property rates in Lodgify rates	string	None.

Request Formats

application/json, text/json

{
  "source": 0,
  "source_text": "sample string 1",
  "arrival": "2020-04-07T16:11:56.0311782+02:00",
  "departure": "2020-04-07T16:11:56.0321475+02:00",
  "property_id": 4,
  "status": 0,
  "rooms": [
    {
      "room_type_id": 1,
      "people": 2
    },
    {
      "room_type_id": 1,
      "people": 2
    }
  ],
  "guest": {
    "name": "sample string 1",
    "email": "sample string 2",
    "phone": "sample string 3",
    "country_code": "sample string 4"
  },
  "messages": [
    {
      "subject": "sample string 1",
      "message": "sample string 2",
      "type": 0
    },
    {
      "subject": "sample string 1",
      "message": "sample string 2",
      "type": 0
    }
  ],
  "payment_type": "sample string 5",
  "payment_address": "sample string 6",
  "payment_website_id": 1,
  "ip_created": "sample string 7",
  "total": 1.0,
  "currency_code": "sample string 8"
}

Response Information

Resource Description

Returns a Identifier for the newly created Booking. Also in the Location Header the url for the new object can be found

v1/reservation/booking/{id} GET

Returns the detail for a Booking

Request Information

https://api.lodgify.com/v1/reservation/booking/{id}

URI Parameters

Name	Description	Type	Additional information
id	Identifier of the object you want	integer	Required

Response Information

Resource Description

An object with all the data

BookingDetailsDto

Name	Description	Type	Additional information
Note	Admin note about the booking	string	None.
Messages	List of Messages from the owner, renter and system	Collection of BookingThreadMessageDto	None.
PaymentType	(Obsolete. Use payment_website_id instead.) Payment type for this Booking	string	None.
PaymentAddress	(Obsolete. Use payment_website_id instead.) Payment Address for this Booking	string	None.
PaymentWebsiteId	Id of the website chosen as the payment gateway for this booking.	integer	None.
Id	Booking or Enquiry Identifier	integer	None.
Type	Defines if is a Booking or a Enquiry	string	None.
BookingType	Determines if this is a Booking or a Enquiry	string	None.
Status	Status of the Booking or Enquiry	string	None.
Source	Source of the booking or enquiry	string	None.
SourceText	Source text of the booking or enquiry	string	None.
Guest	Guest for this Booking/Enquiry	GuestDto	None.
Arrival	Booking/Enquiry Arrival Date. In yyyy-MM-dd format	Date	None.
Departure	Booking/Enquiry Departure Date. In yyyy-MM-dd format	Date	None.
People	The number of people (if any) the booking or enquiry references	integer	None.
PropertyId	The property Identifier (if any) the booking or enquiry references	integer	None.
PropertyName	The property Name (if any) the booking or enquiry references	string	None.
Rooms	The list of rooms (if any) the booking or enquiry references	Collection of BookingRoomTypeDto	None.
CreatedAt	Booking / Enquiry creation Datetime	date	None.
IsReplied	bool value indicating if the booking/enquiry has been replied to the renter	boolean	None.
UpdatedAt	Last update datetime	date	None.
IsDeleted	Boolean indicating if the booking/enquiry is deleted and stored in the trash	boolean	None.
DateDeleted	If is a deleted booking/enquiry then the datetime of deletion, null otherwise	date	None.
TotalAmount	Total amount of the booking/enquiry	decimal number	None.
TotalPaid	Total amount paid for the booking/enquiry	decimal number	None.
AmountToPay	Amount to pay for the booking/enquiry	decimal number	None.
Currency	Currency used for the amounts	Reservations.CurrencyDto	None.

Response Formats

application/json, text/json

{
  "id": 4,
  "type": "sample string 5",
  "booking_type": "sample string 6",
  "status": "sample string 7",
  "source": "sample string 8",
  "source_text": "sample string 9",
  "guest": {
    "id": "sample string 1",
    "country_name": "sample string 2",
    "name": "sample string 3",
    "email": "sample string 4",
    "phone": "sample string 5",
    "country_code": "sample string 6"
  },
  "arrival": "0001-01-01",
  "departure": "0001-01-01",
  "people": 1,
  "property_id": 1,
  "property_name": "sample string 10",
  "rooms": [
    {
      "name": "sample string 1",
      "room_type_id": 2,
      "people": 3
    },
    {
      "name": "sample string 1",
      "room_type_id": 2,
      "people": 3
    }
  ],
  "created_at": "2020-04-07T16:11:56.0625005+02:00",
  "is_replied": true,
  "updated_at": "2020-04-07T16:11:56.0625005+02:00",
  "is_deleted": true,
  "date_deleted": "2020-04-07T16:11:56.0625005+02:00",
  "total_amount": 1.0,
  "total_paid": 15.0,
  "amount_to_pay": 1.0,
  "currency": {
    "id": 1,
    "code": "sample string 2",
    "name": "sample string 3",
    "euro_forex": 4.0,
    "symbol": "sample string 5"
  },
  "note": "sample string 1",
  "messages": [
    {
      "is_replied": true,
      "created_at": "2020-04-07T16:11:56.0614258+02:00",
      "subject": "sample string 3",
      "message": "sample string 4",
      "type": 0
    },
    {
      "is_replied": true,
      "created_at": "2020-04-07T16:11:56.0614258+02:00",
      "subject": "sample string 3",
      "message": "sample string 4",
      "type": 0
    }
  ],
  "payment_type": "sample string 2",
  "payment_address": "sample string 3",
  "payment_website_id": 1
}

v1/reservation/booking/{id} PUT

Updates a given Booking with the object passed

Request Information

https://api.lodgify.com/v1/reservation/booking/{id}

URI Parameters

Name	Description	Type	Additional information
id	Booking identifier	integer	Required

Body Parameters

Object from wich we will update the booking. Note that not all the values will be updated

BookingDetailsDto

Name	Description	Type	Additional information
Note	Admin note about the booking	string	None.
Messages	List of Messages from the owner, renter and system	Collection of BookingThreadMessageDto	None.
PaymentType	(Obsolete. Use payment_website_id instead.) Payment type for this Booking	string	None.
PaymentAddress	(Obsolete. Use payment_website_id instead.) Payment Address for this Booking	string	None.
PaymentWebsiteId	Id of the website chosen as the payment gateway for this booking.	integer	None.
Id	Booking or Enquiry Identifier	integer	None.
Type	Defines if is a Booking or a Enquiry	string	None.
BookingType	Determines if this is a Booking or a Enquiry	string	None.
Status	Status of the Booking or Enquiry	string	None.
Source	Source of the booking or enquiry	string	None.
SourceText	Source text of the booking or enquiry	string	None.
Guest	Guest for this Booking/Enquiry	GuestDto	None.
Arrival	Booking/Enquiry Arrival Date. In yyyy-MM-dd format	Date	None.
Departure	Booking/Enquiry Departure Date. In yyyy-MM-dd format	Date	None.
People	The number of people (if any) the booking or enquiry references	integer	None.
PropertyId	The property Identifier (if any) the booking or enquiry references	integer	None.
PropertyName	The property Name (if any) the booking or enquiry references	string	None.
Rooms	The list of rooms (if any) the booking or enquiry references	Collection of BookingRoomTypeDto	None.
CreatedAt	Booking / Enquiry creation Datetime	date	None.
IsReplied	bool value indicating if the booking/enquiry has been replied to the renter	boolean	None.
UpdatedAt	Last update datetime	date	None.
IsDeleted	Boolean indicating if the booking/enquiry is deleted and stored in the trash	boolean	None.
DateDeleted	If is a deleted booking/enquiry then the datetime of deletion, null otherwise	date	None.
TotalAmount	Total amount of the booking/enquiry	decimal number	None.
TotalPaid	Total amount paid for the booking/enquiry	decimal number	None.
AmountToPay	Amount to pay for the booking/enquiry	decimal number	None.
Currency	Currency used for the amounts	Reservations.CurrencyDto	None.

Request Formats

application/json, text/json

{
  "id": 4,
  "type": "sample string 5",
  "booking_type": "sample string 6",
  "status": "sample string 7",
  "source": "sample string 8",
  "source_text": "sample string 9",
  "guest": {
    "id": "sample string 1",
    "country_name": "sample string 2",
    "name": "sample string 3",
    "email": "sample string 4",
    "phone": "sample string 5",
    "country_code": "sample string 6"
  },
  "arrival": "0001-01-01",
  "departure": "0001-01-01",
  "people": 1,
  "property_id": 1,
  "property_name": "sample string 10",
  "rooms": [
    {
      "name": "sample string 1",
      "room_type_id": 2,
      "people": 3
    },
    {
      "name": "sample string 1",
      "room_type_id": 2,
      "people": 3
    }
  ],
  "created_at": "2020-04-07T16:11:56.0887724+02:00",
  "is_replied": true,
  "updated_at": "2020-04-07T16:11:56.0887724+02:00",
  "is_deleted": true,
  "date_deleted": "2020-04-07T16:11:56.0887724+02:00",
  "total_amount": 1.0,
  "total_paid": 15.0,
  "amount_to_pay": 1.0,
  "currency": {
    "id": 1,
    "code": "sample string 2",
    "name": "sample string 3",
    "euro_forex": 4.0,
    "symbol": "sample string 5"
  },
  "note": "sample string 1",
  "messages": [
    {
      "is_replied": true,
      "created_at": "2020-04-07T16:11:56.0877919+02:00",
      "subject": "sample string 3",
      "message": "sample string 4",
      "type": 0
    },
    {
      "is_replied": true,
      "created_at": "2020-04-07T16:11:56.0877919+02:00",
      "subject": "sample string 3",
      "message": "sample string 4",
      "type": 0
    }
  ],
  "payment_type": "sample string 2",
  "payment_address": "sample string 3",
  "payment_website_id": 1
}

Response Information

Resource Description

A OK 200 if the update has been succesful

v1/reservation/booking/{id} DELETE

Remove a Booking or Enquiry, sending them to the trash, and making them recoverable

Request Information

https://api.lodgify.com/v1/reservation/booking/{id}

URI Parameters

Name	Description	Type	Additional information
id	Identifier of the bookoing or enquiry	integer	Required

Response Information

Resource Description

A OK 200 if the deletion has been succesful

v1/reservation/booking/{id}/book PUT

Changes the status of a booking to Booked and updating the availability calendar

Request Information

https://api.lodgify.com/v1/reservation/booking/{id}/book?requestPayment={requestPayment}

URI Parameters

Name	Description	Type	Additional information
id	Booking identifier	integer	Required
requestPayment		boolean	Default value is False

Response Information

Resource Description

A 200 OK result

v1/reservation/booking/{id}/decline PUT

Declines a Booking changing the status to Declined

Request Information

https://api.lodgify.com/v1/reservation/booking/{id}/decline

URI Parameters

Name	Description	Type	Additional information
id	Booking identifier	integer	Required

Response Information

Resource Description

A 200 OK result

v1/reservation/booking/{id}/messages POST

Adds one or more messages for a Booking

Request Information

https://api.lodgify.com/v1/reservation/booking/{id}/messages

URI Parameters

Name	Description	Type	Additional information
id	Identifier of the booking	integer	Required

Body Parameters

List of messages to be added

Collection of CreateBookingMessageDto

Name	Description	Type	Additional information
Subject	Subject of the Booking/enquiry message	string	None.
Message	Content of the message	string	None.
Type	Type of the message. Only valid values are Owner, Renter, Comment. The other are only for internal use	BookingThreadMessageType	None.

Request Formats

application/json, text/json

[
  {
    "subject": "Subject",
    "message": "Message",
    "type": 1
  }
]

Response Information

Resource Description

A OK 200 if the marking has been succesful

v1/reservation/booking/{id}/not_replied PUT

Marks a Booking as not replied

Request Information

https://api.lodgify.com/v1/reservation/booking/{id}/not_replied

URI Parameters

Name	Description	Type	Additional information
id	Identifier of the bookong	integer	Required

Response Information

Resource Description

A OK 200 if the marking has been succesful

v1/reservation/booking/{id}/quote GET

Returns the details of the Booking's current Quote

Request Information

https://api.lodgify.com/v1/reservation/booking/{id}/quote

URI Parameters

Name	Description	Type	Additional information
id	Identifier of the booking the quote belongs to	integer	Required

Response Information

Resource Description

An object with all the data

BookingQuoteDto

Name	Description	Type	Additional information
Id	Quote identifier	integer	None.
Arrival	Arrival date of the Booking	Date	None.
Departure	Departure date of the Booking	Date	None.
PropertyId	Property Id of the Booking	integer	None.
Status	Quote status	string	None.
Currency	Currency used	Reservations.CurrencyDto	None.
AmountGross	Quote Gross amount	Money	None.
AmountNet	Quote Net amount	Money	None.
DateCancelled	Quote cancellation date	date	None.
AmountCancelled	Cancellation amount	Money	None.
DateAgreed	Date of agreement	date	None.
IsPolicyActive	Policy activation status	boolean	None.
RatePolicyName	Quote policy	string	None.
ExpirationHours	Hours until the quote expires	integer	None.
ExpirationDate	Quote expiration date	date	None.
RentalAgreement	Rental agreement identifier	string	None.
RentalAgreementAccepted	Rental agreement was accepted	boolean	None.
RoomTypeItems	Room types belonging to the Quote	Collection of BookingQuoteRoomTypeItemDto	None.
AddOnItems	Add-ons belonging to the Quote	Collection of BookingQuotePriceItemDto	None.
OtherItems	Other items belonging to the Quote	Collection of BookingQuotePriceItemDto	None.

Response Formats

application/json, text/json

{
  "id": 1,
  "arrival": "0001-01-01",
  "departure": "0001-01-01",
  "property_id": 2,
  "status": "sample string 3",
  "currency": {
    "id": 1,
    "code": "sample string 2",
    "name": "sample string 3",
    "euro_forex": 4.0,
    "symbol": "sample string 5"
  },
  "amount_gross": 0.0,
  "amount_net": 0.0,
  "date_cancelled": "2020-04-07T16:11:56.1073371+02:00",
  "amount_cancelled": 0.0,
  "date_agreed": "2020-04-07T16:11:56.1073371+02:00",
  "is_policy_active": true,
  "rate_policy_name": "sample string 5",
  "expiration_hours": 1,
  "expiration_date": "2020-04-07T16:11:56.1073371+02:00",
  "rental_agreement": "sample string 6",
  "rental_agreement_accepted": true,
  "room_type_items": [
    {
      "room_type_id": 1,
      "subtotal": 0.0,
      "prices": [
        {
          "type": "sample string 1",
          "amount": 0.0,
          "description": "sample string 2"
        },
        {
          "type": "sample string 1",
          "amount": 0.0,
          "description": "sample string 2"
        }
      ]
    },
    {
      "room_type_id": 1,
      "subtotal": 0.0,
      "prices": [
        {
          "type": "sample string 1",
          "amount": 0.0,
          "description": "sample string 2"
        },
        {
          "type": "sample string 1",
          "amount": 0.0,
          "description": "sample string 2"
        }
      ]
    }
  ],
  "add_on_items": [
    {
      "type": "sample string 1",
      "amount": 0.0,
      "description": "sample string 2"
    },
    {
      "type": "sample string 1",
      "amount": 0.0,
      "description": "sample string 2"
    }
  ],
  "other_items": [
    {
      "type": "sample string 1",
      "amount": 0.0,
      "description": "sample string 2"
    },
    {
      "type": "sample string 1",
      "amount": 0.0,
      "description": "sample string 2"
    }
  ]
}

v1/reservation/booking/{id}/quote POST

Creates a Quote for the booking

Request Information

https://api.lodgify.com/v1/reservation/booking/{id}/quote

URI Parameters

Name	Description	Type	Additional information
id	Identifier of the booking the quote belongs to	integer	Required

Body Parameters

CreateQuoteDto

Name	Description	Type	Additional information
AddOns	List of addons booked	Collection of QuoteAddOnDto	None.

Request Formats

application/json, text/json

{
  "add_ons": [
    {
      "add_on_id": 1,
      "units": 1
    },
    {
      "add_on_id": 1,
      "units": 1
    }
  ]
}

Response Information

Resource Description

The quote identifier

v1/reservation/booking/{id}/quote/paymentLink GET

Returns the link to the payment page for the current quote

Request Information

https://api.lodgify.com/v1/reservation/booking/{id}/quote/paymentLink

URI Parameters

Name	Description	Type	Additional information
id	Identifier of the booking to be paid	integer	Required

Response Information

Resource Description

An object with all the data

PaymentLinkDto

Name	Description	Type	Additional information
Url	Url address to the payment page	string	None.

Response Formats

application/json, text/json

{
  "url": "sample string 1"
}

v1/reservation/booking/{id}/quote/paymentLink POST

Create a payment link for the booking

Request Information

https://api.lodgify.com/v1/reservation/booking/{id}/quote/paymentLink

URI Parameters

Name	Description	Type	Additional information
id	Id of the booking	integer	Required

Body Parameters

Amount to be requested

CreatePaymentLinkDto

Name	Description	Type	Additional information
Amount	Amount to request	decimal number	Range: inclusive between 0.01 and 1.79769313486232E+308

Request Formats

application/json, text/json

{
  "amount": 1.0
}

Response Information

Resource Description

Returns false when the requested amount will not be enforced because the booking has a pending schedule to be paid first.

CreatedNegotiatedContentResultOfBoolean

Name	Type	Additional information
Location	URI	None.
Content	boolean	None.
ContentNegotiator	IContentNegotiator	None.
Request	HttpRequestMessage	None.
Formatters	Collection of MediaTypeFormatter	None.

Response Formats

application/json, text/json

Sample not available.

v1/reservation/booking/{id}/recover PUT

Recovers a Booking from the trash

Request Information

https://api.lodgify.com/v1/reservation/booking/{id}/recover

URI Parameters

Name	Description	Type	Additional information
id	Identifier of the booking	integer	Required

Response Information

Resource Description

A OK 200 if the recovering has been succesful

v1/reservation/booking/{id}/reopen PUT

Reopens a Booking changing the status to Open and making the room available again if the booking was on Booked

Request Information

https://api.lodgify.com/v1/reservation/booking/{id}/reopen

URI Parameters

Name	Description	Type	Additional information
id	Booking identifier	integer	Required

Response Information

Resource Description

A 200 OK result

v1/reservation/booking/{id}/replied PUT

Marks a Booking as replied

Request Information

https://api.lodgify.com/v1/reservation/booking/{id}/replied

URI Parameters

Name	Description	Type	Additional information
id	Identifier of the booking	integer	Required

Response Information

Resource Description

A OK 200 if the marking has been succesful

v1/reservation/booking/{id}/request_payment PUT

Request a payment for the given booking. It will send an email to the renter asking to pay the AmountToPay

Request Information

https://api.lodgify.com/v1/reservation/booking/{id}/request_payment

URI Parameters

Name	Description	Type	Additional information
id	Booking Identifier	integer	Required

Response Information

Resource Description

A 200 OK result

v1/reservation/booking/{id}/tentative PUT

Changes the status of a booking to Tentative

Request Information

https://api.lodgify.com/v1/reservation/booking/{id}/tentative?requestPayment={requestPayment}

URI Parameters

Name	Description	Type	Additional information
id	Booking identifier	integer	Required
requestPayment		boolean	Default value is False

Response Information

Resource Description

A 200 OK result

v1/reservation/callmeback POST

Creates a new CallMeBack Request. A call me back creates and enquiry and also sends an email to the property / account owner with an appointment to call the client back at some concrete date/hour

Request Information

https://api.lodgify.com/v1/reservation/callmeback

Body Parameters

Object with the data for the new Booking Enquiry

CreateCallMeDto

Name	Description	Type	Additional information
Date	Date for the Appointment of the callme back. In yyyy-MM-dd format	date	None.
TimeZoneInfoId	TimeZoneInfo Identifier	string	None.
Time	0-23 integer indicating the hour of the appointment	integer	None.
Notes	Additional notes for the Call me back request	string	None.
Language		string	None.
Source	Source of the enquiry. Default value is Domegos	BookingEnquirySource	None.
SourceText	Source Text of the enquiry	string	None.
SourceAddress	If the Enquiry is created from email, here will be the sender email Address	string	None.
Arrival	Arrival Datetime. Optional. If provided must be in yyyy-MM-dd format	date	None.
Departure	Departure Datetime. Optional. If provided must be in yyyy-MM-dd format	date	None.
People	Number of people of the Enquiry. Optional	integer	None.
PropertyId	Property identifier. Optional	integer	None.
RoomTypeId	RoomType identifier. Optional	integer	None.
Guest	Guest information	CreateBookingGuestDto	None.
Messages	List of the messages attached to the enquiry	Collection of CreateBookingMessageDto	None.
Status	Status of the Enquiry	string	None.
HasPrivacyConsent	Has privacy consent?	boolean	None.
IpCreated	Optional. Ip from where the booking is created. If not provided will be used the Ip from where the API is called	string	None.

Request Formats

application/json, text/json

{
  "date": "2020-04-07T16:11:56.1629989+02:00",
  "time_zone_info_id": "sample string 2",
  "time": 3,
  "notes": "sample string 4",
  "language": "sample string 5",
  "source": 0,
  "source_text": "sample string 6",
  "source_address": "sample string 7",
  "arrival": "2020-04-07T16:11:56.1639732+02:00",
  "departure": "2020-04-07T16:11:56.1639732+02:00",
  "people": 1,
  "property_id": 1,
  "room_type_id": 1,
  "guest": {
    "name": "sample string 1",
    "email": "sample string 2",
    "phone": "sample string 3",
    "country_code": "sample string 4"
  },
  "messages": [
    {
      "subject": "sample string 1",
      "message": "sample string 2",
      "type": 0
    },
    {
      "subject": "sample string 1",
      "message": "sample string 2",
      "type": 0
    }
  ],
  "status": "sample string 8",
  "has_privacy_consent": true,
  "ip_created": "sample string 9"
}

Response Information

Resource Description

Returns a Identifier for the newly created Enquiry. Also in the Location Header the url for the new object can be found

v1/reservation/delete POST

Performs a batch deletion, removing and sending to trash a collection of bookings and enquiries

Request Information

https://api.lodgify.com/v1/reservation/delete

Body Parameters

Collection of identifiers and types that will allow to identify a Booking or Enquiry

Collection of BatchBookingDto

Name	Description	Type	Additional information
Id	Booking or Enquiry identifier	integer	None.
Type	Type of the object (Booking or Enquiry)	string	None.

Request Formats

application/json, text/json

[
  {
    "id": 1,
    "type": "Booking"
  },
  {
    "id": 2,
    "type": "Enquiry"
  }
]

Response Information

Resource Description

A 200 OK result

v1/reservation/enquiry POST

Creates a new enquiry with the data passed as Json

Request Information

https://api.lodgify.com/v1/reservation/enquiry

Body Parameters

Object with the data for the new Booking Enquiry

CreateEnquiryDto

Name	Description	Type	Additional information
Source	Source of the enquiry. Default value is Domegos	BookingEnquirySource	None.
SourceText	Source Text of the enquiry	string	None.
SourceAddress	If the Enquiry is created from email, here will be the sender email Address	string	None.
Arrival	Arrival Datetime. Optional. If provided must be in yyyy-MM-dd format	date	None.
Departure	Departure Datetime. Optional. If provided must be in yyyy-MM-dd format	date	None.
People	Number of people of the Enquiry. Optional	integer	None.
PropertyId	Property identifier. Optional	integer	None.
RoomTypeId	RoomType identifier. Optional	integer	None.
Guest	Guest information	CreateBookingGuestDto	None.
Messages	List of the messages attached to the enquiry	Collection of CreateBookingMessageDto	None.
Status	Status of the Enquiry	string	None.
HasPrivacyConsent	Has privacy consent?	boolean	None.
IpCreated	Optional. Ip from where the booking is created. If not provided will be used the Ip from where the API is called	string	None.

Request Formats

application/json, text/json

{
  "source": 0,
  "source_text": "sample string 1",
  "source_address": "sample string 2",
  "arrival": "2020-04-07T16:11:56.1942669+02:00",
  "departure": "2020-04-07T16:11:56.1942669+02:00",
  "people": 1,
  "property_id": 1,
  "room_type_id": 1,
  "guest": {
    "name": "sample string 1",
    "email": "sample string 2",
    "phone": "sample string 3",
    "country_code": "sample string 4"
  },
  "messages": [
    {
      "subject": "sample string 1",
      "message": "sample string 2",
      "type": 0
    },
    {
      "subject": "sample string 1",
      "message": "sample string 2",
      "type": 0
    }
  ],
  "status": "sample string 3",
  "has_privacy_consent": true,
  "ip_created": "sample string 4"
}

Response Information

Resource Description

Returns a Identifier for the newly created Enquiry. Also in the Location Header the url for the new object can be found

v1/reservation/enquiry/{id} GET

Returns the detail for a enquiry

Request Information

https://api.lodgify.com/v1/reservation/enquiry/{id}

URI Parameters

Name	Description	Type	Additional information
id	Identifier of the object you want	integer	Required

Response Information

Resource Description

An object with all the data

BookingDetailsDto

Name	Description	Type	Additional information
Note	Admin note about the booking	string	None.
Messages	List of Messages from the owner, renter and system	Collection of BookingThreadMessageDto	None.
PaymentType	(Obsolete. Use payment_website_id instead.) Payment type for this Booking	string	None.
PaymentAddress	(Obsolete. Use payment_website_id instead.) Payment Address for this Booking	string	None.
PaymentWebsiteId	Id of the website chosen as the payment gateway for this booking.	integer	None.
Id	Booking or Enquiry Identifier	integer	None.
Type	Defines if is a Booking or a Enquiry	string	None.
BookingType	Determines if this is a Booking or a Enquiry	string	None.
Status	Status of the Booking or Enquiry	string	None.
Source	Source of the booking or enquiry	string	None.
SourceText	Source text of the booking or enquiry	string	None.
Guest	Guest for this Booking/Enquiry	GuestDto	None.
Arrival	Booking/Enquiry Arrival Date. In yyyy-MM-dd format	Date	None.
Departure	Booking/Enquiry Departure Date. In yyyy-MM-dd format	Date	None.
People	The number of people (if any) the booking or enquiry references	integer	None.
PropertyId	The property Identifier (if any) the booking or enquiry references	integer	None.
PropertyName	The property Name (if any) the booking or enquiry references	string	None.
Rooms	The list of rooms (if any) the booking or enquiry references	Collection of BookingRoomTypeDto	None.
CreatedAt	Booking / Enquiry creation Datetime	date	None.
IsReplied	bool value indicating if the booking/enquiry has been replied to the renter	boolean	None.
UpdatedAt	Last update datetime	date	None.
IsDeleted	Boolean indicating if the booking/enquiry is deleted and stored in the trash	boolean	None.
DateDeleted	If is a deleted booking/enquiry then the datetime of deletion, null otherwise	date	None.
TotalAmount	Total amount of the booking/enquiry	decimal number	None.
TotalPaid	Total amount paid for the booking/enquiry	decimal number	None.
AmountToPay	Amount to pay for the booking/enquiry	decimal number	None.
Currency	Currency used for the amounts	Reservations.CurrencyDto	None.

Response Formats

application/json, text/json

{
  "id": 4,
  "type": "sample string 5",
  "booking_type": "sample string 6",
  "status": "sample string 7",
  "source": "sample string 8",
  "source_text": "sample string 9",
  "guest": {
    "id": "sample string 1",
    "country_name": "sample string 2",
    "name": "sample string 3",
    "email": "sample string 4",
    "phone": "sample string 5",
    "country_code": "sample string 6"
  },
  "arrival": "0001-01-01",
  "departure": "0001-01-01",
  "people": 1,
  "property_id": 1,
  "property_name": "sample string 10",
  "rooms": [
    {
      "name": "sample string 1",
      "room_type_id": 2,
      "people": 3
    },
    {
      "name": "sample string 1",
      "room_type_id": 2,
      "people": 3
    }
  ],
  "created_at": "2020-04-07T16:11:56.2050015+02:00",
  "is_replied": true,
  "updated_at": "2020-04-07T16:11:56.2050015+02:00",
  "is_deleted": true,
  "date_deleted": "2020-04-07T16:11:56.2050015+02:00",
  "total_amount": 1.0,
  "total_paid": 15.0,
  "amount_to_pay": 1.0,
  "currency": {
    "id": 1,
    "code": "sample string 2",
    "name": "sample string 3",
    "euro_forex": 4.0,
    "symbol": "sample string 5"
  },
  "note": "sample string 1",
  "messages": [
    {
      "is_replied": true,
      "created_at": "2020-04-07T16:11:56.2040277+02:00",
      "subject": "sample string 3",
      "message": "sample string 4",
      "type": 0
    },
    {
      "is_replied": true,
      "created_at": "2020-04-07T16:11:56.2040277+02:00",
      "subject": "sample string 3",
      "message": "sample string 4",
      "type": 0
    }
  ],
  "payment_type": "sample string 2",
  "payment_address": "sample string 3",
  "payment_website_id": 1
}

v1/reservation/enquiry/{id} DELETE

Remove a Enquiry, sending them to the trash, and making them recoverable

Request Information

https://api.lodgify.com/v1/reservation/enquiry/{id}

URI Parameters

Name	Description	Type	Additional information
id	Identifier of the enquiry	integer	Required

Response Information

Resource Description

A OK 200 if the deletion has been succesful

v1/reservation/enquiry/{id}/decline PUT

Declines a enquiry

Request Information

https://api.lodgify.com/v1/reservation/enquiry/{id}/decline

URI Parameters

Name	Description	Type	Additional information
id	Enquiry identifier	integer	Required

Response Information

Resource Description

A 200 OK result

v1/reservation/enquiry/{id}/messages POST

Adds one or more messages for a enquiry

Request Information

https://api.lodgify.com/v1/reservation/enquiry/{id}/messages

URI Parameters

Name	Description	Type	Additional information
id	Identifier of the enquiry	integer	Required

Body Parameters

List of messages to be added

Collection of CreateBookingMessageDto

Name	Description	Type	Additional information
Subject	Subject of the Booking/enquiry message	string	None.
Message	Content of the message	string	None.
Type	Type of the message. Only valid values are Owner, Renter, Comment. The other are only for internal use	BookingThreadMessageType	None.

Request Formats

application/json, text/json

[
  {
    "subject": "Subject",
    "message": "Message",
    "type": 1
  }
]

Response Information

Resource Description

A OK 200 if the marking has been succesful

v1/reservation/enquiry/{id}/not_replied PUT

Marks a Enquiry as not replied

Request Information

https://api.lodgify.com/v1/reservation/enquiry/{id}/not_replied

URI Parameters

Name	Description	Type	Additional information
id	Identifier of the enquiry	integer	Required

Response Information

Resource Description

A OK 200 if the marking has been succesful

v1/reservation/enquiry/{id}/recover PUT

Recovers a Enquiry from the trash

Request Information

https://api.lodgify.com/v1/reservation/enquiry/{id}/recover

URI Parameters

Name	Description	Type	Additional information
id	Identifier of the enquiry	integer	Required

Response Information

Resource Description

A OK 200 if the recovering has been succesful

v1/reservation/enquiry/{id}/reopen PUT

Reopens a enquiry

Request Information

https://api.lodgify.com/v1/reservation/enquiry/{id}/reopen

URI Parameters

Name	Description	Type	Additional information
id	Enquiry identifier	integer	Required

Response Information

Resource Description

A 200 OK result

v1/reservation/enquiry/{id}/replied PUT

Marks a Enquiry as replied

Request Information

https://api.lodgify.com/v1/reservation/enquiry/{id}/replied

URI Parameters

Name	Description	Type	Additional information
id	Identifier of the enquiry	integer	Required

Response Information

Resource Description

A OK 200 if the marking has been succesful

v1/reservation/not_read GET

Gets the number of non readed Booking/Enquiry messages

Request Information

https://api.lodgify.com/v1/reservation/not_read

Response Information

Resource Description

Integer

integer

Response Formats

application/json, text/json

v1/reservation/not_replied POST

Performs a batch mark as not replied, marking as not replied a collection of bookings and enquiries

Request Information

https://api.lodgify.com/v1/reservation/not_replied

Body Parameters

Collection of identifiers and types that will allow to identify a Booking or Enquiry

Collection of BatchBookingDto

Name	Description	Type	Additional information
Id	Booking or Enquiry identifier	integer	None.
Type	Type of the object (Booking or Enquiry)	string	None.

Request Formats

application/json, text/json

[
  {
    "id": 1,
    "type": "Booking"
  },
  {
    "id": 2,
    "type": "Enquiry"
  }
]

Response Information

Resource Description

A 200 OK result

v1/reservation/replied POST

Performs a batch mark as replied, marking as replied a collection of bookings and enquiries

Request Information

https://api.lodgify.com/v1/reservation/replied

Body Parameters

Collection of identifiers and types that will allow to identify a Booking or Enquiry

Collection of BatchBookingDto

Name	Description	Type	Additional information
Id	Booking or Enquiry identifier	integer	None.
Type	Type of the object (Booking or Enquiry)	string	None.

Request Formats

application/json, text/json

[
  {
    "id": 1,
    "type": "Booking"
  },
  {
    "id": 2,
    "type": "Enquiry"
  }
]

Response Information

Resource Description

A 200 OK result

BookingsApi_v2

Booking related operations can be found in these endpoints

v2/reservations/bookings GET

Retrieve a list of bookings matching the query parameters

Request Information

https://api.lodgify.com/v2/reservations/bookings?page={page}&size={size}&includeCount={includeCount}&stayFilter={stayFilter}&updatedSince={updatedSince}&includeTransactions={includeTransactions}&trash={trash}

URI Parameters

Name	Description	Type	Additional information
page	Number of the page to retrieve	integer	Default value is 1
size	Number of items per page	integer	Default value is 50
includeCount	Include number of all items	boolean	Default value is False
stayFilter	Filter Bookings by the stay dates	StayFilterEnum	Default value is Upcoming
updatedSince	Include only Bookings updated since this date	date	None.
includeTransactions	Include details about transactions and schedule	boolean	Default value is False
trash	Query bookings that are in trash	boolean	Default value is False

Response Information

Resource Description

A list of Bookings

BookingSetDto

Name	Description	Type	Additional information
Count		integer	None.
Items		Collection of v2/BookingDto	None.

Response Formats

application/json, text/json

Sample not available.

v2/reservations/bookings/{id} GET

Retrieve a Booking by Id

Request Information

https://api.lodgify.com/v2/reservations/bookings/{id}

URI Parameters

Name	Description	Type	Additional information
id	Id of the Booking	integer	Required

Response Information

Resource Description

The Booking with the specified Id. 404 Error code when the booking is not found

v2/BookingDto

Name	Description	Type	Additional information
Id	Id of the booking	integer	None.
UserId	User the booking belongs to	integer	None.
Arrival	Arrival date	Date	None.
Departure	Departure date	Date	None.
PropertyId	Id of the property	integer	None.
Rooms	Rooms booked	Collection of BookingRoomDto	None.
Guest	Guest of the booking	v2/GuestDto	None.
Language	Language selected by the guest	string	None.
Status	Status of the booking	StatusEnum	None.
TentativeExpiresAt	Time the Tentative status will expire at	date	None.
Source	Source the booking was created from	SourceEnum	None.
SourceText	Details of the booking from the source	string	None.
CreatedFromIp	Ip the booking was created from	string	None.
CreatedAt	Time the booking was created at	date	None.
UpdatedAt	Last time the booking was updated	date	None.
CanceledAt	Date the booking was canceled at	date	None.
IsNew	When it is new, the owner has not seen the booking yet	boolean	None.
IsDeleted	When it is deleted, the owner moved the booking to trash	boolean	None.
CurrencyCode	Currency in which all amounts are expressed for this booking	string	None.
TotalAmount	Total amount of the booking	Money	None.
Subtotals	Subtotal details of the booking	SubtotalDto	None.
AmountPaid	Amount already paid	Money	None.
AmountDue	Amount pending to be paid or refunded	Money	None.
Quote	Active quote belonging to the booking	v2/QuoteDto	None.
Transactions	Transaction details of the booking	Collection of TransactionDto	None.
Notes	Notes added by the owner	string	None.

Response Formats

application/json, text/json

{
  "id": 1,
  "user_id": 2,
  "arrival": "0001-01-01",
  "departure": "0001-01-01",
  "property_id": 3,
  "rooms": [
    {
      "room_type_id": 1,
      "people": 2
    },
    {
      "room_type_id": 1,
      "people": 2
    }
  ],
  "guest": {
    "name": "sample string 1",
    "email": "sample string 2",
    "phone": "sample string 3",
    "country_code": "sample string 4"
  },
  "language": "sample string 4",
  "status": "Open",
  "tentative_expires_at": "2020-04-07T16:11:56.2538087+02:00",
  "source": "Manual",
  "source_text": "sample string 5",
  "created_from_ip": "sample string 6",
  "created_at": "2020-04-07T16:11:56.2547907+02:00",
  "updated_at": "2020-04-07T16:11:56.2547907+02:00",
  "canceled_at": "2020-04-07T16:11:56.2547907+02:00",
  "is_new": true,
  "is_deleted": true,
  "currency_code": "sample string 11",
  "total_amount": 0.0,
  "subtotals": {
    "stay": 0.0,
    "promotions": 0.0,
    "fees": 0.0,
    "taxes": 0.0,
    "addons": 0.0
  },
  "amount_paid": 0.0,
  "amount_due": 0.0,
  "quote": {
    "id": 1,
    "policy": {
      "name": "sample string 1",
      "payments": "sample string 2",
      "cancellation": "sample string 3",
      "damage_deposit": "sample string 4"
    },
    "scheduled_transactions": [
      {
        "id": 1,
        "type": "PrePayment",
        "status": "Scheduled",
        "amount": 0.0,
        "due_at": "0001-01-01"
      },
      {
        "id": 1,
        "type": "PrePayment",
        "status": "Scheduled",
        "amount": 0.0,
        "due_at": "0001-01-01"
      }
    ]
  },
  "transactions": [
    {
      "id": 1,
      "type": "Payment",
      "status": "Requested",
      "description": "sample string 2",
      "amount": 0.0,
      "processed_at": "2020-04-07T16:11:56.2557619+02:00"
    },
    {
      "id": 1,
      "type": "Payment",
      "status": "Requested",
      "description": "sample string 2",
      "amount": 0.0,
      "processed_at": "2020-04-07T16:11:56.2557619+02:00"
    }
  ],
  "notes": "sample string 12"
}

v2/reservations/bookings/{id}/quote/paymentLink GET

Retrieve the next payment link for a Booking

Request Information

https://api.lodgify.com/v2/reservations/bookings/{id}/quote/paymentLink

URI Parameters

Name	Description	Type	Additional information
id	Id of the Booking	integer	Required

Response Information

Resource Description

The Booking with the specified Id. 404 Error code when the booking is not found

PaymentLinkDto

Name	Description	Type	Additional information
Url	Url address to the payment page	string	None.

Response Formats

application/json, text/json

{
  "url": "sample string 1"
}

v2/reservations/bookings/{id}/quote/paymentLink POST

Create a payment link for the booking

Request Information

https://api.lodgify.com/v2/reservations/bookings/{id}/quote/paymentLink

URI Parameters

Name	Description	Type	Additional information
id	Id of the booking	integer	Required

Body Parameters

Amount to be requested

CreatePaymentLinkDto

Name	Description	Type	Additional information
Amount	Amount to request	decimal number	Range: inclusive between 0.01 and 1.79769313486232E+308

Request Formats

application/json, text/json

{
  "amount": 1.0
}

Response Information

Resource Description

Returns false when the requested amount will not be enforced because the booking has a pending schedule to be paid first.

PaymentLinkCreatedDto

Name	Description	Type	Additional information
Succeeded	When true, the payment link has been created with the specified amount. When false, the payment link could not be created because there is a scheduled payment which is pending or the requested amount could not be enforced.	boolean	None.

Response Formats

application/json, text/json

{
  "succeeded": true
}

CountriesApi

Offers operations with countries available in Lodgify

v1/countries GET

Returns a list of all the available countries

Request Information

https://api.lodgify.com/v1/countries

Response Information

Resource Description

A list of objects representing a country

Collection of CountryDto

Name	Description	Type	Additional information
Code	Country Code	string	None.
Name	Country Name	string	None.

Response Formats

application/json, text/json

[
  {
    "code": "AF",
    "name": "Afghanistan"
  },
  {
    "code": "AX",
    "name": "Aland Islands"
  }
]

v1/countries/{code} GET

Returns a country by given his code

Request Information

https://api.lodgify.com/v1/countries/{code}

URI Parameters

Name	Description	Type	Additional information
code	Code of the country you want to obtain	string	Required

Response Information

Resource Description

A representation of the country

CountryDto

Name	Description	Type	Additional information
Code	Country Code	string	None.
Name	Country Name	string	None.

Response Formats

application/json, text/json

{
  "code": "AL",
  "name": "Albania"
}

CurrenciesApi

Offers operations to work with currencies

v1/currencies GET

Returns a list of available currencies in Lodgify

Request Information

https://api.lodgify.com/v1/currencies

Response Information

Resource Description

A list of Currencies with name, code, symbol and currency exchange values for Euro

Collection of Global.CurrencyDto

Name	Description	Type	Additional information
Id	Currency identifier	integer	None.
Code	Currency code	string	None.
Name	Currency Name	string	None.
EuroForex	Exchange rate between currency and Euro	decimal number	None.
Symbol	Currency symbol	string	None.

Response Formats

application/json, text/json

[
  {
    "id": 1,
    "code": "sample string 2",
    "name": "sample string 3",
    "euro_forex": 4.0,
    "symbol": "sample string 5"
  },
  {
    "id": 1,
    "code": "sample string 2",
    "name": "sample string 3",
    "euro_forex": 4.0,
    "symbol": "sample string 5"
  }
]

v1/currencies/{code} GET

Returns the currency with the given code

Request Information

https://api.lodgify.com/v1/currencies/{code}

URI Parameters

Name	Description	Type	Additional information
code	Code of the currency you want	string	Required

Response Information

Resource Description

An object with name, code, symbol and currency exchange values for Euro

Global.CurrencyDto

Name	Description	Type	Additional information
Id	Currency identifier	integer	None.
Code	Currency code	string	None.
Name	Currency Name	string	None.
EuroForex	Exchange rate between currency and Euro	decimal number	None.
Symbol	Currency symbol	string	None.

Response Formats

application/json, text/json

{
  "id": 1,
  "code": "sample string 2",
  "name": "sample string 3",
  "euro_forex": 4.0,
  "symbol": "sample string 5"
}

OtaChannelApi

Channel specific operations. You need to have a channel API key to use this api calls. For OTAs.

v1/channel/xml GET

Gets the Channel Xml file for all the users with this channel enabled or empty string if not exists

Request Information

https://api.lodgify.com/v1/channel/xml

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.

OtaPropertyRatesApi

v1/channel/rates GET

Gets the list of HouseRates modified since the date passed, for the user the channel is impersonating

Request Information

https://api.lodgify.com/v1/channel/rates?modifiedSince={modifiedSince}

URI Parameters

Name	Description	Type	Additional information
modifiedSince		date	None.

Response Information

Resource Description

Collection of PropertyRatesDto

Name	Description	Type	Additional information
PropertyId	property Identifier	integer	None.
Settings	Rate settings	RateSettingsDto	None.
DefaultRate	Default rate applied for this property	RateDto	None.
SeasonRates	Season rates for this property	Collection of RateDto	None.
ModifiedDate	DateTime of the last time rates were modified	date	None.

Response Formats

application/json, text/json

[
  {
    "property_id": 1,
    "settings": {
      "currency_code": "sample string 1",
      "check_in": 1,
      "check_out": 1,
      "reservation_deposit": 1.0,
      "reservation_deposit_percentage": 1.0,
      "security_deposit": 1.0,
      "security_deposit_percentage": 1.0,
      "give_best_price": true
    },
    "default_rate": {
      "id": 1,
      "name": "sample string 2",
      "checkout_allowed_days": {},
      "checkin_allowed_days": {},
      "custom_days_rate": 1,
      "min_stay": 1,
      "room_rates": [
        {
          "room_id": 1,
          "daily_price": 1.0,
          "monday_price": 1.0,
          "tuesday_price": 1.0,
          "wednesday_price": 1.0,
          "thursday_price": 1.0,
          "friday_price": 1.0,
          "saturday_price": 1.0,
          "sunday_price": 1.0,
          "weekly_price": 1.0,
          "monthly_price": 1.0,
          "custom_price": 1.0,
          "min_stay_days": 2,
          "charge_per_person_from": 1,
          "charge_per_person_value": 1.0,
          "charge_short_stay_days": 1,
          "charge_short_stay_value": 1.0,
          "charges": [
            {
              "type": "sample string 1",
              "name": "sample string 2",
              "value": 3.0,
              "charge_type": "sample string 4",
              "rate_type": "sample string 5",
              "frequency": "sample string 6",
              "tax_percentage": 1.0
            },
            {
              "type": "sample string 1",
              "name": "sample string 2",
              "value": 3.0,
              "charge_type": "sample string 4",
              "rate_type": "sample string 5",
              "frequency": "sample string 6",
              "tax_percentage": 1.0
            }
          ]
        },
        {
          "room_id": 1,
          "daily_price": 1.0,
          "monday_price": 1.0,
          "tuesday_price": 1.0,
          "wednesday_price": 1.0,
          "thursday_price": 1.0,
          "friday_price": 1.0,
          "saturday_price": 1.0,
          "sunday_price": 1.0,
          "weekly_price": 1.0,
          "monthly_price": 1.0,
          "custom_price": 1.0,
          "min_stay_days": 2,
          "charge_per_person_from": 1,
          "charge_per_person_value": 1.0,
          "charge_short_stay_days": 1,
          "charge_short_stay_value": 1.0,
          "charges": [
            {
              "type": "sample string 1",
              "name": "sample string 2",
              "value": 3.0,
              "charge_type": "sample string 4",
              "rate_type": "sample string 5",
              "frequency": "sample string 6",
              "tax_percentage": 1.0
            },
            {
              "type": "sample string 1",
              "name": "sample string 2",
              "value": 3.0,
              "charge_type": "sample string 4",
              "rate_type": "sample string 5",
              "frequency": "sample string 6",
              "tax_percentage": 1.0
            }
          ]
        }
      ],
      "periods": [
        {
          "start": "2020-04-07",
          "end": "2020-04-07"
        },
        {
          "start": "2020-04-07",
          "end": "2020-04-07"
        }
      ]
    },
    "season_rates": [
      {
        "id": 1,
        "name": "sample string 2",
        "checkout_allowed_days": {},
        "checkin_allowed_days": {},
        "custom_days_rate": 1,
        "min_stay": 1,
        "room_rates": [
          {
            "room_id": 1,
            "daily_price": 1.0,
            "monday_price": 1.0,
            "tuesday_price": 1.0,
            "wednesday_price": 1.0,
            "thursday_price": 1.0,
            "friday_price": 1.0,
            "saturday_price": 1.0,
            "sunday_price": 1.0,
            "weekly_price": 1.0,
            "monthly_price": 1.0,
            "custom_price": 1.0,
            "min_stay_days": 2,
            "charge_per_person_from": 1,
            "charge_per_person_value": 1.0,
            "charge_short_stay_days": 1,
            "charge_short_stay_value": 1.0,
            "charges": [
              {
                "type": "sample string 1",
                "name": "sample string 2",
                "value": 3.0,
                "charge_type": "sample string 4",
                "rate_type": "sample string 5",
                "frequency": "sample string 6",
                "tax_percentage": 1.0
              },
              {
                "type": "sample string 1",
                "name": "sample string 2",
                "value": 3.0,
                "charge_type": "sample string 4",
                "rate_type": "sample string 5",
                "frequency": "sample string 6",
                "tax_percentage": 1.0
              }
            ]
          },
          {
            "room_id": 1,
            "daily_price": 1.0,
            "monday_price": 1.0,
            "tuesday_price": 1.0,
            "wednesday_price": 1.0,
            "thursday_price": 1.0,
            "friday_price": 1.0,
            "saturday_price": 1.0,
            "sunday_price": 1.0,
            "weekly_price": 1.0,
            "monthly_price": 1.0,
            "custom_price": 1.0,
            "min_stay_days": 2,
            "charge_per_person_from": 1,
            "charge_per_person_value": 1.0,
            "charge_short_stay_days": 1,
            "charge_short_stay_value": 1.0,
            "charges": [
              {
                "type": "sample string 1",
                "name": "sample string 2",
                "value": 3.0,
                "charge_type": "sample string 4",
                "rate_type": "sample string 5",
                "frequency": "sample string 6",
                "tax_percentage": 1.0
              },
              {
                "type": "sample string 1",
                "name": "sample string 2",
                "value": 3.0,
                "charge_type": "sample string 4",
                "rate_type": "sample string 5",
                "frequency": "sample string 6",
                "tax_percentage": 1.0
              }
            ]
          }
        ],
        "periods": [
          {
            "start": "2020-04-07",
            "end": "2020-04-07"
          },
          {
            "start": "2020-04-07",
            "end": "2020-04-07"
          }
        ]
      },
      {
        "id": 1,
        "name": "sample string 2",
        "checkout_allowed_days": {},
        "checkin_allowed_days": {},
        "custom_days_rate": 1,
        "min_stay": 1,
        "room_rates": [
          {
            "room_id": 1,
            "daily_price": 1.0,
            "monday_price": 1.0,
            "tuesday_price": 1.0,
            "wednesday_price": 1.0,
            "thursday_price": 1.0,
            "friday_price": 1.0,
            "saturday_price": 1.0,
            "sunday_price": 1.0,
            "weekly_price": 1.0,
            "monthly_price": 1.0,
            "custom_price": 1.0,
            "min_stay_days": 2,
            "charge_per_person_from": 1,
            "charge_per_person_value": 1.0,
            "charge_short_stay_days": 1,
            "charge_short_stay_value": 1.0,
            "charges": [
              {
                "type": "sample string 1",
                "name": "sample string 2",
                "value": 3.0,
                "charge_type": "sample string 4",
                "rate_type": "sample string 5",
                "frequency": "sample string 6",
                "tax_percentage": 1.0
              },
              {
                "type": "sample string 1",
                "name": "sample string 2",
                "value": 3.0,
                "charge_type": "sample string 4",
                "rate_type": "sample string 5",
                "frequency": "sample string 6",
                "tax_percentage": 1.0
              }
            ]
          },
          {
            "room_id": 1,
            "daily_price": 1.0,
            "monday_price": 1.0,
            "tuesday_price": 1.0,
            "wednesday_price": 1.0,
            "thursday_price": 1.0,
            "friday_price": 1.0,
            "saturday_price": 1.0,
            "sunday_price": 1.0,
            "weekly_price": 1.0,
            "monthly_price": 1.0,
            "custom_price": 1.0,
            "min_stay_days": 2,
            "charge_per_person_from": 1,
            "charge_per_person_value": 1.0,
            "charge_short_stay_days": 1,
            "charge_short_stay_value": 1.0,
            "charges": [
              {
                "type": "sample string 1",
                "name": "sample string 2",
                "value": 3.0,
                "charge_type": "sample string 4",
                "rate_type": "sample string 5",
                "frequency": "sample string 6",
                "tax_percentage": 1.0
              },
              {
                "type": "sample string 1",
                "name": "sample string 2",
                "value": 3.0,
                "charge_type": "sample string 4",
                "rate_type": "sample string 5",
                "frequency": "sample string 6",
                "tax_percentage": 1.0
              }
            ]
          }
        ],
        "periods": [
          {
            "start": "2020-04-07",
            "end": "2020-04-07"
          },
          {
            "start": "2020-04-07",
            "end": "2020-04-07"
          }
        ]
      }
    ],
    "modified_date": "2020-04-07T16:11:56.3592914+02:00"
  },
  {
    "property_id": 1,
    "settings": {
      "currency_code": "sample string 1",
      "check_in": 1,
      "check_out": 1,
      "reservation_deposit": 1.0,
      "reservation_deposit_percentage": 1.0,
      "security_deposit": 1.0,
      "security_deposit_percentage": 1.0,
      "give_best_price": true
    },
    "default_rate": {
      "id": 1,
      "name": "sample string 2",
      "checkout_allowed_days": {},
      "checkin_allowed_days": {},
      "custom_days_rate": 1,
      "min_stay": 1,
      "room_rates": [
        {
          "room_id": 1,
          "daily_price": 1.0,
          "monday_price": 1.0,
          "tuesday_price": 1.0,
          "wednesday_price": 1.0,
          "thursday_price": 1.0,
          "friday_price": 1.0,
          "saturday_price": 1.0,
          "sunday_price": 1.0,
          "weekly_price": 1.0,
          "monthly_price": 1.0,
          "custom_price": 1.0,
          "min_stay_days": 2,
          "charge_per_person_from": 1,
          "charge_per_person_value": 1.0,
          "charge_short_stay_days": 1,
          "charge_short_stay_value": 1.0,
          "charges": [
            {
              "type": "sample string 1",
              "name": "sample string 2",
              "value": 3.0,
              "charge_type": "sample string 4",
              "rate_type": "sample string 5",
              "frequency": "sample string 6",
              "tax_percentage": 1.0
            },
            {
              "type": "sample string 1",
              "name": "sample string 2",
              "value": 3.0,
              "charge_type": "sample string 4",
              "rate_type": "sample string 5",
              "frequency": "sample string 6",
              "tax_percentage": 1.0
            }
          ]
        },
        {
          "room_id": 1,
          "daily_price": 1.0,
          "monday_price": 1.0,
          "tuesday_price": 1.0,
          "wednesday_price": 1.0,
          "thursday_price": 1.0,
          "friday_price": 1.0,
          "saturday_price": 1.0,
          "sunday_price": 1.0,
          "weekly_price": 1.0,
          "monthly_price": 1.0,
          "custom_price": 1.0,
          "min_stay_days": 2,
          "charge_per_person_from": 1,
          "charge_per_person_value": 1.0,
          "charge_short_stay_days": 1,
          "charge_short_stay_value": 1.0,
          "charges": [
            {
              "type": "sample string 1",
              "name": "sample string 2",
              "value": 3.0,
              "charge_type": "sample string 4",
              "rate_type": "sample string 5",
              "frequency": "sample string 6",
              "tax_percentage": 1.0
            },
            {
              "type": "sample string 1",
              "name": "sample string 2",
              "value": 3.0,
              "charge_type": "sample string 4",
              "rate_type": "sample string 5",
              "frequency": "sample string 6",
              "tax_percentage": 1.0
            }
          ]
        }
      ],
      "periods": [
        {
          "start": "2020-04-07",
          "end": "2020-04-07"
        },
        {
          "start": "2020-04-07",
          "end": "2020-04-07"
        }
      ]
    },
    "season_rates": [
      {
        "id": 1,
        "name": "sample string 2",
        "checkout_allowed_days": {},
        "checkin_allowed_days": {},
        "custom_days_rate": 1,
        "min_stay": 1,
        "room_rates": [
          {
            "room_id": 1,
            "daily_price": 1.0,
            "monday_price": 1.0,
            "tuesday_price": 1.0,
            "wednesday_price": 1.0,
            "thursday_price": 1.0,
            "friday_price": 1.0,
            "saturday_price": 1.0,
            "sunday_price": 1.0,
            "weekly_price": 1.0,
            "monthly_price": 1.0,
            "custom_price": 1.0,
            "min_stay_days": 2,
            "charge_per_person_from": 1,
            "charge_per_person_value": 1.0,
            "charge_short_stay_days": 1,
            "charge_short_stay_value": 1.0,
            "charges": [
              {
                "type": "sample string 1",
                "name": "sample string 2",
                "value": 3.0,
                "charge_type": "sample string 4",
                "rate_type": "sample string 5",
                "frequency": "sample string 6",
                "tax_percentage": 1.0
              },
              {
                "type": "sample string 1",
                "name": "sample string 2",
                "value": 3.0,
                "charge_type": "sample string 4",
                "rate_type": "sample string 5",
                "frequency": "sample string 6",
                "tax_percentage": 1.0
              }
            ]
          },
          {
            "room_id": 1,
            "daily_price": 1.0,
            "monday_price": 1.0,
            "tuesday_price": 1.0,
            "wednesday_price": 1.0,
            "thursday_price": 1.0,
            "friday_price": 1.0,
            "saturday_price": 1.0,
            "sunday_price": 1.0,
            "weekly_price": 1.0,
            "monthly_price": 1.0,
            "custom_price": 1.0,
            "min_stay_days": 2,
            "charge_per_person_from": 1,
            "charge_per_person_value": 1.0,
            "charge_short_stay_days": 1,
            "charge_short_stay_value": 1.0,
            "charges": [
              {
                "type": "sample string 1",
                "name": "sample string 2",
                "value": 3.0,
                "charge_type": "sample string 4",
                "rate_type": "sample string 5",
                "frequency": "sample string 6",
                "tax_percentage": 1.0
              },
              {
                "type": "sample string 1",
                "name": "sample string 2",
                "value": 3.0,
                "charge_type": "sample string 4",
                "rate_type": "sample string 5",
                "frequency": "sample string 6",
                "tax_percentage": 1.0
              }
            ]
          }
        ],
        "periods": [
          {
            "start": "2020-04-07",
            "end": "2020-04-07"
          },
          {
            "start": "2020-04-07",
            "end": "2020-04-07"
          }
        ]
      },
      {
        "id": 1,
        "name": "sample string 2",
        "checkout_allowed_days": {},
        "checkin_allowed_days": {},
        "custom_days_rate": 1,
        "min_stay": 1,
        "room_rates": [
          {
            "room_id": 1,
            "daily_price": 1.0,
            "monday_price": 1.0,
            "tuesday_price": 1.0,
            "wednesday_price": 1.0,
            "thursday_price": 1.0,
            "friday_price": 1.0,
            "saturday_price": 1.0,
            "sunday_price": 1.0,
            "weekly_price": 1.0,
            "monthly_price": 1.0,
            "custom_price": 1.0,
            "min_stay_days": 2,
            "charge_per_person_from": 1,
            "charge_per_person_value": 1.0,
            "charge_short_stay_days": 1,
            "charge_short_stay_value": 1.0,
            "charges": [
              {
                "type": "sample string 1",
                "name": "sample string 2",
                "value": 3.0,
                "charge_type": "sample string 4",
                "rate_type": "sample string 5",
                "frequency": "sample string 6",
                "tax_percentage": 1.0
              },
              {
                "type": "sample string 1",
                "name": "sample string 2",
                "value": 3.0,
                "charge_type": "sample string 4",
                "rate_type": "sample string 5",
                "frequency": "sample string 6",
                "tax_percentage": 1.0
              }
            ]
          },
          {
            "room_id": 1,
            "daily_price": 1.0,
            "monday_price": 1.0,
            "tuesday_price": 1.0,
            "wednesday_price": 1.0,
            "thursday_price": 1.0,
            "friday_price": 1.0,
            "saturday_price": 1.0,
            "sunday_price": 1.0,
            "weekly_price": 1.0,
            "monthly_price": 1.0,
            "custom_price": 1.0,
            "min_stay_days": 2,
            "charge_per_person_from": 1,
            "charge_per_person_value": 1.0,
            "charge_short_stay_days": 1,
            "charge_short_stay_value": 1.0,
            "charges": [
              {
                "type": "sample string 1",
                "name": "sample string 2",
                "value": 3.0,
                "charge_type": "sample string 4",
                "rate_type": "sample string 5",
                "frequency": "sample string 6",
                "tax_percentage": 1.0
              },
              {
                "type": "sample string 1",
                "name": "sample string 2",
                "value": 3.0,
                "charge_type": "sample string 4",
                "rate_type": "sample string 5",
                "frequency": "sample string 6",
                "tax_percentage": 1.0
              }
            ]
          }
        ],
        "periods": [
          {
            "start": "2020-04-07",
            "end": "2020-04-07"
          },
          {
            "start": "2020-04-07",
            "end": "2020-04-07"
          }
        ]
      }
    ],
    "modified_date": "2020-04-07T16:11:56.3592914+02:00"
  }
]

PropertiesApi

Resource for all the Houses operations

v1/properties GET

Returns the list of completed properties for a given user. This is a protected endpoint.

Request Information

https://api.lodgify.com/v1/properties?wid={wid}

URI Parameters

Name	Description	Type	Additional information
wid	Optional, if provided it will return any localized text as if it was for the given website. So any Resource override done in that website will be returned instead the default translation	integer	None.

Response Information

Resource Description

Object containing basic property information

Collection of PropertySummaryDto

Name	Description	Type	Additional information
Id	property identifier	integer	None.
Name	Name of the property	string	None.
Latitude	Latitude coordinate of the house	decimal number	None.
Longitude	Longitude coordinate of the house	decimal number	None.
Rooms		Collection of RoomSummaryDto	None.

Response Formats

application/json, text/json

[
  {
    "id": 1,
    "name": "sample string 2",
    "latitude": 3.0,
    "longitude": 4.0,
    "rooms": [
      {
        "id": 1,
        "name": "sample string 2"
      },
      {
        "id": 1,
        "name": "sample string 2"
      }
    ]
  },
  {
    "id": 1,
    "name": "sample string 2",
    "latitude": 3.0,
    "longitude": 4.0,
    "rooms": [
      {
        "id": 1,
        "name": "sample string 2"
      },
      {
        "id": 1,
        "name": "sample string 2"
      }
    ]
  }
]

v1/properties/{id} GET

Get the basic info for a given house/property

Request Information

https://api.lodgify.com/v1/properties/{id}?maxDate={maxDate}&wid={wid}

URI Parameters

Name	Description	Type	Additional information
id	Property identifier	integer	Required
maxDate		date	None.
wid		integer	None.

Response Information

Resource Description

Object containing basic property information

PropertyDto

Name	Description	Type	Additional information
Id	property identifier	integer	None.
Name	Name of the property	string	None.
Address	Address of the property	string	None.
Zip	Zip code for the property	string	None.
City	City name where the property is located	string	None.
Country	Country name where the property is located	string	None.
ImageUrl	Image Url	string	None.
HasAddons	Boolean indicating if the property has available addons	boolean	None.
HasAgreement		boolean	None.
AgreementText		string	None.
AgreementUrl		string	None.
Owner		PropertyOwnerDto	None.
Rating		decimal number	None.
PriceUnitInDays	Price unit in days. This field indicates the number of days of stay the MinPrice and MaxPrice are So if we have a 30 PriceUnitInDays, it means the MinPrice and MaxPrice are Monthly prices If multiple prices per diferent periods are defined it will return daily prices	integer	None.
MinPrice		decimal number	None.
OriginalMinPrice		decimal number	None.
MaxPrice		decimal number	None.
OriginalMaxPrice		decimal number	None.
Rooms		Collection of RoomDto	None.
InOutMaxDate		date	None.
InOut		ResultSearchInOutDto	None.
Currency		Properties.CurrencyDto	None.

Response Formats

application/json, text/json

{
  "id": 1,
  "name": "sample string 2",
  "address": "sample string 3",
  "zip": "sample string 4",
  "city": "sample string 5",
  "country": "sample string 6",
  "image_url": "sample string 7",
  "has_addons": true,
  "has_agreement": true,
  "agreement_text": "sample string 10",
  "agreement_url": "sample string 11",
  "owner": {
    "spoken_languages": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "rating": 12.0,
  "price_unit_in_days": 13,
  "min_price": 14.0,
  "original_min_price": 15.0,
  "max_price": 16.0,
  "original_max_price": 17.0,
  "rooms": [
    {
      "id": 1,
      "name": "sample string 2",
      "image_url": "sample string 3",
      "max_people": 4,
      "units": 5,
      "has_wifi": true,
      "has_meal_plan": true,
      "bedrooms": 8,
      "bathrooms": 9,
      "area_unit": "sample string 10",
      "area": 11.0,
      "min_price": 12.0,
      "original_min_price": 13.0,
      "max_price": 14.0,
      "original_max_price": 15.0,
      "price_unit_in_days": 16,
      "currency": {
        "id": 1,
        "code": "sample string 2",
        "name": "sample string 3",
        "euro_forex": 4.0,
        "symbol": "sample string 5"
      }
    },
    {
      "id": 1,
      "name": "sample string 2",
      "image_url": "sample string 3",
      "max_people": 4,
      "units": 5,
      "has_wifi": true,
      "has_meal_plan": true,
      "bedrooms": 8,
      "bathrooms": 9,
      "area_unit": "sample string 10",
      "area": 11.0,
      "min_price": 12.0,
      "original_min_price": 13.0,
      "max_price": 14.0,
      "original_max_price": 15.0,
      "price_unit_in_days": 16,
      "currency": {
        "id": 1,
        "code": "sample string 2",
        "name": "sample string 3",
        "euro_forex": 4.0,
        "symbol": "sample string 5"
      }
    }
  ],
  "in_out_max_date": "2020-04-07",
  "in_out": {
    "is_restricted": true,
    "check_in": [
      {
        "date": "2020-04-07",
        "for": "sample string 2"
      },
      {
        "date": "2020-04-07",
        "for": "sample string 2"
      }
    ],
    "check_out": [
      {
        "date": "2020-04-07",
        "for": "sample string 2"
      },
      {
        "date": "2020-04-07",
        "for": "sample string 2"
      }
    ],
    "not_available": [
      {
        "date": "2020-04-07",
        "for": "sample string 2"
      },
      {
        "date": "2020-04-07",
        "for": "sample string 2"
      }
    ]
  },
  "currency": {
    "id": 1,
    "code": "sample string 2",
    "name": "sample string 3",
    "euro_forex": 4.0,
    "symbol": "sample string 5"
  }
}

v1/properties/{id}/payments GET

Returns a list of available payments for a given House. This payment types are useful when creating bookings

Request Information

https://api.lodgify.com/v1/properties/{id}/payments

URI Parameters

Name	Description	Type	Additional information
id	House identifier	integer	Required

Response Information

Resource Description

A list of the available payment types for the house

Collection of PaymentSettingsDto

Name	Type	Additional information
Id	integer	None.
PaymentAddress	string	None.
PaymentType	string	None.

Response Formats

application/json, text/json

[
  {
    "id": 1,
    "payment_address": "sample string 1",
    "payment_type": "sample string 2"
  },
  {
    "id": 1,
    "payment_address": "sample string 1",
    "payment_type": "sample string 2"
  }
]

v1/properties/{pid}/rates/addons GET

Returns a list of available addons for the given property. If additional parameters are specified, then it'll return only those that are valid

Request Information

https://api.lodgify.com/v1/properties/{pid}/rates/addons?start={start}&end={end}&rid={rid}

URI Parameters

Name	Description	Type	Additional information
pid	Property Id	integer	Required
start	Optional, if provided (and paired with a end date) it will return the addons available in those dates	date	None.
end	Optional, end date	date	None.
rid	Optional, Room identifier. if provided it will return only the addons available for that room	integer	None.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json

{}

v1/properties/{pid}/rooms/{rid} GET

Returns details for a given room in a property

Request Information

https://api.lodgify.com/v1/properties/{pid}/rooms/{rid}?wid={wid}

URI Parameters

Name	Description	Type	Additional information
pid	Property Id	integer	Required
rid	Room Id	integer	Required
wid	Optional, if provided it will return any localized text as if it was for the given website. So any Resource override done in that website will be returned instead the default translation	integer	None.

Response Information

Resource Description

Details for the room

RoomDetailsDto

Name	Type	Additional information
Images	Collection of DescribedImageDto	None.
Amenities	Dictionary of string [key] and Collection of AmenityDto [value]	None.
Description	string	None.
BreakfastIncluded	boolean	None.
HasParking	boolean	None.
AdultsOnly	boolean	None.
PetsAllowed	boolean	None.
ShowAdditionalKeyFacts	boolean	None.
Id	integer	None.
Name	string	None.
ImageUrl	string	None.
MaxPeople	integer	None.
Units	integer	None.
HasWifi	boolean	None.
HasMealPlan	boolean	None.
Bedrooms	integer	None.
Bathrooms	integer	None.
AreaUnit	string	None.
Area	decimal number	None.
MinPrice	decimal number	None.
OriginalMinPrice	decimal number	None.
MaxPrice	decimal number	None.
OriginalMaxPrice	decimal number	None.
PriceUnitInDays	integer	None.
Currency	Properties.CurrencyDto	None.

Response Formats

application/json, text/json

{
  "images": [
    {
      "text": "sample string 1",
      "url": "sample string 2"
    },
    {
      "text": "sample string 1",
      "url": "sample string 2"
    }
  ],
  "amenities": {
    "sample string 1": [
      {
        "name": "sample string 1",
        "prefix": "sample string 2",
        "bracket": "sample string 3",
        "text": "sample string 4"
      },
      {
        "name": "sample string 1",
        "prefix": "sample string 2",
        "bracket": "sample string 3",
        "text": "sample string 4"
      }
    ],
    "sample string 2": [
      {
        "name": "sample string 1",
        "prefix": "sample string 2",
        "bracket": "sample string 3",
        "text": "sample string 4"
      },
      {
        "name": "sample string 1",
        "prefix": "sample string 2",
        "bracket": "sample string 3",
        "text": "sample string 4"
      }
    ]
  },
  "description": "sample string 1",
  "breakfast_included": true,
  "has_parking": true,
  "adults_only": true,
  "pets_allowed": true,
  "show_additional_key_facts": true,
  "id": 6,
  "name": "sample string 7",
  "image_url": "sample string 8",
  "max_people": 9,
  "units": 10,
  "has_wifi": true,
  "has_meal_plan": true,
  "bedrooms": 13,
  "bathrooms": 14,
  "area_unit": "sample string 15",
  "area": 16.0,
  "min_price": 17.0,
  "original_min_price": 18.0,
  "max_price": 19.0,
  "original_max_price": 20.0,
  "price_unit_in_days": 21,
  "currency": {
    "id": 1,
    "code": "sample string 2",
    "name": "sample string 3",
    "euro_forex": 4.0,
    "symbol": "sample string 5"
  }
}

PropertiesApi_v2

Resource for all the Properties operations

v2/properties GET

Returns a paged list of all properties

Request Information

https://api.lodgify.com/v2/properties?wid={wid}&updatedSince={updatedSince}&includeCount={includeCount}&includeInOut={includeInOut}&page={page}&size={size}

URI Parameters

Name	Description	Type	Additional information
wid	Website Id	integer	None.
updatedSince	DateTime so the returned list will only include the properties modified since this datetime	date	None.
includeCount	Boolean, if true it will return the total number of results	boolean	Default value is False
includeInOut	Boolean, if true the results will include available dates for arrival or departure	boolean	Default value is False
page	Number of the page to retrieve	integer	Default value is 1
size	Number of items per page (max. 50)	integer	Default value is 50

Response Information

Resource Description

properties/v2/PropertyListDto

Name	Description	Type	Additional information
Count	Total number of items available. Only returned if includeCount = true	integer	None.
Items	List of properties for current page	Collection of properties/v2/PropertyDto	None.

Response Formats

application/json, text/json

{
  "count": 1,
  "items": [
    {
      "id": 1,
      "name": "sample string 2",
      "latitude": 3.0,
      "longitude": 4.0,
      "address": "sample string 5",
      "zip": "sample string 6",
      "city": "sample string 7",
      "country": "sample string 8",
      "image_url": "sample string 9",
      "has_addons": true,
      "has_agreement": true,
      "agreement_text": "sample string 12",
      "agreement_url": "sample string 13",
      "contact": {
        "spoken_languages": [
          "sample string 1",
          "sample string 2"
        ]
      },
      "rating": 14.0,
      "price_unit_in_days": 15,
      "min_price": 16.0,
      "original_min_price": 17.0,
      "max_price": 18.0,
      "original_max_price": 19.0,
      "rooms": [
        {
          "id": 1,
          "name": "sample string 2"
        },
        {
          "id": 1,
          "name": "sample string 2"
        }
      ],
      "in_out_max_date": "2020-04-07",
      "in_out": {
        "is_restricted": true,
        "check_in": [
          {
            "date": "2020-04-07",
            "for": "sample string 2"
          },
          {
            "date": "2020-04-07",
            "for": "sample string 2"
          }
        ],
        "check_out": [
          {
            "date": "2020-04-07",
            "for": "sample string 2"
          },
          {
            "date": "2020-04-07",
            "for": "sample string 2"
          }
        ],
        "not_available": [
          {
            "date": "2020-04-07",
            "for": "sample string 2"
          },
          {
            "date": "2020-04-07",
            "for": "sample string 2"
          }
        ]
      },
      "currency_code": "sample string 21",
      "updated_at": "2020-04-07T16:11:56.5506838+02:00",
      "is_active": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "latitude": 3.0,
      "longitude": 4.0,
      "address": "sample string 5",
      "zip": "sample string 6",
      "city": "sample string 7",
      "country": "sample string 8",
      "image_url": "sample string 9",
      "has_addons": true,
      "has_agreement": true,
      "agreement_text": "sample string 12",
      "agreement_url": "sample string 13",
      "contact": {
        "spoken_languages": [
          "sample string 1",
          "sample string 2"
        ]
      },
      "rating": 14.0,
      "price_unit_in_days": 15,
      "min_price": 16.0,
      "original_min_price": 17.0,
      "max_price": 18.0,
      "original_max_price": 19.0,
      "rooms": [
        {
          "id": 1,
          "name": "sample string 2"
        },
        {
          "id": 1,
          "name": "sample string 2"
        }
      ],
      "in_out_max_date": "2020-04-07",
      "in_out": {
        "is_restricted": true,
        "check_in": [
          {
            "date": "2020-04-07",
            "for": "sample string 2"
          },
          {
            "date": "2020-04-07",
            "for": "sample string 2"
          }
        ],
        "check_out": [
          {
            "date": "2020-04-07",
            "for": "sample string 2"
          },
          {
            "date": "2020-04-07",
            "for": "sample string 2"
          }
        ],
        "not_available": [
          {
            "date": "2020-04-07",
            "for": "sample string 2"
          },
          {
            "date": "2020-04-07",
            "for": "sample string 2"
          }
        ]
      },
      "currency_code": "sample string 21",
      "updated_at": "2020-04-07T16:11:56.5506838+02:00",
      "is_active": true
    }
  ]
}

v2/properties/{pid}/rooms GET

Returns all the roomtypes available for a given property

Request Information

https://api.lodgify.com/v2/properties/{pid}/rooms?wid={wid}

URI Parameters

Name	Description	Type	Additional information
pid	Property identifier	integer	Required
wid	Website Id	integer	None.

Response Information

Resource Description

Collection of properties/v2/RoomDetailsDto

Name	Type	Additional information
Images	Collection of properties/v2/DescribedImageDto	None.
Amenities	Dictionary of string [key] and Collection of properties/v2/AmenityDto [value]	None.
Description	string	None.
BreakfastIncluded	boolean	None.
HasParking	boolean	None.
AdultsOnly	boolean	None.
PetsAllowed	boolean	None.
ShowAdditionalKeyFacts	boolean	None.
Id	integer	None.
Name	string	None.
ImageUrl	string	None.
MaxPeople	integer	None.
Units	integer	None.
HasWifi	boolean	None.
HasMealPlan	boolean	None.
Bedrooms	integer	None.
Bathrooms	integer	None.
AreaUnit	string	None.
Area	decimal number	None.
MinPrice	decimal number	None.
OriginalMinPrice	decimal number	None.
MaxPrice	decimal number	None.
OriginalMaxPrice	decimal number	None.
PriceUnitInDays	integer	None.

Response Formats

application/json, text/json

[
  {
    "images": [
      {
        "text": "sample string 1",
        "url": "sample string 2"
      },
      {
        "text": "sample string 1",
        "url": "sample string 2"
      }
    ],
    "amenities": {
      "sample string 1": [
        {
          "name": "sample string 1",
          "prefix": "sample string 2",
          "bracket": "sample string 3",
          "text": "sample string 4"
        },
        {
          "name": "sample string 1",
          "prefix": "sample string 2",
          "bracket": "sample string 3",
          "text": "sample string 4"
        }
      ],
      "sample string 2": [
        {
          "name": "sample string 1",
          "prefix": "sample string 2",
          "bracket": "sample string 3",
          "text": "sample string 4"
        },
        {
          "name": "sample string 1",
          "prefix": "sample string 2",
          "bracket": "sample string 3",
          "text": "sample string 4"
        }
      ]
    },
    "description": "sample string 1",
    "breakfast_included": true,
    "has_parking": true,
    "adults_only": true,
    "pets_allowed": true,
    "show_additional_key_facts": true,
    "id": 6,
    "name": "sample string 7",
    "image_url": "sample string 8",
    "max_people": 9,
    "units": 10,
    "has_wifi": true,
    "has_meal_plan": true,
    "bedrooms": 13,
    "bathrooms": 14,
    "area_unit": "sample string 15",
    "area": 16.0,
    "min_price": 17.0,
    "original_min_price": 18.0,
    "max_price": 19.0,
    "original_max_price": 20.0,
    "price_unit_in_days": 21
  },
  {
    "images": [
      {
        "text": "sample string 1",
        "url": "sample string 2"
      },
      {
        "text": "sample string 1",
        "url": "sample string 2"
      }
    ],
    "amenities": {
      "sample string 1": [
        {
          "name": "sample string 1",
          "prefix": "sample string 2",
          "bracket": "sample string 3",
          "text": "sample string 4"
        },
        {
          "name": "sample string 1",
          "prefix": "sample string 2",
          "bracket": "sample string 3",
          "text": "sample string 4"
        }
      ],
      "sample string 2": [
        {
          "name": "sample string 1",
          "prefix": "sample string 2",
          "bracket": "sample string 3",
          "text": "sample string 4"
        },
        {
          "name": "sample string 1",
          "prefix": "sample string 2",
          "bracket": "sample string 3",
          "text": "sample string 4"
        }
      ]
    },
    "description": "sample string 1",
    "breakfast_included": true,
    "has_parking": true,
    "adults_only": true,
    "pets_allowed": true,
    "show_additional_key_facts": true,
    "id": 6,
    "name": "sample string 7",
    "image_url": "sample string 8",
    "max_people": 9,
    "units": 10,
    "has_wifi": true,
    "has_meal_plan": true,
    "bedrooms": 13,
    "bathrooms": 14,
    "area_unit": "sample string 15",
    "area": 16.0,
    "min_price": 17.0,
    "original_min_price": 18.0,
    "max_price": 19.0,
    "original_max_price": 20.0,
    "price_unit_in_days": 21
  }
]

QuoteApi

Obtain detailed quotes for a stay. An Api key is required for authentication and authorization.

v1/quote/{propertyId} GET

Obtain a quote

Request Information

https://api.lodgify.com/v1/quote/{propertyId}?arrival={arrival}&departure={departure}&roomTypes[0].Id={roomTypes[0].Id}&roomTypes[0].People={roomTypes[0].People}&roomTypes[1].Id={roomTypes[1].Id}&roomTypes[1].People={roomTypes[1].People}&addOns[0].Id={addOns[0].Id}&addOns[0].Units={addOns[0].Units}&addOns[1].Id={addOns[1].Id}&addOns[1].Units={addOns[1].Units}&promotionCode={promotionCode}

URI Parameters

Name	Description	Type	Additional information
arrival	Arrival date	date	Required
departure	Departure date	date	Required
propertyId	Property identifier	integer	Required
roomTypes	Room type details	Collection of RoomTypeParamDto	Required
addOns	Optional add-ons to include in Quote	Collection of AddOnParamDto	Required
promotionCode	Optional promotion code to apply to Quote	string	None.

Response Information

Resource Description

Returns a collection of Quotes, one per RateType, with the stay totals

Collection of QuoteDto

Name	Description	Type	Additional information
RateType	The rate type	RateTypeDto	None.
Currency	Default property currency. All values are expressed on this currency.	string	None.
Rent	Total rent for the period and all the room types	decimal number	None.
Discount	Total discount for all the room types	decimal number	None.
Fees	Fee information	Collection of FeeDto	None.
AddOns	Add-on information	Collection of AddOnDto	None.
RoomTypeQuotes	RoomType information	Collection of RoomTypeQuoteDto	None.
Taxes	Taxes applied	decimal number	None.
SecurityDeposit	Security deposit	decimal number	None.
ReservationDeposit	Reservation deposit	decimal number	None.
Total	Total booking value	decimal number	None.
Warnings	Warnings resulting from calculation	Collection of WarningDto	None.

Response Formats

application/json, text/json

[
  {
    "rate_type": {
      "name": "sample string 1"
    },
    "currency": "sample string 1",
    "rent": 2.0,
    "discount": 3.0,
    "fees": [
      {
        "type": 0,
        "name": "sample string 1",
        "value": 2.0
      },
      {
        "type": 0,
        "name": "sample string 1",
        "value": 2.0
      }
    ],
    "add_ons": [
      {
        "id": 1,
        "name": "sample string 2",
        "value": 3.0,
        "details": "sample string 4"
      },
      {
        "id": 1,
        "name": "sample string 2",
        "value": 3.0,
        "details": "sample string 4"
      }
    ],
    "room_type_quotes": [
      {
        "id": 1,
        "value": 2.0,
        "details": [
          {
            "from": "2020-04-07T16:11:56.6366398+02:00",
            "to": "2020-04-07T16:11:56.6366398+02:00",
            "prices": [
              {
                "type": "sample string 1",
                "days": 2,
                "value": 3.0,
                "is_best": true,
                "inner_price": "sample string 5"
              },
              {
                "type": "sample string 1",
                "days": 2,
                "value": 3.0,
                "is_best": true,
                "inner_price": "sample string 5"
              }
            ]
          },
          {
            "from": "2020-04-07T16:11:56.6366398+02:00",
            "to": "2020-04-07T16:11:56.6366398+02:00",
            "prices": [
              {
                "type": "sample string 1",
                "days": 2,
                "value": 3.0,
                "is_best": true,
                "inner_price": "sample string 5"
              },
              {
                "type": "sample string 1",
                "days": 2,
                "value": 3.0,
                "is_best": true,
                "inner_price": "sample string 5"
              }
            ]
          }
        ],
        "short_stay_premium": 3.0,
        "discount": {
          "description": "sample string 1",
          "value": 2.0
        }
      },
      {
        "id": 1,
        "value": 2.0,
        "details": [
          {
            "from": "2020-04-07T16:11:56.6366398+02:00",
            "to": "2020-04-07T16:11:56.6366398+02:00",
            "prices": [
              {
                "type": "sample string 1",
                "days": 2,
                "value": 3.0,
                "is_best": true,
                "inner_price": "sample string 5"
              },
              {
                "type": "sample string 1",
                "days": 2,
                "value": 3.0,
                "is_best": true,
                "inner_price": "sample string 5"
              }
            ]
          },
          {
            "from": "2020-04-07T16:11:56.6366398+02:00",
            "to": "2020-04-07T16:11:56.6366398+02:00",
            "prices": [
              {
                "type": "sample string 1",
                "days": 2,
                "value": 3.0,
                "is_best": true,
                "inner_price": "sample string 5"
              },
              {
                "type": "sample string 1",
                "days": 2,
                "value": 3.0,
                "is_best": true,
                "inner_price": "sample string 5"
              }
            ]
          }
        ],
        "short_stay_premium": 3.0,
        "discount": {
          "description": "sample string 1",
          "value": 2.0
        }
      }
    ],
    "taxes": 4.0,
    "security_deposit": 5.0,
    "reservation_deposit": 6.0,
    "total": 7.0,
    "warnings": [
      {
        "type": 666,
        "message": "sample string 1"
      },
      {
        "type": 666,
        "message": "sample string 1"
      }
    ]
  },
  {
    "rate_type": {
      "name": "sample string 1"
    },
    "currency": "sample string 1",
    "rent": 2.0,
    "discount": 3.0,
    "fees": [
      {
        "type": 0,
        "name": "sample string 1",
        "value": 2.0
      },
      {
        "type": 0,
        "name": "sample string 1",
        "value": 2.0
      }
    ],
    "add_ons": [
      {
        "id": 1,
        "name": "sample string 2",
        "value": 3.0,
        "details": "sample string 4"
      },
      {
        "id": 1,
        "name": "sample string 2",
        "value": 3.0,
        "details": "sample string 4"
      }
    ],
    "room_type_quotes": [
      {
        "id": 1,
        "value": 2.0,
        "details": [
          {
            "from": "2020-04-07T16:11:56.6366398+02:00",
            "to": "2020-04-07T16:11:56.6366398+02:00",
            "prices": [
              {
                "type": "sample string 1",
                "days": 2,
                "value": 3.0,
                "is_best": true,
                "inner_price": "sample string 5"
              },
              {
                "type": "sample string 1",
                "days": 2,
                "value": 3.0,
                "is_best": true,
                "inner_price": "sample string 5"
              }
            ]
          },
          {
            "from": "2020-04-07T16:11:56.6366398+02:00",
            "to": "2020-04-07T16:11:56.6366398+02:00",
            "prices": [
              {
                "type": "sample string 1",
                "days": 2,
                "value": 3.0,
                "is_best": true,
                "inner_price": "sample string 5"
              },
              {
                "type": "sample string 1",
                "days": 2,
                "value": 3.0,
                "is_best": true,
                "inner_price": "sample string 5"
              }
            ]
          }
        ],
        "short_stay_premium": 3.0,
        "discount": {
          "description": "sample string 1",
          "value": 2.0
        }
      },
      {
        "id": 1,
        "value": 2.0,
        "details": [
          {
            "from": "2020-04-07T16:11:56.6366398+02:00",
            "to": "2020-04-07T16:11:56.6366398+02:00",
            "prices": [
              {
                "type": "sample string 1",
                "days": 2,
                "value": 3.0,
                "is_best": true,
                "inner_price": "sample string 5"
              },
              {
                "type": "sample string 1",
                "days": 2,
                "value": 3.0,
                "is_best": true,
                "inner_price": "sample string 5"
              }
            ]
          },
          {
            "from": "2020-04-07T16:11:56.6366398+02:00",
            "to": "2020-04-07T16:11:56.6366398+02:00",
            "prices": [
              {
                "type": "sample string 1",
                "days": 2,
                "value": 3.0,
                "is_best": true,
                "inner_price": "sample string 5"
              },
              {
                "type": "sample string 1",
                "days": 2,
                "value": 3.0,
                "is_best": true,
                "inner_price": "sample string 5"
              }
            ]
          }
        ],
        "short_stay_premium": 3.0,
        "discount": {
          "description": "sample string 1",
          "value": 2.0
        }
      }
    ],
    "taxes": 4.0,
    "security_deposit": 5.0,
    "reservation_deposit": 6.0,
    "total": 7.0,
    "warnings": [
      {
        "type": 666,
        "message": "sample string 1"
      },
      {
        "type": 666,
        "message": "sample string 1"
      }
    ]
  }
]

QuoteApi_v2

Obtain detailed quotes for a stay. An Api key is required for authentication and authorization.

v2/quote/{propertyId} GET

Obtain a quote

Request Information

https://api.lodgify.com/v2/quote/{propertyId}?arrival={arrival}&departure={departure}&roomTypes[0].Id={roomTypes[0].Id}&roomTypes[0].People={roomTypes[0].People}&roomTypes[1].Id={roomTypes[1].Id}&roomTypes[1].People={roomTypes[1].People}&addOns[0].Id={addOns[0].Id}&addOns[0].Units={addOns[0].Units}&addOns[1].Id={addOns[1].Id}&addOns[1].Units={addOns[1].Units}&promotionCode={promotionCode}

URI Parameters

Name	Description	Type	Additional information
arrival	Arrival date	date	Required
departure	Departure date	date	Required
propertyId	Property identifier	integer	Required
roomTypes	Room type details	Collection of Quote.RoomTypeParamDto.v2	Required
addOns	Optional add-ons to include in Quote	Collection of Quote.AddOnParamDto.v2	Required
promotionCode	Optional promotion code to apply to Quote	string	None.

Response Information

Resource Description

Returns a collection of Quotes, one per RateType, with the stay totals

Collection of Quote.QuoteDto.v2

Name	Description	Type	Additional information
TotalIncludingVat		decimal number	None.
TotalExcludingVat		decimal number	None.
TotalVat		decimal number	None.
PropertyId		integer	None.
DateArrival		date	None.
DateDeparture		date	None.
CurrencyCode		string	None.
RoomTypes	Room types belonging to the Quote	Collection of Quote.QuoteRoomTypeDto.v2	None.
AddOns	Add-ons belonging to the Quote	Collection of Quote.QuoteAddOnDto.v2	None.
OtherItems	Other items belonging to the Quote	Collection of Quote.QuoteOtherItemDto.v2	None.
AddOnsSubtotal		decimal number	None.
RatePolicyUserId		integer	None.
ScheduledPayments		Collection of Quote.QuoteScheduledPaymentDto.v2	None.
TotalScheduledPayments		decimal number	None.
TotalToCollectManually		decimal number	None.
AmountGross		decimal number	None.
RentalAgreement		globally unique identifier	None.
CancellationPolicyText		string	None.
SecurityDepositText		string	None.
IsVerification		boolean	None.

Response Formats

application/json, text/json

[
  {
    "total_including_vat": 1.0,
    "total_excluding_vat": 1.0,
    "total_vat": 1.0,
    "property_id": 1,
    "date_arrival": "2020-04-07T16:11:56.7001246+02:00",
    "date_departure": "2020-04-07T16:11:56.7010907+02:00",
    "currency_code": "sample string 4",
    "room_types": [
      {
        "room_type_id": 1,
        "name": "sample string 2",
        "people": 3,
        "price_types": [
          {
            "type": 0,
            "is_negative": true,
            "description": "sample string 2",
            "prices": [
              {
                "uid": "sample string 1",
                "description": "sample string 2",
                "amount": 3.0,
                "fee_type": 0,
                "room_rate_type": 0
              },
              {
                "uid": "sample string 1",
                "description": "sample string 2",
                "amount": 3.0,
                "fee_type": 0,
                "room_rate_type": 0
              }
            ],
            "subtotal": 3.0
          },
          {
            "type": 0,
            "is_negative": true,
            "description": "sample string 2",
            "prices": [
              {
                "uid": "sample string 1",
                "description": "sample string 2",
                "amount": 3.0,
                "fee_type": 0,
                "room_rate_type": 0
              },
              {
                "uid": "sample string 1",
                "description": "sample string 2",
                "amount": 3.0,
                "fee_type": 0,
                "room_rate_type": 0
              }
            ],
            "subtotal": 3.0
          }
        ],
        "subtotal": 4.0
      },
      {
        "room_type_id": 1,
        "name": "sample string 2",
        "people": 3,
        "price_types": [
          {
            "type": 0,
            "is_negative": true,
            "description": "sample string 2",
            "prices": [
              {
                "uid": "sample string 1",
                "description": "sample string 2",
                "amount": 3.0,
                "fee_type": 0,
                "room_rate_type": 0
              },
              {
                "uid": "sample string 1",
                "description": "sample string 2",
                "amount": 3.0,
                "fee_type": 0,
                "room_rate_type": 0
              }
            ],
            "subtotal": 3.0
          },
          {
            "type": 0,
            "is_negative": true,
            "description": "sample string 2",
            "prices": [
              {
                "uid": "sample string 1",
                "description": "sample string 2",
                "amount": 3.0,
                "fee_type": 0,
                "room_rate_type": 0
              },
              {
                "uid": "sample string 1",
                "description": "sample string 2",
                "amount": 3.0,
                "fee_type": 0,
                "room_rate_type": 0
              }
            ],
            "subtotal": 3.0
          }
        ],
        "subtotal": 4.0
      }
    ],
    "add_ons": [
      {
        "add_on_id": 1,
        "name": "sample string 2",
        "units": 1,
        "amount": 3.0
      },
      {
        "add_on_id": 1,
        "name": "sample string 2",
        "units": 1,
        "amount": 3.0
      }
    ],
    "other_items": [
      {
        "type": "sample string 1",
        "description": "sample string 2",
        "amount": 3.0
      },
      {
        "type": "sample string 1",
        "description": "sample string 2",
        "amount": 3.0
      }
    ],
    "add_ons_subtotal": 5.0,
    "rate_policy_user_id": 1,
    "scheduled_payments": [
      {
        "date_due": "sample string 1",
        "amount": 2.0,
        "is_current": true
      },
      {
        "date_due": "sample string 1",
        "amount": 2.0,
        "is_current": true
      }
    ],
    "total_scheduled_payments": 6.0,
    "total_to_collect_manually": 7.0,
    "amount_gross": 8.0,
    "rental_agreement": "671c18cf-e86b-4a3c-91c2-3f0693b76600",
    "cancellation_policy_text": "sample string 9",
    "security_deposit_text": "sample string 10",
    "is_verification": true
  },
  {
    "total_including_vat": 1.0,
    "total_excluding_vat": 1.0,
    "total_vat": 1.0,
    "property_id": 1,
    "date_arrival": "2020-04-07T16:11:56.7001246+02:00",
    "date_departure": "2020-04-07T16:11:56.7010907+02:00",
    "currency_code": "sample string 4",
    "room_types": [
      {
        "room_type_id": 1,
        "name": "sample string 2",
        "people": 3,
        "price_types": [
          {
            "type": 0,
            "is_negative": true,
            "description": "sample string 2",
            "prices": [
              {
                "uid": "sample string 1",
                "description": "sample string 2",
                "amount": 3.0,
                "fee_type": 0,
                "room_rate_type": 0
              },
              {
                "uid": "sample string 1",
                "description": "sample string 2",
                "amount": 3.0,
                "fee_type": 0,
                "room_rate_type": 0
              }
            ],
            "subtotal": 3.0
          },
          {
            "type": 0,
            "is_negative": true,
            "description": "sample string 2",
            "prices": [
              {
                "uid": "sample string 1",
                "description": "sample string 2",
                "amount": 3.0,
                "fee_type": 0,
                "room_rate_type": 0
              },
              {
                "uid": "sample string 1",
                "description": "sample string 2",
                "amount": 3.0,
                "fee_type": 0,
                "room_rate_type": 0
              }
            ],
            "subtotal": 3.0
          }
        ],
        "subtotal": 4.0
      },
      {
        "room_type_id": 1,
        "name": "sample string 2",
        "people": 3,
        "price_types": [
          {
            "type": 0,
            "is_negative": true,
            "description": "sample string 2",
            "prices": [
              {
                "uid": "sample string 1",
                "description": "sample string 2",
                "amount": 3.0,
                "fee_type": 0,
                "room_rate_type": 0
              },
              {
                "uid": "sample string 1",
                "description": "sample string 2",
                "amount": 3.0,
                "fee_type": 0,
                "room_rate_type": 0
              }
            ],
            "subtotal": 3.0
          },
          {
            "type": 0,
            "is_negative": true,
            "description": "sample string 2",
            "prices": [
              {
                "uid": "sample string 1",
                "description": "sample string 2",
                "amount": 3.0,
                "fee_type": 0,
                "room_rate_type": 0
              },
              {
                "uid": "sample string 1",
                "description": "sample string 2",
                "amount": 3.0,
                "fee_type": 0,
                "room_rate_type": 0
              }
            ],
            "subtotal": 3.0
          }
        ],
        "subtotal": 4.0
      }
    ],
    "add_ons": [
      {
        "add_on_id": 1,
        "name": "sample string 2",
        "units": 1,
        "amount": 3.0
      },
      {
        "add_on_id": 1,
        "name": "sample string 2",
        "units": 1,
        "amount": 3.0
      }
    ],
    "other_items": [
      {
        "type": "sample string 1",
        "description": "sample string 2",
        "amount": 3.0
      },
      {
        "type": "sample string 1",
        "description": "sample string 2",
        "amount": 3.0
      }
    ],
    "add_ons_subtotal": 5.0,
    "rate_policy_user_id": 1,
    "scheduled_payments": [
      {
        "date_due": "sample string 1",
        "amount": 2.0,
        "is_current": true
      },
      {
        "date_due": "sample string 1",
        "amount": 2.0,
        "is_current": true
      }
    ],
    "total_scheduled_payments": 6.0,
    "total_to_collect_manually": 7.0,
    "amount_gross": 8.0,
    "rental_agreement": "671c18cf-e86b-4a3c-91c2-3f0693b76600",
    "cancellation_policy_text": "sample string 9",
    "security_deposit_text": "sample string 10",
    "is_verification": true
  }
]

RatesApi

v1/rates/calendar GET

Returns daily rates calendar for room types requested by roomTypeId or houseId.

Request Information

https://api.lodgify.com/v1/rates/calendar?RoomTypeId={RoomTypeId}&HouseId={HouseId}&StartDate={StartDate}&EndDate={EndDate}

URI Parameters

Name	Type	Additional information
RoomTypeId	integer	Required
HouseId	integer	Required
StartDate	Date	Required
EndDate	Date	Required

Response Information

Resource Description

Collection of CalendarResponseItem

Name	Type	Additional information
Date	Date	None.
IsDefault	boolean	None.
Prices	Collection of CalendarPrice	None.

Response Formats

application/json, text/json

Sample not available.

v1/rates/savewithoutavailability POST

Replaces the selected rates for specific room types with the new items and fills them with availability information. To be used by 3rd party services that do not support availability information.

Request Information

https://api.lodgify.com/v1/rates/savewithoutavailability

Body Parameters

TinyRateDto

Name	Type	Additional information
PropertyId	integer	None.
RoomTypeId	integer	None.
Rates	Collection of RangedRateModel	None.

Request Formats

application/json, text/json

{
  "property_id": 1,
  "room_type_id": 2,
  "rates": [
    {
      "is_default": true,
      "start_date": "0001-01-01T00:00:00",
      "end_date": "0001-01-01T00:00:00",
      "price_per_day": 100.0,
      "min_stay": 1,
      "max_stay": 6,
      "price_per_additional_guest": 20.0,
      "additional_guests_starts_from": 3
    },
    {
      "is_default": true,
      "start_date": "0001-01-01T00:00:00",
      "end_date": "0001-01-01T00:00:00",
      "price_per_day": 100.0,
      "min_stay": 7,
      "max_stay": 29,
      "price_per_additional_guest": 20.0,
      "additional_guests_starts_from": 3
    },
    {
      "is_default": true,
      "start_date": "0001-01-01T00:00:00",
      "end_date": "0001-01-01T00:00:00",
      "price_per_day": 100.0,
      "min_stay": 30,
      "max_stay": 0,
      "price_per_additional_guest": 20.0,
      "additional_guests_starts_from": 3
    },
    {
      "is_default": false,
      "start_date": "2020-04-07T00:00:00+02:00",
      "end_date": "2020-04-10T00:00:00+02:00",
      "price_per_day": 100.0,
      "min_stay": 1,
      "max_stay": 6,
      "price_per_additional_guest": 20.0,
      "additional_guests_starts_from": 3
    },
    {
      "is_default": false,
      "start_date": "2020-04-07T00:00:00+02:00",
      "end_date": "2020-04-10T00:00:00+02:00",
      "price_per_day": 100.0,
      "min_stay": 7,
      "max_stay": 29,
      "price_per_additional_guest": 20.0,
      "additional_guests_starts_from": 3
    },
    {
      "is_default": false,
      "start_date": "2020-04-07T00:00:00+02:00",
      "end_date": "2020-04-10T00:00:00+02:00",
      "price_per_day": 100.0,
      "min_stay": 30,
      "max_stay": 0,
      "price_per_additional_guest": 20.0,
      "additional_guests_starts_from": 3
    }
  ]
}

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

true

WebhooksApi

All the calls to interact with our Webhooks, including subscribe and unsubscribe. An Api key is required for authentication and authorization Our webhooks work the following way: we provide two main api calls, subscribe and unsubscribe. This allows you to connect to one of our webhooks, passing the event you want to connect to and a unique callback URL we will post to when the event occur in our system. You can connect to the same event multiple times. The events we provide right now are rate change, and availability change. Check the subscribe call description in this docs for more info. Additionally we provide pooling calls you can use to get an example of the data we send in our webhooks.

webhooks/v1/pooling/availability-change GET

Return an example of the JSon object we will send when we trigger this webhook

Request Information

https://api.lodgify.com/webhooks/v1/pooling/availability-change

Response Information

Resource Description

Collection of Object

None.

Response Formats

application/json, text/json

Sample not available.

webhooks/v1/pooling/rate-change GET

Return an example of the JSon object we will send when we trigger this webhook

Request Information

https://api.lodgify.com/webhooks/v1/pooling/rate-change

Response Information

Resource Description

Collection of Object

None.

Response Formats

application/json, text/json

Sample not available.

webhooks/v1/subscribe POST

Subscribe to a Lodgify Webhook.

Request Information

https://api.lodgify.com/webhooks/v1/subscribe

Body Parameters

SubscribeBindingModel

Name	Description	Type	Additional information
TargetUrl	The call-back URL we will call when the event is triggered in our system. This have to be unique each time. If it is not unique, we will return a 409 http status code	string	None.
Event	The event you are subscribing to. You can subscribe multiple times to the same Event, and we will call all the unique TargetUrl for this event when it triggers in our system. This is a case sensitive string. The events available are: 'rate_change', 'availability_change'	string	None.

Request Formats

application/json, text/json

{
  "target_url": "sample string 1",
  "event": "sample string 2"
}

Response Information

Resource Description

On success we return a 200 status code with additional data

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample not available.

webhooks/v1/unsubscribe DELETE

Unsubscribe from a Lodgify webhook

Request Information

https://api.lodgify.com/webhooks/v1/unsubscribe

Body Parameters

UnsubscribeBindingModel

Name	Description	Type	Additional information
Id	The Id of the webhook you want to delete. It is the same we returned when you subscribed to this webhook	string	None.

Request Formats

application/json, text/json

{
  "id": "sample string 1"
}

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample not available.

Annex: Useful Tables

Error Codes

Code	Name	Description
666	Unknown
901	NoRateDefined
902	MinStayRequired
903	BookingStatusUnknown
904	BookingMessageTypeNotAllowed
905	BookingNoRooms
906	BookingCannotChangeStatus
907	EnquiryAlreadyUpgraded
908	BookingPaymentNotValid
909	ArrivalNotValid
910	DepartureNotValid
911	PropertyNotAvailable
920	CaptchaInvalid
930	StripeError
940	ValidationError
950	PaymentError
996	ArgumentError
997	NotFound
998	NotImplemented
999	NotAuthorized

Timezones Table

Name	Id
(UTC-12:00) International Date Line West	Dateline Standard Time
(UTC-11:00) Coordinated Universal Time-11	UTC-11
(UTC-10:00) Aleutian Islands	Aleutian Standard Time
(UTC-10:00) Hawaii	Hawaiian Standard Time
(UTC-09:30) Marquesas Islands	Marquesas Standard Time
(UTC-09:00) Alaska	Alaskan Standard Time
(UTC-09:00) Coordinated Universal Time-09	UTC-09
(UTC-08:00) Baja California	Pacific Standard Time (Mexico)
(UTC-08:00) Coordinated Universal Time-08	UTC-08
(UTC-08:00) Pacific Time (US & Canada)	Pacific Standard Time
(UTC-07:00) Arizona	US Mountain Standard Time
(UTC-07:00) Chihuahua, La Paz, Mazatlan	Mountain Standard Time (Mexico)
(UTC-07:00) Mountain Time (US & Canada)	Mountain Standard Time
(UTC-06:00) Central America	Central America Standard Time
(UTC-06:00) Central Time (US & Canada)	Central Standard Time
(UTC-06:00) Easter Island	Easter Island Standard Time
(UTC-06:00) Guadalajara, Mexico City, Monterrey	Central Standard Time (Mexico)
(UTC-06:00) Saskatchewan	Canada Central Standard Time
(UTC-05:00) Bogota, Lima, Quito, Rio Branco	SA Pacific Standard Time
(UTC-05:00) Chetumal	Eastern Standard Time (Mexico)
(UTC-05:00) Eastern Time (US & Canada)	Eastern Standard Time
(UTC-05:00) Haiti	Haiti Standard Time
(UTC-05:00) Havana	Cuba Standard Time
(UTC-05:00) Indiana (East)	US Eastern Standard Time
(UTC-05:00) Turks and Caicos	Turks And Caicos Standard Time
(UTC-04:00) Asuncion	Paraguay Standard Time
(UTC-04:00) Atlantic Time (Canada)	Atlantic Standard Time
(UTC-04:00) Caracas	Venezuela Standard Time
(UTC-04:00) Cuiaba	Central Brazilian Standard Time
(UTC-04:00) Georgetown, La Paz, Manaus, San Juan	SA Western Standard Time
(UTC-04:00) Santiago	Pacific SA Standard Time
(UTC-03:30) Newfoundland	Newfoundland Standard Time
(UTC-03:00) Araguaina	Tocantins Standard Time
(UTC-03:00) Brasilia	E. South America Standard Time
(UTC-03:00) Cayenne, Fortaleza	SA Eastern Standard Time
(UTC-03:00) City of Buenos Aires	Argentina Standard Time
(UTC-03:00) Greenland	Greenland Standard Time
(UTC-03:00) Montevideo	Montevideo Standard Time
(UTC-03:00) Punta Arenas	Magallanes Standard Time
(UTC-03:00) Saint Pierre and Miquelon	Saint Pierre Standard Time
(UTC-03:00) Salvador	Bahia Standard Time
(UTC-02:00) Coordinated Universal Time-02	UTC-02
(UTC-02:00) Mid-Atlantic - Old	Mid-Atlantic Standard Time
(UTC-01:00) Azores	Azores Standard Time
(UTC-01:00) Cabo Verde Is.	Cape Verde Standard Time
(UTC) Coordinated Universal Time	UTC
(UTC+00:00) Dublin, Edinburgh, Lisbon, London	GMT Standard Time
(UTC+00:00) Monrovia, Reykjavik	Greenwich Standard Time
(UTC+00:00) Sao Tome	Sao Tome Standard Time
(UTC+01:00) Casablanca	Morocco Standard Time
(UTC+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna	W. Europe Standard Time
(UTC+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague	Central Europe Standard Time
(UTC+01:00) Brussels, Copenhagen, Madrid, Paris	Romance Standard Time
(UTC+01:00) Sarajevo, Skopje, Warsaw, Zagreb	Central European Standard Time
(UTC+01:00) West Central Africa	W. Central Africa Standard Time
(UTC+02:00) Amman	Jordan Standard Time
(UTC+02:00) Athens, Bucharest	GTB Standard Time
(UTC+02:00) Beirut	Middle East Standard Time
(UTC+02:00) Cairo	Egypt Standard Time
(UTC+02:00) Chisinau	E. Europe Standard Time
(UTC+02:00) Damascus	Syria Standard Time
(UTC+02:00) Gaza, Hebron	West Bank Standard Time
(UTC+02:00) Harare, Pretoria	South Africa Standard Time
(UTC+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius	FLE Standard Time
(UTC+02:00) Jerusalem	Israel Standard Time
(UTC+02:00) Kaliningrad	Kaliningrad Standard Time
(UTC+02:00) Khartoum	Sudan Standard Time
(UTC+02:00) Tripoli	Libya Standard Time
(UTC+02:00) Windhoek	Namibia Standard Time
(UTC+03:00) Baghdad	Arabic Standard Time
(UTC+03:00) Istanbul	Turkey Standard Time
(UTC+03:00) Kuwait, Riyadh	Arab Standard Time
(UTC+03:00) Minsk	Belarus Standard Time
(UTC+03:00) Moscow, St. Petersburg	Russian Standard Time
(UTC+03:00) Nairobi	E. Africa Standard Time
(UTC+03:30) Tehran	Iran Standard Time
(UTC+04:00) Abu Dhabi, Muscat	Arabian Standard Time
(UTC+04:00) Astrakhan, Ulyanovsk	Astrakhan Standard Time
(UTC+04:00) Baku	Azerbaijan Standard Time
(UTC+04:00) Izhevsk, Samara	Russia Time Zone 3
(UTC+04:00) Port Louis	Mauritius Standard Time
(UTC+04:00) Saratov	Saratov Standard Time
(UTC+04:00) Tbilisi	Georgian Standard Time
(UTC+04:00) Volgograd	Volgograd Standard Time
(UTC+04:00) Yerevan	Caucasus Standard Time
(UTC+04:30) Kabul	Afghanistan Standard Time
(UTC+05:00) Ashgabat, Tashkent	West Asia Standard Time
(UTC+05:00) Ekaterinburg	Ekaterinburg Standard Time
(UTC+05:00) Islamabad, Karachi	Pakistan Standard Time
(UTC+05:00) Qyzylorda	Qyzylorda Standard Time
(UTC+05:30) Chennai, Kolkata, Mumbai, New Delhi	India Standard Time
(UTC+05:30) Sri Jayawardenepura	Sri Lanka Standard Time
(UTC+05:45) Kathmandu	Nepal Standard Time
(UTC+06:00) Astana	Central Asia Standard Time
(UTC+06:00) Dhaka	Bangladesh Standard Time
(UTC+06:00) Omsk	Omsk Standard Time
(UTC+06:30) Yangon (Rangoon)	Myanmar Standard Time
(UTC+07:00) Bangkok, Hanoi, Jakarta	SE Asia Standard Time
(UTC+07:00) Barnaul, Gorno-Altaysk	Altai Standard Time
(UTC+07:00) Hovd	W. Mongolia Standard Time
(UTC+07:00) Krasnoyarsk	North Asia Standard Time
(UTC+07:00) Novosibirsk	N. Central Asia Standard Time
(UTC+07:00) Tomsk	Tomsk Standard Time
(UTC+08:00) Beijing, Chongqing, Hong Kong, Urumqi	China Standard Time
(UTC+08:00) Irkutsk	North Asia East Standard Time
(UTC+08:00) Kuala Lumpur, Singapore	Singapore Standard Time
(UTC+08:00) Perth	W. Australia Standard Time
(UTC+08:00) Taipei	Taipei Standard Time
(UTC+08:00) Ulaanbaatar	Ulaanbaatar Standard Time
(UTC+08:45) Eucla	Aus Central W. Standard Time
(UTC+09:00) Chita	Transbaikal Standard Time
(UTC+09:00) Osaka, Sapporo, Tokyo	Tokyo Standard Time
(UTC+09:00) Pyongyang	North Korea Standard Time
(UTC+09:00) Seoul	Korea Standard Time
(UTC+09:00) Yakutsk	Yakutsk Standard Time
(UTC+09:30) Adelaide	Cen. Australia Standard Time
(UTC+09:30) Darwin	AUS Central Standard Time
(UTC+10:00) Brisbane	E. Australia Standard Time
(UTC+10:00) Canberra, Melbourne, Sydney	AUS Eastern Standard Time
(UTC+10:00) Guam, Port Moresby	West Pacific Standard Time
(UTC+10:00) Hobart	Tasmania Standard Time
(UTC+10:00) Vladivostok	Vladivostok Standard Time
(UTC+10:30) Lord Howe Island	Lord Howe Standard Time
(UTC+11:00) Bougainville Island	Bougainville Standard Time
(UTC+11:00) Chokurdakh	Russia Time Zone 10
(UTC+11:00) Magadan	Magadan Standard Time
(UTC+11:00) Norfolk Island	Norfolk Standard Time
(UTC+11:00) Sakhalin	Sakhalin Standard Time
(UTC+11:00) Solomon Is., New Caledonia	Central Pacific Standard Time
(UTC+12:00) Anadyr, Petropavlovsk-Kamchatsky	Russia Time Zone 11
(UTC+12:00) Auckland, Wellington	New Zealand Standard Time
(UTC+12:00) Coordinated Universal Time+12	UTC+12
(UTC+12:00) Fiji	Fiji Standard Time
(UTC+12:00) Petropavlovsk-Kamchatsky - Old	Kamchatka Standard Time
(UTC+12:45) Chatham Islands	Chatham Islands Standard Time
(UTC+13:00) Coordinated Universal Time+13	UTC+13
(UTC+13:00) Nuku'alofa	Tonga Standard Time
(UTC+13:00) Samoa	Samoa Standard Time
(UTC+14:00) Kiritimati Island	Line Islands Standard Time