Uplisting 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 Uplisting 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 Uplisting 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 Uplisting 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 Uplisting account.
Gallery Images (API)
All of your listing image galleries (on single listing pages) will be synced directly from your listing gallery in your Uplisting account.
Property Type (API)
The property type of your listings will sync directly from your Uplisting account.
Rates (API)
Any rates or price changes for your listings will be synced directly with your Boostly website from your Uplisting account.
Additional Guests + Rate (Manual)
Your Boostly website does not allow for a direct sync for additional guests and rates using Uplisting API. This information can be added to your website manually if you require it, and will require you to add this information to new listings you add later. Alternatively, this area on the listing pages can be removed and/or hidden if not required.
Cleaning Fees (API)
Any cleaning feels applied to listings will be synced directly with your Boostly website from your Uplisting account.
Taxes (API)
Any taxes applied to listings will be synced directly with your Boostly website from your Uplisting account.
Availability (API)
Your listing availability will sync directly with your Boostly website from your Uplisting 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 Uplisting account. This endpoint is based on the google map location you have submitted in your Uplisting 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 Uplisting account per listing.
Amenities (API)
A selection of the most referenced amenities will sync directly from your Uplisting account.
Check-in Time (API)
Check-in times will be synced directly with your Boostly website from your Uplisting account.
Booking URL (Portal Booking)
The Uplisting portal booking is available as some short code from your account. On some occasions, you may wish to use this for some added functionality.
Currency (API)
All currency information is synced directly with your Uplisting 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 Uplisting account.
Registration Process (Portal)
If you require to add a registration process to your Boostly website, this can be implemented using the Uplisting portal. We can have this added to your Boostly website as a direct link straight over to access the portal.
Coupon (API)
Any coupon codes you will have implemented in your Uplisting account can be used at the check-out page.
Markup (API)
Any markup pricing added to your listings will automatically apply at 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 Uplisting account.
Changeover (API)
The check-in and check-out changeover will automatically be synced from your Uplisting account using our API, based on your listing's calendar.