Lodgix offers an open RESTful API that can be used by developers for custom integrations with our software.

As of October 7th, 2020, the REST API is in Beta. Changes / fixes are occurring as additional testing and beta user feedback is completed.

The specifications for the REST API are located here:

https://www.lodgix.com/public-api/v2/documentation/

Note: While the API is in Beta you will need to be logged into Lodgix to be able to view the API specs. You can create a free trial account or you can ask your client to create an account for you within their subscription.

API Key / Token

The API will require a key that only the Lodgix subscriber can provide. It is found on this page:

https://www.lodgix.com/app/isettings/general/

FAQ

Does the REST API support pagination?

Yes the REST API supports pagination by using "offset" and "limit": https://www.lodgix.com/public-api/v2/documentation/#operation/List%20all%20properties

Are there rate limits?

Currently there is 3 request per second and a maximum limit of 50 items per request.

Does Lodgix offer webhooks to notify my site that a change has been made on Lodgix?

Currently we don't offer webhooks. Users should poll the properties endpoint regularly to check the "modified" field.

What would a checkout process look like using the REST API?

1. Read availability (which is not pure REST, but we offer it). Alternative would be to fetch properties, reservations, blocks, rules, etc and calculate your own availability -however that would be prone to errors.

2. Calculate a Quote for selected dates and number of guests: https://www.lodgix.com/public-api/v2/documentation/#operation/Calculate%20quote


3. Create a Guest (if guest doesn't exist) - https://www.lodgix.com/public-api/v2/documentation/#operation/Create%20a%20guest

4. Create a Reservation with that Guest and selected dates - https://www.lodgix.com/public-api/v2/documentation/#operation/Create%20a%20reservation

Thus the basics of a checkout can be achieved with the current API. Probably there will be a few things missing as we did not implement every possible field due to time constraints.

Some items are not planned for inclusion in our api, one of which is accepting credit card data. However there are alternatives. You could, for example, deal with the payment gateway itself, store the guest credit card data on their gateway and send us Stripe or Auth.Net tokens. Or we could implement a Payment Request endpoint.

Did this answer your question?