Hostaway API Checklist

This document will outline the items available with our API sync on a Boostly website.

API is the 2-way interface between your website that allows for accurate information to pass directly between your website and Hostaway account. You will not be required to manage these items from your website. Any item that is a direct API sync should be managed from your Hostaway account for representation on your Boostly website.

Below you’ll find the general key items that would be represented on site by API endpoints. If any item is noted as Manual, these will be manually managed content on your Boostly website using WordPress.

Description (API)

The property description will sync directly from your Hostaway account, and onto the Boostly website per listing page.

Featured Image (API)

The featured image on both the map location screen and highlighted properties will sync from the first image in your Hostaway account.

Gallery Images (API)

All of your listing image galleries (on single listing pages) will be synced directly from your listing gallery in your Hostully account.

Property Type (API)

The property type of your listings will sync directly from your Hostaway account.

Rates (API)

Any rates or price changes for your listings will be synced directly with your Boostly website from your Hostaway account.

Additional Guests + Rate (API)

Any additional guest amounts and rates will be synced directly with your Boostly website from your Hostaway account.

Cleaning Fees (API)

Any cleaning feels applied to listings will be synced directly with your Boostly website from your Hostaway account.

Taxes (Manual)

Any taxes applied to listings in your Hostaway account cannot currently be synced to your Boostly website with API. You will be required to add tax information manually when adding new listings. Once a listing is added to your Hostaway account and synced to your Boostly website, you’ll then need to add any tax rate to a listing manually in the WordPress backend. We’ll provide guidance on this separately.

Availability (API)

Your listing availability will sync directly with your Boostly website from your Hostaway account per listing. It will also account for any min/max stays you have implemented.

Location (API)

The location of each property will sync directly with your Hostaway account. This endpoint is based on the google map location you have submitted in your Hostaway account at listing level. As the locations are based on a google map address, ensure that the address is correct.

Guests/Bedrooms (API)

The number of guests and bedroom amount will sync directly from your Hostaway account per listing.

Amenities (API)

A selection of the most referenced amenities will sync directly from your Hostaway account.

Check-in Time (API)

Check-in times will be synced directly with your Boostly website from your Hostaway account.

On-site Checkout

Possible bookers will be able to complete an on-site checkout for any booking on your Boostly website. All booking information is then transferred from the website to your Hostaway account after payment is completed.

Currency (API)

All currency information is synced directly with your Hostaway account. The set currency will then be replicated on your Boostly website. We can also add a multi-currency widget feature on your Boostly website. Note this will only work as intended if using one main currency type from your Hostaway account.

Registration Process (API)

Upon checkout, any possible booker submitting their email for payment confirmation will automatically be registered on your Boostly website. If you decide to have a login area for bookers their stay information will be held on-site for them to reference later.

Coupon (API)

Any coupon codes you will have implemented in your Hostaway account can be used at the check-out page.

Markup (API)

Any markup pricing added to your listings will automatically apply as the listing level and at booking. You will not need to manage this on-site as this is automatically synced with our API from your Hostaway account.

Changeover (API)

The check-in and check-out changeover will automatically be synced from your Hostaway account using our API, based on your listing's calendar.