Skip to main content
Integrating OptimoRoute with Ordermentum

OptimoRoute is a route planning application that optimizes routes and schedules for deliveries.

Updated over a week ago
OptimoRoute | Delivery Route Planning & Field Service Scheduling

Optimising delivery routes is essential for efficient logistics management. By integrating OptimoRoute with Ordermentum, you can streamline your delivery processes, ensuring that routes are planned effectively.

This guide will help you enable and configure the integration between Ordermentum and OptimoRoute, allowing you to take full advantage of both platforms.


Table of Contents


Enabling the Integration

To enable the integration between Ordermentum and OptimoRoute, follow these steps:

  1. Obtain the API Key:

    • Log in to your OptimoRoute application.

    • Go to Settings under the Administration section.

    • Ensure the API Enabled option is selected, then copy the API Key.


    • Send this API Key to the Ordermentum support team to activate the integration.


Adding Required Properties in Ordermentum

To ensure the integration functions correctly, you'll need to add specific properties in Ordermentum. These properties allow data to flow seamlessly between Ordermentum and OptimoRoute.

Data Property Name

Format

Attached to

Requirements

stopNumber

Text

Orders

Required

driverSerial

Text

Orders

Required

locationNo

Text

Orders

Required

deliveryDriver

Text

Customers, Orders

Optional

deliveryDuration

Text

Customers, Orders

Optional

deliveryWindowStart

Dropdown

Customers, Orders

Optional

deliveryWindowEnd

Dropdown

Customers, Orders

Optional

deliveryNotificationPreference

Dropdown

Customers, Orders

Optional

Note: Property names in the OptimoRoute platform are case-sensitive and sensitive to spaces. Ensure you enter property names exactly as stated in this guide.

Important: The deliveryNotificationPreference dropdown must contain only the following options:

  • dont_notify

  • email

  • sms

  • both


Customer Email Matching

Ordermentum uses the Business Email field to match customers with their corresponding records in OptimoRoute. Ensure this field is correctly populated to avoid mismatches.


Important Notes

  • Double-check the property names and formats when configuring the integration to avoid errors.

  • The integration requires the correct API Key and accurate property settings for optimal performance.


Contact Support

If you encounter any issues or need further assistance with setting up the OptimoRoute integration, please contact our support team.

Did this answer your question?