Lodgify API Documentation

Instructions:

• Document will have portal, plugin settings, each, and everything to setup
• The basic setup instructions for each PMS, any settings to amend in the portal, what is pulled, what can be changed, any maintenance, etc.
• In a word format and tom can then create it on site as a docs
• We might need to use screenshots as well

Index:

• Introduction
• Portal 

• Add Listings 
• Add Calendar / Availability
• Add Reservations
• Cancel Reservations

• API Integration

• Credentials Required 
• Endpoints 
  • All listings 
  • Single listing 
  • Reservations (Create/Cancel) 
  • Prices (Extra guest fee, daily price, Taxes, Discounts)
  • Availability (Min stay, Available)
• Missing Endpoints
• Manual sync all or single listing
• Auto Sync settings

• Website Settings

• Plugin Settings 
  • Overriding 
  • Cronjobs (Enable/Disable)

• Customization 

• Auto Registration 
  • Path of files for custom code.

• Gateways

• Stripe

• Options on theme settings
• Path of files for custom code.

• Code

• Child Theme.
• API Plugin.

1. Introduction 

Lodgify API

Lodgify is a vacation rental software with an all-in-one solution that allows owners and property managers to easily create their own vacation rental website and accept online bookings. Owners can manage all reservations from one place and synchronize property data with their booking channels. Whether you own a single vacation rental or manage 500+ vacation properties, Lodgify has the right tools for you to increase your online bookings and simplify the management of your business.

2. Portal 

Add Listings

Add Calendar / Availability

Add Reservations

Cancel Reservations

API Token can be acquired by following these things :- 

3. API Integration 

Credentials Required

1. API Token

API Token is required for getting response of all requests.

Endpoints

API Doc: https://docs.lodgify.com/docs

1. GET Listings 

https://api.lodgify.com/v2/properties

1. GET Single Listing 

https://api.lodgify.com/v2/properties/id

1. GET Amenities

https://api.lodgify.com/v2/properties/id/rooms/rid

1. GET Availability

https://api.lodgify.com/v2/availability/propertyId

1. GET Prices

https://api.lodgify.com/v2/rates/calendar?RoomTypeId='roomId'&HouseId='propertyId'&StartDate=&EndDate=

1. Create Reservation

https://api.lodgify.com/v2/reservation/booking

Missing data

1. No cancel reservation endpoint
2. No Property Type

Manual sync options 

1. All Data sync 

1. Single listing sync (Go single listing edit page)

Auto Sync Settings

1. Plugin Setting page (Go to Listings > Settings)
2. View existing auto schedules 
3. Can enable/Disable each auto sync by clicking checkbox under Action Column. 

4. Website Settings

Plugin Settings

1. Plugin Setting page (Go to Listings > Settings)
2. Enter required API credentials 

1. Override options
2. You can enable / disable override settings for API data.

1. Can view and enable/disable Auto Syncs. 

5. Customization

Auto Registration

Changes for auto registrations module are in following files. 

1. homey-child\template-parts\boostly-modal-register.php
2. homey-child\template-parts\instance-booking\nightly.php
3. plugin\lodgify\assets\js\ lodgify.js
4. plugin\ lodgify \ lodgify.php

6. Gateways

Stripe 

Changes regarding stripe to Lodgify reservation are in the following files.

1. theme\homey-child\template-parts\instance-booking\nightly.php
2. plugin\ lodgify \ lodgify.php
3. plugin\ lodgify \assets\js\ lodgify.js
4. plugin\ lodgify \classes\class-stripe.php

Homey theme settings to enable / disable Stripe gateway

7. Code

Child Theme

Path: theme\homey-child

API Plugin

Path: plugin\lodgify