Rentopian Sync is compatible with any WordPress theme that supports WooCommerce.
The sync plugin serves two main purposes: enabling synchronization of your Rentopian system data with your company's storefront (website) and allowing your website visitors to browse your inventory and place orders and quotes.
This documentation covers all the aspects of the usage of Rentopian Sync plugin. Should you have any questions not covered here, please email us at [email protected]
If you are using direct checkout option of the plugin, the payments will be processed via
Wordpress website. To enable such functionality, an additional plugin must be installed
depending on the third party payment processing provider you are using.
Following is
the list of providers supported by Rentopian system:
Payment Gateway | Plugin URL | Notes |
---|---|---|
|
Plugin Website | WooCommerce supports Stripe out of the box so it has the easiest installation process. |
|
Plugin Website | |
|
Plugin Website | |
|
Plugin Website | Depending on your requirements, there are paid alternatives that offer more advanced functionality. Check WooSquare PRO ($79) and WooCommerce Square Up ($29). |
![]() |
Plugin Website | Depending on your requirements, there is a paid version that offers more advanced functionality. Check PRO & Enterprise versions. |
Install and Activate the plugin through the 'Plugins' → Add new section in WordPress,
by selecting the rentopian-sync.zip archive which can be
downloaded here.
Important
If WooCommerce plugin is not installed and activated, the plugin will not
show in admin panel and a notification about requirement to install WooCommerce will
appear on all of your WordPress admin pages.
Once the plugin is installed and activated, go to “Rentopian Sync” page in your Wordpress admin panel. There are three main sections:
The most important part after successful plugin installation is synchronizing your website with Rentopian system. Before proceeding with synchronization, some preparations must be made system-side:
The import process may take a few minutes depending on your inventory size. Once it’s 100% imported you will receive a notification about successful completion of the process.
This section includes the options that define how the products are displayed and how the orders are placed.
There are 2 options:
In some scenarios it is more convenient to allow the visitor to select the products
without specifying dates and require to select a date only on the checkout page.
This option works only if overbooks are allowed.
If enabled, a transparent white layer will appear on the checkout page with dates selection form on top. The user will be able to continue with the checkout process only once the dates are set.
The visitors can add items to cart and checkout directly, without sending a quote first. The orders and the payment information will appear on the Rentopian system once the order is placed. Please make sure you use a payment processing provider supported by Rentopian. This will provide guaranteed compatibility with the Rentopian system.
Allows the website visitors to pay the deposit only, instead of the total sum. The "Allow Direct Bookings" option must be enabled for this option to work. Has 2 sub-options:
This setting requires an existing deposit entry set as default in the Rentopian system, it can
be set here.
Once set, a block will appear on the checkout page, right before the checkout button,
prompting to select deposit.
Check the screenshot below for an example with "Any amount from deposit sum to order total sum is allowed."
option selected.
Adds the amount of default security deposit set in Rentopian to the order total, in a separate line:
Send the quote or order email via Rentopian, with corresponding formatting. Note that this is only about emailing via Rentopian system, if you would like to enable / disable the emails sent by WordPress, it can be done via Woocommerce → Settings → Emails section in your WP admin panel.
If the direct booking is enabled, this option allows setting a minimum total sum of the order to be able to place an order via website. If the minimum is not met, the visitor will be able to place a quote instead. Once enabled, 2 sub-options will appear:
There is an option in Settings => Occasions / Referral Sources section of Rentopian, allowing you to add
a list of referral sources and later select the source when creating a quote / order via the system.
You can show the same list on your website, by enabling this option. A select box will appear on the checkout
page, suggesting the customer to specify a referral source. The label of this field can be changed via
"Textual Labels" tab of the plugin, check for the field called "Referral Sources" alternative text.
It is possible to blacklist a client through the Rentopian system. Whenever a quote or order is placed through the website, the plugin checks if the phone number and / or email of the customer match with the email / phone number of any blacklisted client. If that's the case, the customer will not be able to checkout and a predefined message will be displayed when trying to place an order (e.g. Sorry, there was a problem with your order and we could not process it).
Set a custom message to display to the customers who have been blacklisted.
In some cases products are rented for predefined period and only the start date is required.
This option allows hiding the return date.
There are some options that will not work correctly if the return dates are hidden. Below is a list of
conflicting options:
If selected, the calendar will only prompt to enter the start and end days, hiding the time fields.
If your company has only one location in Rentopian system and you do not use mileage based delivery option, you can hide the ZIP code. This will eliminate the requirement for your website visitors to enter their ZIP code to be able to rent products.
Displays a field on checkout section, prompting to enter the event start time:
Blocks the ability to put orders for specified number of days starting from today. Useful when you need some buffer time to be able to fulfill the orders.
Defines the minimum duration for rentals, in days.
For example, photo cameras are
commonly rented out on a weekly basis (minimum 1 week) and beds are rented out on monthly
basis (30 days minimum).
Defines the maximum duration for rentals, in days. For example, you might want to rent out any product for no longer than 14 days. In this case, "14" must be set in this field.
Restricts renting of products to specific intervals. For example, a 4 days interval means the item
with rental start date of Sept 1, can be rented for Sep 1-5, or 1-9 but not 1-7.
Below is an example of a fly-in form with select date range enabled and fixed rental interval set to 3 days:
Note that this option has the following conflicts with other options:
If the "Fixed Rental Interval" is selected, this option can be enabled and then
a single date picker will be shown instead of date range picker along with a
dropdown with duration options. For example if, "Fixed Rental Interval" is set to 5 days
and this option is enabled, the user will be able to select the start date and then
select the duration from the dropdown below that has pre=populated values, e.g. 5 days, 10 days,
15 days, etc...
Below is an example of a horizontal booking form with select date range enabled:
Blocks the ability to put an order that starts on the day(s) of week specified here. For example,
you can set here an option for customers to be able to place orders only for Tuesday, Wednesday and Saturday.
Note that this option will not work correctly if Minimum range (in days), Maximum range (in days),
Fixed interval (in days) options are set at the same time.
If enabled, a "Location" field will appear in the booking form for customers to be able to enter
their full delivery address right away, without reaching the checkout page.
This works with google
address autocomplete so you will need to retrieve a Google API key
and paste it into the field "Google Map API Key" that will appear right below the "Show Delivery Address Input"
checkbox, once it is enabled.
Below is an example of horizontal booking form with this setting enabled:
The Google's address autocomplete feature will be used on The "Delivery Address Input" field and the
address fields on the checkout. This is a good way to avoid wrong address input by the customer.
It also accelerates the checkout process, thus improving the user experience.
Detailed instructions
for retrieving the API key are provided
here.
If checked, the calendar will have the current day selected by default. This is the same as if
the customer selected the current day on the fly-in booking form and clicked on "Apply".
Once selected, a dropdown with days ranging from current day to +7 days will appear right below.
If an option is selected from this dropdown, the calendar will have the chosen day selected and will
show available products (of that day) by default. For example, if +3 is selected and today is April 3,
the website will automatically assume that April 6 was selected from the booking form.
If time picker is disabled, the start time of the quote / order placed via website will match the value set here.
If time picker is disabled, the end time of the quote / order placed via website will match the value set here.
Hides all inventory items' prices, allowing the website visitors to collect items and send a request for a quote.
Once the customer sends the request, it automatically appears in your Rentopian system as new quote.
This option will not work if direct bookings are enabled.
Products prices will be revealed only when added to cart. Note that if "hide product price" setting is enabled as well, it will override this option and this will result in prices not being shown anywhere, including the cart.
Activate this feature if you have damage waiver option set up in Rentopian system but would prefer to refrain from providing that option to the visitors of your website. It will hide the damage waiver block on the checkout page.
Unless set to hidden via "Hide Damage Waiver" option, the damage waiver selection is
presented on checkout, with options to buy or opt out of damage waiver and the "Opt out of
damage waiver" option selected as default.
If this option is enabled, the default selection will be the "Buy Damage Waiver" option.
Below is an example:
This is the combination of the two options above. The damage waiver option will be hidden and charged by default, with no possibility to opt out.
While Rentopian provides extended functionality for managing your shipping / delivery options, in some cases it might be necessary to disable it and use an alternative solution. For example, if you use UPS for deliveries, you might want to use the UPS shipping WordPress plugin as it provides deep integration with UPS.
Enable if you allow rented items delivery address differ from the pickup address. In other words,
if the customer can choose to have their order delivered to Location A and picked up from location B.
Note that if this option is enabled, two addresses will be created for that customer in Rentopian,
one will be used for delivery and the other for return. Following is an example of the
"Different pick up and delivery addresses" checkbox on the checkout page:
Generally, the delivery prices are set for one direction. If you want to charge the same fee both for delivery and pickup, enable this option and it will show the delivery fee multiplied by two.
Include the shipping tax in the main tax and show in one line.
If you use mileage based delivery option, you must get an API Key from Google and enable some specific services. Follow the Google API Keys section for detailed instructions.
If the order equals or exceeds the sum specified here, it will qualify for free shipping.
There are 3 possible options:
Any terms such as customer / company relationship and responsibilities, delivery conditions, etc.. can be filled in here and will appear on checkout section of the website. Should you want to emphasize the special terms block, you can apply styles to .rental-special-term class. The class styles can be specified by heading to Appearance => Customize section in your WordPress admin panel and adding the styles in "Additional Classes" block. Below is an example of default special terms block on the checkout page:
If the website visitor tries to buy or send a quote request for a product and you do not have the requested quantity available, you can show a message such as "Delivery is available only after 2 weeks". The custom message to display can be set here.
If selected, the inventory listing page will not display rental / sale label for individual products.
Following is an example of product type label on a single product page, for a rental product. if the
product is for sale, the label will read "Sale".
Important This option will work with Eventorian or RentPro themes only.
Applies ONLY to companies that have multiple locations and would like to show products only from
specific location, based on customer's delivery address ZIP code.
After enabling this option, the shortcode for
selecting location: [rentopian_sync_location_select /] can be placed
anywhere on your website. Once placed, a dropdown will appear with the location addresses.
Once a location is selected, the products will be filtered to only show the products available
at the selected location.
If Fly-in type is set for the booking form and the customer tries to add a product to cart when rental dates are not selected yet, the fly-in form will slide in automatically, prompting to enter the rental dates. If this option is enabled, the fly-in form will no longer appear automatically.
Replace the text of the "Add to cart" button with a custom one. For example, if you do not use the direct checkout option, the text could be changed to "Add to quote".
Replace the word "Order" anywhere in the website with a custom word.
Replace all occurrences of the button with label "Read More" that shows for products with more than 1 variation or more than 1 option. If nothing is set, "Select Options" will be set instead of the Woocommerce default "Read More" as the phrase "Select Options" is more descriptive for rental-related products.
Replace the text of the "Proceed to checkout" button with a custom one. For example, if you do not use the direct checkout option, the text could be changed to "Proceed to summary".
Replace the text of the "Place order" button with a custom one. For example, if you do not use the direct checkout option, the text could be changed to "Send quote" or "Request a quote".
Replace the text of the "Daily fee" label with a custom one.
Replace all the occurrences of word "Tax" with another word.
Replace all the occurrences of word "Shipping" with another word. For example, many companies prefer the word "Delivery" over "Shipping".
The text appears on the checkout page, if a delivery address different from billing address option is enabled. The latter can be enabled via Woocommerce => Settings => Shipping section. Click on the "Shipping Options" tab and select "Default to customer shipping address".
Refers to the product options set via Rentopian system. An example of options field for product "inflatable castle" would be
"Select Setup Type" with options to select grass, concrete, etc...
If the user tries to add a product that has attached options,
without selecting an option, the text "Please select an option" will appear on top of the option dropdown list.
Set a custom text for the "Start date" label of the date selection form.
If the "show dates form only on the checkout page" setting is enabled, the date selection form that shows on the checkout page will have a submit button labeled "Proceed". You can change that text here.
The rental days selected by the customer are by default calculated using inclusive logic. For example,
if a website user enters November 1st 1:00pm as the start date and start time and November 2nd 1:00pm as
the end date and end time, this is calculated as 2 days. To calculate it as 1 day, please set tiers. In
the case of the above mentioned scenario, set the "minimum hours" field to 0, the "maximum hours" field
to 24 and "days" field to 1.
To set another tier, for example, to calculate 24-50 hours as 2 days, click on the "Add another tier"
button and fill in 24, 50 and 2 for minimum hours, maximum hours, and days fields accordingly.
You can add as many tiers as needed. Anything after that is calculated based on regular inclusive logic.
Lastly, if you want it back to regular logic, just delete all the tiers and save the changes.
The plugin has three types of logging that help troubleshoot issues:
any runtime errors that occur both in your website and during the synchronization
process.
In some cases the synchronization / importing process might fail.
The information about errors displayed on this section will help troubleshoot the issue and find
the solution faster.
The features such as Miles based delivery or customer address field autocomplete require using some of Google's services.
You must have a Google account with billing enabled to use an API key for Google Maps. Even though billing information is required, most websites will never exceed the free quota and will be able to use the Google Maps APIs for no cost. See their pricing page for more details.
Go to Google Developer Console. Select the Dashboard that you can see on the screenshot below:
Click on Select Project, then click on "New Project".
Once the project is successfully created, select the side menu bar and click "credentials" (the screenshot below, on the left).
On the Credentials page, click Create credentials > API key (the screenshot below, on the left).
The API key created dialog displays your newly created API key.
Once done, the new API key will be listed on the Credentials page under API keys. Click on "Show Key" and copy the API key.
Go to libraries section by clicking on the "Library" link from the top left navigation screen. Depending on the service you need the key for (Mile-based delivery or address autocomplete), different libraries need to be enabled:
Before we go through the services required to activate from the library, we need to make sure that the Api key that we created on the previous step does not have any restrictions. Click on your API key from the API keys list and make sure the restrictions are set to None and the option "Don't restrict key" is selected. The animation below highlights the required restriction options:
Now it's time to activate the required libraries:
Click on your API key and set a referrer restriction: The Application restriction must be set to "Website". Click on "Add" And specify your domain (e.g. https://myrentalswebsite.com). You can specify several domains here if you have more than one website using Rentopian sync and its address autocomplete setting.
Scroll down to API restrictions block and select the "restrict key" option. From the dropdown below, Select Maps JavaScript API and Places API. Once done, save the changes:
Some rental products come with additional service you might want to charge for. For example, if your company
is renting out inflatable slides, you might want to charge a fee based on the setup surface (e.g. setup on grass - Free,
setup on concrete - $50).
The product options are used for such cases. If a product has options attached, it appears on the
single page of the product in the website and does not allow adding the product to cart until
an option is selected (screenshot below).
You can attach options to any product, a list of products, or even a whole category. You can also choose an option that will be selected by default. Below is an illustration of the product option add page in Rentopian.
It is possible to attach multiple option groups to a product / category. For example, if the complete setup of an inflatable slide requires taking it upstairs and then setup on concrete, you might want to have two groups of services and charge a separate fee for each. The first group could be called "Setup Type" with options "Grass - $0", "Concrete - $50". The second group would be called "Are there any stairs?" with options "No - 0$", "Yes - $100".
Rentopian provides 2 options for blocking products - permanent or temporary. Permanent blocking is for the products that you do not want to rent or sell via your website. Temporary blocking is for disabling rental / sale of products for a specified period of time.
If you want to highlight a product or a list of products on your website, you can set it as Featured. This can be done when adding / editing a product, check the last option of the screenshot below:
Later these products can be displayed on a website via shortcodes, for example in a carousel, in a group labelled "Popular Products". Below is an example from one of our demo websites:
A product can have regular and on-sale price. The latter is set by editing the product variation and setting a sale price via the "On Sale Price" field:
The on-sale products are highlighted on the website with a special label. The screenshot below highlights a product with 21% off sale price:
It is also possible to create blocks or whole separate pages and list the products there, for example you can have a page called "On-Sale Products" and list all such products there.
WooCommerce has a native shortcode called [products /]. It allows to display your products anywhere on the
website and comes with plethora of filtering options, such as filter by category, tag, product id, etc...
However, as Rentopian Sync adds its own layer of filtering, such as availability filtering or the "Do not show on the website"
filter, we have created a shortcode to fully support this additional functionality.
The shortcode supports all the features / parameters offered by [products /]. All you need to do is to change the shortcode name from [products /] to [rs_products].
The plugin-system synchronization works according to unidirectional data flow logic. This means that the changes made on your Rentopian system account will reflect in your website but changes made on your website (such as changing product name, editing prices, adding coupons, etc…) will not reflect in the Rentopian system.
The following functionality of the system is currently supported (synchronized) by the plugin:
Important Please make sure you do not have any coupons or shipping methods set via WooCommerce plugin, it will interfere with the Rentopian system’s logic and return wrong results.
The ZIP code is required to define if delivery options are available for the specific area. For companies with more than 1 location, the ZIP code is also used for calculating nearest location and the inventory products are filtered and shown from that specific location.
If the item has variations, it cannot be added to cart right away. A "Read more" link is shown that leads to item's dedicated page where a specific variant can be selected and added to cart.
There are 2 possible combinations here:
a) If a specific variation of add-on is attached to an item or the add-on has only one variation,
it will be added to shopping cart automatically along with the item.
b) If the add-on attached to an item has several variations none of which is selected
specifically as item’s add-on on Rentopian system,
a modal window will be displayed prompting to select one of the available variations of the add-on.
Example
Imagine you have item candle specified as add-on for the item candle holder.
Candles can come in many variations - big, small, white, red, etc... You want to provide an option
for the customer to choose the one based on her preference instead of forcing one specific variation.
In such case, a modal window will appear allowing the customer
to choose between all available variations of the candle.
If an item has a price multiplier applied, the information will appear on the item's dedicated page and the customer can familiarize with the terms before adding the item to cart.
After the quote / order is placed, the customer receives an email with details and a pdf attachment with transaction summary. In case of direct order she customer receive the invoice and payment receipt.
All the quotes / orders placed through your website will appear in the Rentopian system immediately. A new event notification will be added to system's event notification list announcing about the newly created quote / order.
The issues that arise during the synchronization process are mostly connected with PHP directives not providing sufficient resources for successful completion:
Directive Name | Probable Default Value | Recommended Value |
---|---|---|
max_execution_time | 30 or 60 | 120 |
max_input_time | 30 | 60 |
memory_limit | 128MB | 256MB |
If you are receiving an error message “Non-static method Imagick::queryformats() should not be called statically”, make sure your PHP version is > 5.4.
If you can't find Rentopian Sync plugin in your admin panel, chances are you have not installed / activated the WooCommerce plugin. Please refer to requirements section to make sure all required plugins are in place per instructions.
We have prepared a list of plugins by third party vendors that serve as a useful
addition to any existing website, enriching its functionality and improving the
customer experience overall.
Note that we are not affiliated with any provider from this list. The list was
created to help provide better experience to your website's visitors and customers.
The plugins marked with *Free are provided free of charge by Rentopian on request. Overall, you can save up to $270 in expenses as we purchase extended licenses of the plugins and provide them to you free of charge.
Plugin Name | Purpose | Price | Details |
---|---|---|---|
WooCommerce Email Template Customizer | If the default email template of WooCommerce looks plain to you, and you are looking for a way to customize WooCommerce emails, here is what you need. WooCommerce Email Template Customizer is a helpful tool that helps you build and customize WooCommerce emails. | $32 *Free | Link |
WPC Order Tip for WooCommerce | Users can set up multiple types of tip options with predefined values (fixed amount or a percentage of the subtotal value) or custom amount with rules for min/max/step/default value (“Other” option). Customers can easily click on any option and the extra amount will be added to the subtotal automatically. | $29 *Free | Link |
WooCommerce Bulk Variations | The complete solution for managing and displaying product variations. Add and edit variations in bulk, and display them in a user-friendly grid or price matrix. | $79 | Link |
WooCommerce Show Variations as Single Products | Instead of just showing one variable product, the plugin will show all variations directly as single products inside your shop & category pages. This way the website visitors can add variations to their cart directly without having to select everything. It increases your SEO traffic by creating more specific internal links. | $49 *Free | Link |
HUSKY - Products Filter Professional for WooCommerce | A powerful, flexible, easy and robust filter plugin that extends functionality of WooCommerce plugin to allow your site visitors make searching/filtering of products by its categories, products attributes, tags, products taxonomies, meta fields and product price. | $42 *Free | Link |
ARForms | Build finest responsive WordPress forms (multi step forms, cost estimator forms, newsletter popup) within just minutes, No coding, no design experience needed. | $39 *Free | Link |
Testimonials Slider - WordPress Testimonials Plugin | A tool to display your customers’ testimonials on your WordPress website in the most vivid and attractive way. | $22 *Free | Link |
WP Rocket | WP Rocket is much more than just a WordPress caching plugin. It’s the most powerful solution to boost your loading time, improve your PageSpeed score, and optimize your Core Web Vitals. | Starts from $59 *Free | Link |
Rentopian Sync is compatible with any WordPress theme that supports WooCommerce.
The plugin will delete all of the existing products prior to importing the products that are present on your Rentopian system. We highly recommend backing up your data before proceeding with the synchronization.
If you have a Wordpress-based website, it should work out of the box. Our team will help with the setup should you have any concerns.
The common reasons are the following:
The visitor has not filled all the required fields on rental dates select form.
The ZIP code they entered is not within the range of maximum delivery distance settings.
To change this setting, login to your Rentopian system, go to Settings → Company Details → Locations
section and increase the number set for "Maximum delivery distance" option.
Note that it is the distance from your company address's ZIP code.
For example, if you
are located in Los Angeles, CA and have maximum delivery distance
set to 100 miles, if a visitor provides 60601 as ZIP code they won't be able to
add items to cart as that's an Chicago, Illinois address which is not within 100 miles range.
Go to Settings → Orders section on your Rentopian system account and locate the fields "Default Transaction Start Time" and "Default Transaction End Time". The values you set there will be applied both to the Rentopian system and to your website's date picker.