Integrations and API

OptiRoutes connects to the systems you already run. Orders come in from an Excel or CSV file, from FTP or SFTP, or through a secure Files API; signed delivery notes, route exports and reports go back the same way. A reports API serves your data to BI tools, and web addresses receive delivery reports and route exports as they happen.

Updated:

Which integrations does OptiRoutes offer?

NeedHow OptiRoutes does it
Load the day's ordersExcel or CSV upload, automatic loading from FTP, SFTP or the Files API, in CSV, JSON or fixed-width TXT.
Collect signed PODsFiles API calls per day or per order, or one ZIP per day; copies by e-mail.
Send routes to your systemRoute export in CSV, XLSX, XML, JSON or TXT, to a file, your FTP, the company folder or a web address.
Report into BI or your ERPThe reports API: orders, routes, drivers, customers, POD and a daily delivery summary.
React to each deliveryA delivery reports address that receives every report as it is made.
Pay for the serviceStripe Checkout for prepaid top-ups and automatic top-up.

Loading orders from a file, FTP or SFTP

The simplest integration is the file your system already exports. On the orders screen, Load deliveries reads an Excel or CSV file; you map each system field — address, customer name, order number, quantity and so on — to your column name once, and every later file loads the same way. For a fixed-width TXT file you give character positions instead of column names. Rows can be skipped by a marker word in the remarks, a second marker can replace the address, and you decide whether an existing order number is updated or added as new.

To take people out of the loop, choose an automatic loading method in the settings:

  • The OptiRoutes file server — your system drops the daily file, named by the date, in your company's folder on the FTP server or on the encrypted SFTP server.
  • Your own FTP server — OptiRoutes connects with the user you give it and loads the file named with today's date, or the most recently updated file.
  • Automatic import and export — orders load by themselves and the routes are planned too, with no click needed.
  • The Files API — your software uploads the orders file over HTTPS, described below.

On the customers screen, an Excel or CSV file with customer number, name, address, stop time and opening and closing times creates or updates customers and their time windows.

The Files API: orders in, PODs and reports out

Every company in OptiRoutes has its own private folder of files: the orders it loads, the signed delivery notes with their photos and signatures, the route exports and the end-of-day reports. The Files API lets your systems read and write that folder directly over HTTPS, with no FTP server in between. The company's manager switches between FTP and the API in Settings → API & files and creates the keys there — no request to support is needed, and new companies start on the API.

The company folder in the Files API.
FolderWhat is in itWho writes
orders_files/The daily orders file, and the route exports.You (orders), OptiRoutes (exports)
pod/YYYY/MM/DD/Signed PODs of that day: the signed PDF, the signature and the photos.OptiRoutes
pod/Source delivery notes to be signed in the driver app, one PDF per order number.You
reports/YYYY/MM/End-of-day and returns reports.OptiRoutes
podBaseFile/The POD base form.You
inbox/A free folder for files you want to hand over.You

Calls cover checking the key, listing a folder, downloading, uploading (up to 50 MB a file) and deleting files you uploaded, listing a day's POD files by order and kind, and downloading every POD file of a day as one ZIP. The guide includes code samples in Python, C# and Node.js, and a PowerShell script that keeps a folder on your server in sync with the company folder — so a team used to FTP can keep working the same way. Read it at the Files API guide.

How are API keys secured?

  • Least privilege — each key gets only the permissions it needs: signed PODs only, read every file, or upload orders and inbox files.
  • Allowed addresses — a key can be limited to your server's fixed IP addresses.
  • Expiry and rotation — a key can expire after a number of days; create a new key, switch, then revoke the old one with no downtime.
  • Revoke at once — a revoked key stops working within 30 seconds.
  • Audit — every call is logged with time, address, file and answer, and shown to the manager.
  • Stored safely — OptiRoutes keeps only a SHA-256 fingerprint of each key; connections are HTTPS with TLS 1.2 or later, and a key reaches only its own company's folder.

Limits: 300 requests a minute per key, 50 MB a file, 20 active keys per company, and up to 5,000 entries in one folder listing.

The reports and push API

For reporting tools and ERP connectors, a separate API at api-users.optiroutes.com serves your company's data as reports and accepts pushed data. One address and one token, issued by OptiRoutes for your company, cover every call. The documentation page lets you paste your token and see which reports are open to you and the column mapping of your account: read the API documentation.

ReportWhat it returns
ordersOrders and deliveries, with route and driver.
routesRoutes, with driver and number of stops.
driversDriver data.
customersCustomer data and addresses.
podDelivery documentation.
delivery-summaryA daily summary by status.

Two push calls work the other way: pushing orders writes the day's orders file and starts the automatic loading, and pushing drivers, lines and vehicles replaces the whole fleet, like a fleet file. Because the pushed driver list counts as the full fleet, always send every driver, not only the changes.

Exporting routes and webhooks

Route export writes the marked routes in CSV, XLSX, XML, JSON or fixed-width TXT. A columns table decides which fields go out and under which heading, original columns of your orders file can be added, and with item management a second file lists every item. Exports can go to your computer, your FTP server or the company folder, and with JSON the export can also be sent to a web address; if sending fails, the system tries once more.

For each delivery as it happens, fill in the delivery reports address in the driver app settings: every delivery report the drivers make is also sent there, so another system of yours updates by itself.

E-mail, payments, maps and messaging

  • E-mail — signed delivery notes go out from your own Gmail account with a Google app password; reports such as the end-of-day pallets report go to your reports e-mail; paying customers get receipts and drivers deposit confirmations from the cash desk.
  • Payments — top-ups are paid on a secure Stripe payment page, with an optional saved card for automatic top-up.
  • Addresses and maps — addresses are picked from Google suggestions and verified on the map before planning.
  • Navigation — the driver app hands each stop to Waze, or Apple Maps on an iPhone, by address or by exact coordinates.
  • SMS and WhatsApp — arrival messages and tracking links to customers, alerts to managers, lines to subcontractors, and route pictures to drivers on WhatsApp.

Planning an integration with your ERP or warehouse system? Tell us what you need to connect.

3-day free trial · up to 50 addresses a day · no credit card

Frequently asked questions

Can OptiRoutes load orders automatically from our ERP?

Yes. Your ERP can drop a daily file on the OptiRoutes FTP or SFTP server, on your own FTP server, or upload it through the Files API, and OptiRoutes loads it by itself.

How do we get signed PODs into our system?

Through the Files API: list and download a day's POD files, or download them all as one ZIP. A copy is also e-mailed by your routing rules.

Who creates API keys for the Files API?

The company's manager, in Settings, API & files. Keys have permissions, optional allowed addresses and expiry, and can be revoked at any time.

Is there an API for reports?

Yes. The reports API returns orders, routes, drivers, customers, POD and a daily delivery summary, with a token issued by OptiRoutes.

Which file formats can we export routes in?

CSV, XLSX, XML, JSON and fixed-width TXT, with the columns and headings you choose.

Start free trial — 3 days, no card

3-day free trial · up to 50 addresses a day · no credit card