OptimoRoute Setup
Currently in Beta testing
OptimoRoute is a powerful tool designed to help businesses plan their day instantly and optimize for maximum productivity. By leveraging smart technology, it streamlines real-world operations, making it an essential resource for efficient management.
Setting Up the HirePOS to OptimoRoute Connection
To establish a connection between HirePOS and OptimoRoute, follow these steps:
Navigate to Setup > Preferences > API / Integrations in your HirePOS account.
Search for OptimoRoute and click on the OptimoRoute tile that appears.
Copy the API Key from OptimoRoute and paste it into the OptimoRoute API Key field in HirePOS.
Click Save Changes after you populate the OptimoRoute API Key field with the key from OptimoRoute.
Obtaining the API Key from OptimoRoute
To retrieve your API key from the OptimoRoute online admin portal, follow these steps:
Click on the Administration menu option located at the top-right corner of the portal.
Select Settings from the dropdown menu.
From the menu panel on the left, click on Account, then select Web service API.
Ensure that the API enabled checkbox is checked.
If there is a value in the API key field, copy that key and paste it into the OptimoRoute API Key field back in HirePOS.
If there is no existing API key, click the red Regenerate API key button to generate a new API key. Please exercise caution when using this option, as regenerating the API key will break any existing integrations.
Configuring Vehicle Features
Item Categories in HirePOS can be exported as 'Vehicle Features' in OptimoRoute.
To enable this functionality:
In HirePOS, go to Setup > Preferences > API / Integrations > OptimoRoute.
Enable the "Export item categories as vehicle features" option.
After enabling this setting, you will also need to ensure there is a Vehicle Feature in OptimoRoute with a code value exactly matching the name of an Item Category in HirePOS.
If an item is exported with an Item Category that does not have a matching Vehicle Feature in OptimoRoute, the export will fail with the following error:
"The specified vehicle feature does not exist."
Visit OptimoRoute
For more information about OptimoRoute and its features, please visit the OptimoRoute website.
