WP Manifestindependent plugin directory
manifest / unclassified / routemile-woocommerce

RouteMile for WooCommerce

Map-based delivery management for single-restaurant WooCommerce stores — pin-drop checkout, distance fees, custom order statuses, rider PWA. On WordPress.org: wordpress.org/plugins/routemile-for-woocommerce

by MD MILLAT HOSEN · github.com/codermillat/routemile-woocommerce · website

★ 0stars
0forks

Install

No release zip yet. The repository archive installs, but the folder name will carry the branch suffix and updates will not flow:

wp plugin install https://github.com/codermillat/routemile-woocommerce/archive/refs/heads/main.zip

Readme

RouteMile for WooCommerce

A complete delivery management system for single-restaurant WooCommerce stores.

Install from WordPress.org — the plugin is now in the official WordPress Plugin Directory, so you can install it directly from Plugins → Add New in your admin.

Latest release: v1.6.3 — Mile Zero design system across every customer and rider surface, admin-renameable order stages, one-click brand colour, cash settlement workflow, and WordPress.org Plugin Directory compliance. See CHANGELOG.md for full details.

Features

🗺️ Location-based checkout

  • Two map providers: Google Maps (with your API key) or a free OpenStreetMap + Leaflet mode with no key required
  • Interactive pin drop with visible delivery-radius circle; orders outside the radius are blocked before payment
  • Distance fees: flat, per-km, or admin-defined distance tiers, plus free-delivery threshold and minimum order amount — all configurable
  • Live Order summary: fee updates as the customer moves the pin
  • Opening hours: per-weekday schedule, "open all day" / "closed all day" toggles, special-occasion override
  • ETA for customers: kitchen prep time + travel time

🚴 Delivery management

  • Custom order statuses: In Kitchen → Assigned → Picked Up → Completed
  • Deliveries dashboard: unassigned / assigned / out-for-delivery queues with the customer's kitchen note visible to managers only
  • Delivery rider role with a restricted mobile app
  • Admin-bar toggle to open/close ordering instantly
  • WooCommerce email notifications for each custom status

📱 Delivery-rider PWA

  • Installable app (Add to Home Screen) that looks and behaves like a native app
  • Live order list with New / In Progress / Delivered tabs that auto-refreshes on new orders and status changes
  • Per-order actions: call the customer, open the exact delivery location, mark picked up / delivered
  • Cash-on-delivery tracking: amount to collect per order, running cash-in-hand total
  • Settlement workflow: riders request a cash hand-over; managers/admins accept or reject with a full audit ledger
  • Privacy by design: riders see delivery instructions only — kitchen notes stay with the store

🛍️ Customer experience

  • Order tracking showing live status and, once assigned, the rider's name and phone number
  • My Account dashboard: welcome banner, order stats, recent orders, saved delivery address
  • Reorder shortcut
  • Thermal-printer-friendly receipts

Privacy & external services

The plugin is self-contained except for the map provider you choose:

  • Google Maps mode loads JavaScript from maps.googleapis.com and sends geocoding/routing requests server-side there. The customer's chosen coordinates and your store address are sent to Google. Your API key stays in your own database.
  • OpenStreetMap (Leaflet) mode loads map tiles from tile.openstreetmap.org and sends coordinate lookups to nominatim.openstreetmap.org.
  • No other data leaves your site. No telemetry, analytics, or advertising.

Shortcodes

Shortcode Description
[routew_track_order] Live order tracking for customers
[routew_reorder] Quick reorder previous orders

Testing

Run the built-in test suite:

php tests/RouteWTestRunner.php

The runner validates PHP syntax, security patterns (ABSPATH checks, nonce verification), file structure, plugin headers, HPOS declaration, bundled-vendor integrity (SHA-256), and custom order statuses.

Changelog

See CHANGELOG.md for version history.

Contributing

See CONTRIBUTING.md. Run php tests/RouteWTestRunner.php before opening a pull request.

License

GPL-3.0-or-later — same license family as WooCommerce itself.

Author / Developer

MD MILLAT HOSEN Website: millat.is-a.dev GitHub: @codermillat

Requirements

Requirement Version
WordPress 6.0+
WooCommerce 7.0+
PHP 7.4+

Installation

From WordPress.org (recommended): search "RouteMile" under Plugins → Add New, or get it directly at wordpress.org/plugins/routemile-for-woocommerce.

Manual upload:

  1. Install and activate WooCommerce first.
  2. Upload the plugin ZIP via Plugins → Add New → Upload Plugin.
  3. Go to WooCommerce → Settings → RouteMile, pick a map provider, and set your restaurant location, delivery radius, and delivery fees.
  4. Enable the RouteMile Delivery method in your shipping zone(s), or let the plugin add it automatically.
  5. Create users with the "Delivery Boy" role — their app lives at their Delivery Dashboard page.

Configuration

Choosing a map provider

Provider Key needed Road distance Best for
OpenStreetMap (default) No Yes (OSRM) Small/low-volume stores — free, works instantly
Google Maps Yes Yes Best data quality; needs billing account
MapTiler Yes (free) No — straight-line ×1.3 100k tiles + geocodes/month free
Geoapify Yes (free) Yes 3,000 requests/day free, one provider for everything

Switch providers any time — placed orders are unaffected.

Getting a Google Maps key

  1. Open Google Cloud Console, create or select a project.
  2. Enable Maps JavaScript API, Geocoding API, and Distance Matrix API.
  3. Create an API key under APIs & Services → Credentials.
  4. Paste it into WooCommerce → Settings → RouteMile → Map Provider.
  5. Recommended: create a second key, paste it into the "Server-side API Key" field, and restrict both:
    • Browser key → HTTP-referrer restriction https://*.yourdomain.com/*
    • Server key → IP restriction to your server's IP (the plugin automatically uses this one for server-side distance/geocoding calls)

Getting a MapTiler / Geoapify key

Paste into the "Provider API Key" field that appears when you select the provider. Apply domain restrictions in the provider's dashboard where offered.

Delivery fees

Pick flat, per-km, or distance tiers under Delivery Fee Settings — only fields relevant to your choice are shown. Free-delivery threshold and minimum order amount live on the same screen.

Opening hours

Per-weekday times, "Open all day" / "Closed all day" toggles, plus a special-occasion override for holidays. The admin-bar Deliveries: Open/Closed toggle is always the master switch.

Security recommendations

The plugin handles real orders and real money (including COD). Beyond the code:

  • Use HTTPS — checkout coordinates, rider sessions, and admin logins must travel encrypted.
  • Restrict your map keys — lock browser keys to your domain and the Google server key to your server IP in the provider dashboards. Unrestricted keys can be abused if extracted from page source.
  • Role hygiene — managers/admins need edit_shop_orders or manage_woocommerce; riders only get the "Delivery Boy" role and see only their own assigned orders.
  • Cash settlement is trust-based by design — the plugin records exactly who collected, handed over, and approved what and when, but physical cash still needs human reconciliation.
  • Back up regularly — all RouteMile data lives in WordPress/WooCommerce's own tables, so standard backups cover it.

Read the full README on GitHub →