Route Plans can be generated manually (eg. in a spreadsheet editor) or using routing software (eg. Paragon, etc.) and can be transmitted via the veroFresh™ API to facilitate Enterprise routing functionality.
Files can be uploaded manually on-demand, or done in batches, eg. daily at midnight.
Understanding Route Plans
Route plans are the backbone of how veroFresh™ organizes and matches incoming route data. Each route plan outlines a set of scheduled stops over a specific time-frame and includes where and when vehicles are expected to arrive. These plans must be uploaded before telematics data can be connected to veroFresh™.
Once uploaded, route plans are matched against live data to track actual versus planned routes. If a newly uploaded plan matches an existing plan (based on route number and date), the existing plan will be updated, not duplicated.
By default, veroFresh™ considers a match to be within ±48 hours. For example:
Uploading route 100 for Monday
Then uploading route 100 again for Tuesday
→ Tuesday’s upload updates Monday’s plan.
For this reason, we recommend naming routes uniquely per week (e.g., 1100 (For Monday), 2100 (For Tuesday), etc.) to avoid accidental overwrites. This behavior is configurable, but modifying it may complicate future changes to schedules.
Methods
We currently support two upload methods for route plans:
1. SFTP Upload
Upload to:
sftp://files.verofresh.comPort:
2222Authentication: Your assigned veroFresh™ SFTP credentials
Supports key-based login for automation (contact support to register your public key)
2. API
Endpoint:
POST /route-plan/bulk-createPayload: JSON
-
API documentation is available in the veroFresh™ web app. Log in, and go to Menu → API Documentation.
If you don’t see this menu option, your user may not yet have API access. Contact veroFresh™ support to enable API integration.
While the interface is technical, most routing systems or IT teams should be able to set this up with minimal guidance.
| If you're looking to upload route plans through our interface directly, please get in touch with our support team. |
File Format (For SFTP Upload)
All route plans must be submitted using a single, standardized CSV format called VFCsv.
VFCsv Format
This is a comma-separated file with no quotation marks. Each row represents a stop on a route. You must include all stops for a given route plan in the same file.
Fields Explained
Field |
Description |
|---|---|
|
ID for the distribution center (must match a veroFresh™ Location code) |
|
Route number or unique name (e.g., 1100, 2100) |
|
Stop Number (1,2,3 or 10,20,30 are common formats) |
|
Location code for the destination store (must match a veroFresh™ Location) |
|
Date when the truck is expected to leave the warehouse in format YYYY-MM-DD (2025-04-31) |
|
Time when the truck is expected to leave the DC in format HH:MM (10:00). This should be the same for all stops on a route. |
|
Date when the truck is expected to arrive at the warehouse in format YYYY-MM-DD (2025-04-31) |
|
Time when the truck is expected to arrive at the warehouse in format HH:MM (12:30) |
|
Number of cases (optional; not currently used) |
Sample VFcsv
| ⚠️ Please make sure to keep the order of the columns as shown above. |
API Integration Details (Overview Only)
If your team is using the veroFresh™ API to upload route plans:
You will send a
POSTrequest to/route-plan/bulk-createThe body will contain a list of route plans
-
Each route plan includes:
dc– distribution center ID (must match a veroFresh™ Location code)route_number– route name or numberstartandstop– estimated dispatch and end times-
stops– a list of stops, each with:stop_id(usually a store/location code)eta(estimated arrival time)
The system will process route plans submitted via API exactly the same way as those uploaded via SFTP. Here’s a simplified example of an API payload:
For the full schema, visit API Documentation in your veroFresh™ account.
Addendum
Helpful Links
| If you have any additional API-related questions, please submit a Support ticket. |