Supercontrol 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 Supercontrol 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 Supercontrol account for representation on your Boostly website.
Alternatively, the use of a PMS widget allows for some extra functionality and content population if required. This information can be added to your website manually if needed and will require you to manually manage this information on new listings you add later. If not required, some of these items on the listing pages can be removed and/or hidden if not required.
Description (API)
The property description will sync directly from your Supercontrol 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 Supercontrol account.
Gallery Images (API)
All of your listing image galleries (on single listing pages) will be synced directly from your listing gallery in your Supercontrol account.
Property Type (API)
The property type of your listings will sync directly from your Supercontrol account.
Rates (Booking Widget)
Any rate changes for your listings will not be synced directly with your Boostly website from your Supercontrol account and will need to be managed manually. Alternatively, we can use the Supercontrol booking widget on listing pages to showcase rate information.
Additional Guests + Rate (Booking Widget)
Any additional guest amounts and rates will not be synced directly with your Boostly website from your Supercontrol account and will need to be managed manually. Alternatively, we can use the Supercontrol booking widget on listing pages to showcase rate information.
Cleaning Fees (Booking Widget)
Any cleaning feels applied to listings will not be synced directly with your Boostly website from your Supercontrol account and will need to be managed manually. Alternatively, we can use the Supercontrol booking widget on listing pages to showcase rate information.
Taxes (Booking Widget)
Any taxes applied to listings will not be synced directly with your Boostly website from your Supercontrol account and will need to be managed manually. Alternatively, we can use the Supercontrol booking widget on listing pages to showcase rate information.
Availability (API)
Your listing availability will sync directly with your Boostly website from your Supercontrol 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 Supercontrol account. This endpoint is based on the google map location you have submitted in your Supercontrol 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 Supercontrol account per listing.
Amenities (API)
A selection of the most referenced amenities will sync directly from your Supercontrol account.
Check-in Time (API)
Check-in times will not be synced directly from your Supercontrol account and will need to be manually managed on each listing.
Booking URL (PMS Widget)
Possible bookers will be able to complete an on-site checkout for any booking on your Boostly website using your embedded Supercontrol booking widget.
Currency (API)
All currency information is synced directly with your Supercontrol 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 Supercontrol 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 (Booking Widget)
Any coupon codes you will have implemented in your Supercontrol account can be used at the check-out page when using the Supercontrol booking widget.
Markup (Booking Widget)
Any markup pricing you will have implemented in your Supercontrol account can be used at the check-out page when using the Supercontrol booking widget.
Changeover (Booking Widget)
The check-in and check-out changeover you will have implemented in your Supercontrol account can be represented on your Boostly website using the Supercontrol booking widget.