FleetConnector OptimoRoute Documentation

After activation, FleetConnector OptimoRoute adds two pages to the WooCommerce menu. Both require the manage_woocommerce capability (shop managers and administrators).

The Plugins screen also shows "Settings" and "Documentation" links below FleetConnector OptimoRoute.

FleetConnector licenses are managed through Lemon Squeezy. Your license key was sent to your email after purchase.

These settings control the fields of the OptimoRoute order. See section 6.3 for the complete field mapping.

OptimoRoute converts the address into a location on the map. The plugin sends the full address on one line, including state and country name, for the best result. These options decide what happens when OptimoRoute is not completely sure about the address.

OptimoRoute requires a date for every order. The delivery date chosen by the customer is sent as the OptimoRoute order date, and a chosen time slot (e.g. "09:00 - 12:00") is sent as the time window.

Orders are sent with OptimoRoute's create_order method, using two different operations:

With "Send orders in the background" enabled, every API call for an order (create, update, delete and fetching delivery details) is queued in the WooCommerce Action Scheduler as fco_process_order in the group fleetconnector-optimoroute. Only one pending action per order and action type is queued.

Open any order and use the "Order actions" dropdown in the right column. Order actions run immediately, so you see the result right away.

Send or update many orders at once from WooCommerce → Orders (works with HPOS and legacy order storage).

When editing any WooCommerce order, the "OptimoRoute Delivery" meta box in the side column shows everything the plugin knows about the delivery. Empty rows are hidden.

The "OptimoRoute" column appears right after the order status column in the orders list. Hover over an icon to see the details.

The OptimoRoute notes field is filled with clear instructions for the driver. HTML is stripped and the text is limited to 2,000 characters.

Order #1234

Customer note: Please ring the bell twice

Items:
2x T-shirt (Size: M, Color: Blue)
1x Gift card

Collect payment on delivery: €45.00

• The customer note is included when the customer left one
• Products and their options are included when "Add the ordered products to the driver instructions" is enabled
• For cash on delivery orders the amount to collect is shown; for other orders "Payment: [payment method]"

Find these in the "Delivery Status Sync" card on the settings page.

Two recurring jobs run in the WooCommerce Action Scheduler (group fleetconnector-optimoroute). They are created automatically when status sync is enabled and an API key is saved, and removed when you turn status sync off.

The plugin finds the WooCommerce order by its OptimoRoute ID (or order number) and handles these events:

After a final status (and when an order becomes scheduled), the plugin fetches the details with get_completion_details and get_scheduling_info:

Access the dashboard by navigating to:

There is also a "Dashboard" link at the top of the settings page. The unfiltered first page refreshes itself every 60 seconds.

At the top of the dashboard, you'll see six statistics cards based on the activity log:

The activity log shows every create, update, delete and status sync action, 50 entries per page, newest first.

Export your activity log to CSV for analysis, reporting, or record-keeping.

FleetConnector OptimoRoute connects WooCommerce to the OptimoRoute Web Service API using WordPress hooks, the WooCommerce Action Scheduler and direct HTTPS requests.

Base URL: https://api.optimoroute.com/v1. The API key is passed as the key query parameter on every request. Requests time out after 30 seconds.

How WooCommerce order data maps to OptimoRoute order fields:

{
    "operation": "SYNC",
    "orderNo": "WEB-1234",
    "type": "D",
    "date": "2026-09-29",
    "location": {
        "address": "Keizersgracht 123, 1015 CJ Amsterdam, Netherlands",
        "locationName": "Jane Doe",
        "acceptPartialMatch": true,
        "acceptMultipleResults": false
    },
    "notes": "Order #1234\n\nItems:\n2x T-shirt (Size: M)\n\nPayment: Credit card",
    "duration": 5,
    "timeWindows": [
        {
            "twFrom": "09:00",
            "twTo": "12:00"
        }
    ],
    "priority": "M",
    "load1": 2,
    "phone": "+31612345678",
    "email": "jane.doe@example.com",
    "notificationPreference": "email"
}

The plugin stores its data as WooCommerce order meta (HPOS compatible). Use these keys in your own code or exports.

Developers can customize FleetConnector OptimoRoute with WordPress filters and actions. Add them to your child theme's functions.php or a small custom plugin.

add_filter('fco_order_payload', function ($payload, $order) {
    // Only drivers with the "COOLING" skill can deliver chilled products
    if ($order->get_meta('_contains_chilled_products') === 'yes') {
        $payload['skills'] = array('COOLING');
    }

    // Custom field "shop" must be defined in OptimoRoute first
    $payload['customFields'] = array(
        'shop' => 'Webshop',
    );

    return $payload;
}, 10, 2);

add_filter('fco_order_no', function ($order_no, $order) {
    return 'SHOP1-' . $order->get_order_number();
}, 10, 2);

add_filter('fco_delivery_date_meta_keys', function ($keys, $order) {
    $keys[] = '_my_plugin_delivery_date';
    return $keys;
}, 10, 2);

add_action('fco_order_status_success', function ($order, $data) {
    $order->add_order_note('Delivered - thank-you email scheduled.');
}, 10, 2);

All Action Scheduler jobs use the group fleetconnector-optimoroute. The time of the last status sync is stored in the option fco_last_status_sync; all settings are stored as options with the prefix fco_.

FleetConnector OptimoRoute creates one custom table for the activity log. The table is created on activation and upgraded automatically after plugin updates.

These error codes appear in the FCO Dashboard, in order notes and in the WooCommerce logs.

If you can't resolve an issue using this documentation, we're here to help.