OwnerRez 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 

OwnerRez API

OwnerRez is a comprehensive booking management engine, built by people who have vacation rentals of their own. It integrates with channels like Vrbo, AirBnb, and Booking.com to seamlessly synchronize availability, rates, rules and listing content while taking online bookings, managing inquiries, and communicating with guests. OwnerRez provides modern fast websites, guest checkout with e-sign renter agreements and can process payments directly, including auto-scheduled future payments.

2. Portal 

Add Listings

Add Calendar / Availability

Add Reservations

Cancel Reservations

Booking Widget:

Username and Password can get from here:-

3. API Integration 

Credentials Required

1. User ID
2. Username
3. Password

Username and password are required for getting response of all requests.

Endpoints

API Doc: https://secure.ownerreservations.com/help?version=api

https://secure.ownerreservations.com/help?version=bpapi

1. GET Owner / User ID

https://secure.ownerreservations.com/help/api/get-api-users-me

1. GET Listings 

https://secure.ownerreservations.com/bpapi/feeds/listings?userId={userId}&since={since}

1. GET Single Listing 

https://secure.ownerreservations.com/bpapi/properties/property_id

1. GET Amenities

https://secure.ownerreservations.com/bpapi/listings/{id}/summary?includeAmenities={includeAmenities}

1. GET Prices

https://secure.ownerreservations.com/bpapi/listings/{id}/pricing?start={start}&end={end}&includePricingRules={includePricingRules}

1. GET Availability

https://secure.ownerreservations.com/bpapi/listings/{id}/availability?start={start}&end={end}

Missing data

1. No create reservation endpoint although booking is made through widget
2. No  cancel reservation endpoint

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\owner-rez\assets\js\owner-rez.js
4. plugin\owner-rez\owner-rez.php

6. Gateways

Stripe 

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

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

Homey theme settings to enable / disable Stripe gateway

7. Code

Child Theme

Path: theme\homey-child

API Plugin

Path: plugin\owner-rez