Skip to docs navigation

Route4Me integration guide

Verified

How to connect Route4Me to WEXTL and use its 1 trigger and 114 actions in your workflows. About Route4Me: Route planning and optimization for deliveries and field teams.

  • 1 trigger
  • 52 searches
  • 62 actions
  • Polling
  • Auth: API key

AI-assisted documentation30 min read

This documentation is compiled from our integration source code, internal specs for Route4Me, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Route4Me on WEXTL →
  • Route4Me
  • WEXTL
  • Aspire
  • BlueFolder
  • Acculynx
  • AroFlo
  • FieldPulse
  • Aimsio
  • DoorLoop
  • Fergus
  • Bonsai
  • Autotask PSA
  • ActiveCollab
  • Canix
  • AgencyZoom
  • Aryeo
  • 2Solar
  • Businessmap
  • Ascora
  • CompanyCam
  • BugHerd
  • Arcsite
  • Confluence
  • Asana
  • ClickUp
  • Fibery
  • BigChange
  • Fieldwire
  • Fishbowl Inventory
  • Asset Panda
  • Buildern
  • Basecamp
  • API KeypasswordRequired

    In Route4Me open My Account, then API, and copy your API key.[1]

  1. Log in to your WEXTL account, add the Route4Me node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Route4Me account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch Activities

TriggerInterval check of the activity feed.
Output fields[3]
FieldType
Activity IDtext
Activity Typetext
Activity Messagetext
Activity Timestampnumber
Route IDtext
Member IDnumber
Route Nametext
Note Contentstext
Activity Datedate

Duplicate a Route

ActionClone made from an existing route.
Input fields[3]
FieldType
RouteRequired
choice
Duplicate Tochoice
Output fields[3]
FieldType
Statusboolean

Find Optimizations by Date

SearchRoute plans within a date range.
Input fields[3]
FieldType
Start DateRequired
date
End DateRequired
date
Output fields[3]
FieldType
Optimization Problem IDtext
Statenumber
User Errorsarray
Parameterstext
Addressesarray
Routesarray
Linkstext
Created Timestampnumber

Find Routes by Date

SearchRoutes for a range of days.
Input fields[3]
FieldType
Start DateRequired
date
End DateRequired
date
Output fields[3]
FieldType
Route IDtext
Optimization Problem IDtext
Member IDtext
Vehicle Aliastext
Route Costnumber
Route Distance Kmnumber
Trip Distancenumber
Addressesarray
Parameterstext
Created Timestampnumber

Geocode an Address

SearchCoordinates for typed addresses.
Input fields[3]
FieldType
AddressesRequired
array
Addresstext
Output fields[3]
FieldType
Addresstext
Latnumber
Lngnumber
Originaltext

Get a Config Setting

SearchValue of a named setting.
Input fields[3]
FieldType
KeyRequired
text
Output fields[3]
FieldType
Config Keytext
Config Valuetext

Get a Group

SearchLocation group details and filter.
Input fields[3]
FieldType
GroupRequired
choice
Output fields[3]
FieldType
Group IDnumber
Group Nametext
Group Colortext
Group Icontext
Filtertext

Get a Route

SearchRoute with optional extras.
Input fields[3]
FieldType
RouteRequired
choice
Include Notesboolean
Include Tracking Historyboolean
Include Directionsboolean
Include Original Routeboolean
Include Order Inventoryboolean
Output fields[3]
FieldType
Route IDtext
Optimization Problem IDtext
Member IDtext
Vehicle Aliastext
Route Costnumber
Route Distance Kmnumber
Trip Distancenumber
Addressesarray
Parameterstext
Created Timestampnumber

Get a Route Address

SearchDetails of a single stop.
Input fields[3]
FieldType
Route Destination IDRequired
text
Routechoice
Optimizationchoice
Output fields[3]
FieldType
Route Destination IDnumber
Route IDtext
Addresstext
Aliastext
Latnumber
Lngnumber
Sequence Nonumber
Is Depotboolean
Is Visitedboolean
Is Departedboolean

4other output fields

Get a Schedule Calendar

SearchCalendar data between two dates.
Input fields[3]
FieldType
FromRequired
date
ToRequired
date
Time Zone Offset (min)number
Include Ordersboolean
Include Locationsboolean
Include Route Countsboolean
Output fields[3]
FieldType
Calendartext
Statusboolean

Get a Telematics Vendor

SearchVendor profile with supported countries.
Input fields[3]
FieldType
Vendor IDRequired
text
Output fields[3]
FieldType
Vendor IDtext
Nametext
Is Integratedboolean
Featuresarray
Countriesarray

Get a Territory

SearchService area details and color.
Input fields[3]
FieldType
TerritoryRequired
choice
Output fields[3]
FieldType
Territory IDtext
Territory Nametext
Territory Colortext
Member IDnumber
Territorytext
Addressesarray
Ordersarray

Get a Territory with Addresses and Orders

SearchService area plus its contents.
Input fields[3]
FieldType
TerritoryRequired
choice
Output fields[3]
FieldType
Territory IDtext
Territory Nametext
Territory Colortext
Member IDnumber
Territorytext
Addressesarray
Ordersarray

Get a User

SearchTeam member profile and role.
Input fields[3]
FieldType
UserRequired
choice
Output fields[3]
FieldType
Member IDnumber
Member Emailtext
Member First Nametext
Member Last Nametext
Member Typetext
Member Phonetext
Member Zipcodetext

Get a Vehicle

SearchFleet vehicle specs and fuel.
Input fields[3]
FieldType
VehicleRequired
choice
Output fields[3]
FieldType
Vehicle IDtext
Vehicle Aliastext
Vehicle VINtext
Vehicle Maketext
Vehicle Model Yearnumber
Fuel Typetext
Vehicle Type IDtext
Has Trailerboolean

Get an Asset Tracking

SearchStatus and position history of a tracked item.
Input fields[3]
FieldType
Tracking NumberRequired
text
Output fields[3]
FieldType
Tracking Numbertext
Route IDtext
Statustext
Latnumber
Lngnumber
Timestampnumber

Get an Avoidance Zone

SearchRestricted area details and color.
Input fields[3]
FieldType
Avoidance ZoneRequired
choice
Output fields[3]
FieldType
Territory IDtext
Territory Nametext
Territory Colortext
Member IDnumber
Territorytext
Addressesarray
Ordersarray

Get an Optimization

SearchRoute plan with its outcome.
Input fields[3]
FieldType
OptimizationRequired
choice
Output fields[3]
FieldType
Optimization Problem IDtext
Statenumber
User Errorsarray
Parameterstext
Addressesarray
Routesarray
Linkstext
Created Timestampnumber

Get an Order

SearchAddress and coordinates of an order.
Input fields[3]
FieldType
OrderRequired
choice
Output fields[3]
FieldType
Order IDnumber
Address 1text
Address 2text
Address Aliastext
Cached Latnumber
Cached Lngnumber
Day Scheduled For YYMMDDtext
EXT FIELD First Nametext
EXT FIELD Last Nametext
EXT FIELD Emailtext

2other output fields

Get Device Location History

SearchGPS trail of a route device.
Input fields[3]
FieldType
RouteRequired
choice
Time Periodchoice
Startdate
Enddate
Output fields[3]
FieldType
Latnumber
Lngnumber
Speednumber
Directionnumber
Timestampnumber
Device Typetext

Get Locations by IDs

SearchSaved addresses by ID.
Input fields[3]
FieldType
Location IDsRequired
array
Location IDtext
Output fields[3]
FieldType
Address IDnumber
Address 1text
Address 2text
Address Aliastext
Address Grouptext
First Nametext
Last Nametext
Address Emailtext
Address Phone Numbertext
Cached Latnumber

2other output fields

Get Route Directions

SearchDirections fetched for one stored route.
Input fields[3]
FieldType
RouteRequired
choice
Output fields[3]
FieldType
Route IDtext
Optimization Problem IDtext
Member IDtext
Vehicle Aliastext
Route Costnumber
Route Distance Kmnumber
Trip Distancenumber
Addressesarray
Parameterstext
Created Timestampnumber

Get Route Path Points

SearchMap path coordinates of a route.
Input fields[3]
FieldType
RouteRequired
choice
Path Outputchoice
Compress Pointsboolean
Output fields[3]
FieldType
Route IDtext
Optimization Problem IDtext
Member IDtext
Vehicle Aliastext
Route Costnumber
Route Distance Kmnumber
Trip Distancenumber
Addressesarray
Parameterstext
Created Timestampnumber

Get Route Tracking History

SearchMovement log of a route.
Input fields[3]
FieldType
RouteRequired
choice
Output fields[3]
FieldType
Route IDtext
Member IDnumber
Latnumber
Lngnumber
Speednumber
Coursenumber
Timestampnumber

List Activities

SearchRecent events across your account.
Input fields[3]
FieldType
LimitRequired
number
Activity Typechoice
Routechoice
Userchoice
Sincedate
Team Activitiesboolean
Output fields[3]
FieldType
Activity IDtext
Activity Typetext
Activity Messagetext
Activity Timestampnumber
Route IDtext
Member IDnumber
Route Nametext
Note Contentstext

List Address Notes

SearchRemarks recorded on a stop.
Input fields[3]
FieldType
RouteRequired
choice
Route DestinationRequired
choice
Output fields[3]
FieldType
Note IDnumber
Route IDtext
Route Destination IDnumber
Note Typetext
Note Contentstext
Upload URLtext
Timestampnumber

List Avoidance Zones

SearchNames and colors of avoidance areas.
Output fields[3]
FieldType
Territory IDtext
Territory Nametext
Territory Colortext
Member IDnumber
Territorytext
Addressesarray
Ordersarray

List Config Settings

SearchEvery setting stored for your account.
Output fields[3]
FieldType
Config Keytext
Config Valuetext

List Drivers

SearchDrivers with their names and email.
Output fields[3]
FieldType
Member IDnumber
Member First Nametext
Member Last Nametext
Member Emailtext

List Groups

SearchLocation groups in your book.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Group IDnumber
Group Nametext
Group Colortext
Group Icontext
Filtertext

List Locations

SearchSaved addresses from your book.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Address IDnumber
Address 1text
Address 2text
Address Aliastext
Address Grouptext
First Nametext
Last Nametext
Address Emailtext
Address Phone Numbertext
Cached Latnumber

2other output fields

List Locations in a Group

SearchSaved addresses sorted into a group.
Input fields[3]
FieldType
GroupRequired
choice
Output fields[3]
FieldType
Address IDnumber
Address 1text
Address 2text
Address Aliastext
Address Grouptext
First Nametext
Last Nametext
Address Emailtext
Address Phone Numbertext
Cached Latnumber

2other output fields

List Note Types

SearchCustom categories for route notes.
Output fields[3]
FieldType
IDnumber
Typetext
Valuesarray

List Optimizations

SearchOptimizations with their State and Routes.
Input fields[3]
FieldType
LimitRequired
number
Statechoice
Output fields[3]
FieldType
Optimization Problem IDtext
Statenumber
User Errorsarray
Parameterstext
Addressesarray
Routesarray
Linkstext
Created Timestampnumber

List Order Custom Fields

SearchData columns defined for orders.
Output fields[3]
FieldType
Order Custom Field IDnumber
Order Custom Field Nametext
Order Custom Field Labeltext
Order Custom Field Typetext
Order Custom Field Type Infotext

List Orders

SearchOrders with their addresses and schedule.
Input fields[3]
FieldType
LimitRequired
number
Fieldstext
Output fields[3]
FieldType
Order IDnumber
Address 1text
Address 2text
Address Aliastext
Cached Latnumber
Cached Lngnumber
Day Scheduled For YYMMDDtext
EXT FIELD First Nametext
EXT FIELD Last Nametext
EXT FIELD Emailtext

2other output fields

List Orders by Added Date

SearchOrders created on one calendar date.
Input fields[3]
FieldType
DayRequired
date
Output fields[3]
FieldType
Order IDnumber
Address 1text
Address 2text
Address Aliastext
Cached Latnumber
Cached Lngnumber
Day Scheduled For YYMMDDtext
EXT FIELD First Nametext
EXT FIELD Last Nametext
EXT FIELD Emailtext

2other output fields

List Orders by Scheduled Date

SearchOrders planned for one calendar date.
Input fields[3]
FieldType
DayRequired
date
Output fields[3]
FieldType
Order IDnumber
Address 1text
Address 2text
Address Aliastext
Cached Latnumber
Cached Lngnumber
Day Scheduled For YYMMDDtext
EXT FIELD First Nametext
EXT FIELD Last Nametext
EXT FIELD Emailtext

2other output fields

List Routes

SearchRoutes with cost and distance.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Route IDtext
Optimization Problem IDtext
Member IDtext
Vehicle Aliastext
Route Costnumber
Route Distance Kmnumber
Trip Distancenumber
Addressesarray
Parameterstext
Created Timestampnumber

List Telematics Vendors

SearchTelematics vendors with their features and countries.
Output fields[3]
FieldType
Vendor IDtext
Nametext
Is Integratedboolean
Featuresarray
Countriesarray

List Territories

SearchNames and colors of your territories.
Output fields[3]
FieldType
Territory IDtext
Territory Nametext
Territory Colortext
Member IDnumber
Territorytext
Addressesarray
Ordersarray

List User Locations

SearchPositions reported by your team.
Output fields[3]
FieldType
Route IDtext
Member IDnumber
Latnumber
Lngnumber
Speednumber
Coursenumber
Timestampnumber

List Users

SearchEveryone on your account.
Output fields[3]
FieldType
Member IDnumber
Member Emailtext
Member First Nametext
Member Last Nametext
Member Typetext
Member Phonetext
Member Zipcodetext

List Vehicles

SearchVehicles registered in your fleet.
Input fields[3]
FieldType
LimitRequired
number
Showchoice
Searchtext
Output fields[3]
FieldType
Vehicle IDtext
Vehicle Aliastext
Vehicle VINtext
Vehicle Maketext
Vehicle Model Yearnumber
Fuel Typetext
Vehicle Type IDtext
Has Trailerboolean

Preview an Uploaded File

SearchRows read from an address upload.
Input fields[3]
FieldType
Upload IDRequired
text
Output fields[3]
FieldType
Statusboolean
Upload IDtext
Rowsnumber

Re-optimize a Route

ActionStop order recalculated for a route.
Input fields[3]
FieldType
RouteRequired
choice
Optimize Forchoice
Disable Optimizationboolean
Output fields[3]
FieldType
Route IDtext
Optimization Problem IDtext
Member IDtext
Vehicle Aliastext
Route Costnumber
Route Distance Kmnumber
Trip Distancenumber
Addressesarray
Parameterstext
Created Timestampnumber

Reverse Geocode a Location

SearchStreet address for a coordinate.
Input fields[3]
FieldType
LatitudeRequired
number
LongitudeRequired
number
Output fields[3]
FieldType
Addresstext
Latnumber
Lngnumber
Originaltext

Search Locations

SearchSaved addresses by text.
Input fields[3]
FieldType
QueryRequired
text
Fieldstext
Displaytext
Output fields[3]
FieldType
Address IDnumber
Address 1text
Address 2text
Address Aliastext
Address Grouptext
First Nametext
Last Nametext
Address Emailtext
Address Phone Numbertext
Cached Latnumber

2other output fields

Search Orders

SearchOrders matching a text query.
Input fields[3]
FieldType
QueryRequired
text
LimitRequired
number
Output fields[3]
FieldType
Order IDnumber
Address 1text
Address 2text
Address Aliastext
Cached Latnumber
Cached Lngnumber
Day Scheduled For YYMMDDtext
EXT FIELD First Nametext
EXT FIELD Last Nametext
EXT FIELD Emailtext

2other output fields

Search Routes

SearchRoutes matching a search phrase.
Input fields[3]
FieldType
QueryRequired
text
Output fields[3]
FieldType
Route IDtext
Optimization Problem IDtext
Member IDtext
Vehicle Aliastext
Route Costnumber
Route Distance Kmnumber
Trip Distancenumber
Addressesarray
Parameterstext
Created Timestampnumber

Search Telematics Vendors

SearchVendors filtered by criteria.
Input fields[3]
FieldType
Searchtext
Sizechoice
Integratedchoice
Featuretext
Countrytext
Per Pagenumber
Pagenumber
Output fields[3]
FieldType
Vendor IDtext
Nametext
Is Integratedboolean
Featuresarray
Countriesarray

Search User Locations

SearchTeam positions matching a query.
Input fields[3]
FieldType
QueryRequired
text
Output fields[3]
FieldType
Route IDtext
Member IDnumber
Latnumber
Lngnumber
Speednumber
Coursenumber
Timestampnumber

Validate a Session

SearchSession check for a member.
Input fields[3]
FieldType
Session TokenRequired
text
Member IDRequired
text
Output fields[3]
FieldType
Statusboolean
Member IDnumber

Add a Note File

ActionUploaded file saved as a note on a stop.
Input fields[3]
FieldType
RouteRequired
choice
Route DestinationRequired
choice
FileRequired
text
File NameRequired
text
Device Latitudenumber
Device Longitudenumber
Device Typechoice
Output fields[3]
FieldType
Note IDnumber
Route IDtext
Route Destination IDnumber
Note Typetext
Note Contentstext
Upload URLtext
Timestampnumber

Add a Route Note

ActionText remark on a stop.
Input fields[3]
FieldType
RouteRequired
choice
Route DestinationRequired
choice
ContentsRequired
text
Device Latitudenumber
Device Longitudenumber
Device Typechoice
Note Typetext
Output fields[3]
FieldType
Note IDnumber
Route IDtext
Route Destination IDnumber
Note Typetext
Note Contentstext
Upload URLtext
Timestampnumber

Add Addresses to a Route

ActionExtra stops added to a route.
Input fields[3]
FieldType
RouteRequired
choice
AddressesRequired
array
Addressobject
Insert at Optimal Positionboolean
After Destination IDtext
Output fields[3]
FieldType
Route IDtext
Optimization Problem IDtext
Member IDtext
Vehicle Aliastext
Route Costnumber
Route Distance Kmnumber
Trip Distancenumber
Addressesarray
Parameterstext
Created Timestampnumber

Add an Address to an Optimization

ActionStops inserted into an existing optimization.
Input fields[3]
FieldType
OptimizationRequired
choice
AddressesRequired
array
Addressobject
Re-optimizeboolean
Output fields[3]
FieldType
Optimization Problem IDtext
Statenumber
User Errorsarray
Parameterstext
Addressesarray
Routesarray
Linkstext
Created Timestampnumber

Add an Order to a Route

ActionOrders already saved in Route4Me, now on a route.
Input fields[3]
FieldType
RouteRequired
choice
Order IDsRequired
array
Order IDtext
Additional Fields (JSON)text
Output fields[3]
FieldType
Route IDtext
Optimization Problem IDtext
Member IDtext
Vehicle Aliastext
Route Costnumber
Route Distance Kmnumber
Trip Distancenumber
Addressesarray
Parameterstext
Created Timestampnumber

Add an Order to an Optimization

ActionOrders already saved in Route4Me, now part of an optimization.
Input fields[3]
FieldType
OptimizationRequired
choice
Order IDsRequired
array
Order IDtext
Additional Fields (JSON)text
Output fields[3]
FieldType
Optimization Problem IDtext
Statenumber
User Errorsarray
Parameterstext
Addressesarray
Routesarray
Linkstext
Created Timestampnumber

Create a Config Setting

ActionSingle stored account setting.
Input fields[3]
FieldType
KeyRequired
text
ValueRequired
text
Output fields[3]
FieldType
Config Keytext
Config Valuetext

Create a Group

ActionGroup of saved locations.
Input fields[3]
FieldType
NameRequired
text
Colortext
Icontext
Filter (JSON)text
Output fields[3]
FieldType
Group IDnumber
Group Nametext
Group Colortext
Group Icontext
Filtertext

Create a Location

ActionNew entry for your address book.
Input fields[3]
FieldType
AddressRequired
text
Address 2text
Aliastext
Grouptext
First Nametext
Last Nametext
Emailtext
Phonetext
Citytext
State IDtext

6other input fields

Output fields[3]
FieldType
Address IDnumber
Address 1text
Address 2text
Address Aliastext
Address Grouptext
First Nametext
Last Nametext
Address Emailtext
Address Phone Numbertext
Cached Latnumber

2other output fields

Create a Note Type

ActionCustom category for notes.
Input fields[3]
FieldType
TypeRequired
text
Valuesarray
Valuetext
Output fields[3]
FieldType
IDnumber
Typetext
Valuesarray

Create a Route

ActionRoute made from your stops.
Input fields[3]
FieldType
AddressesRequired
array
Addressobject
Depotsarray
Depotobject
Algorithmchoice
Route Nametext
Route Datedate
Route Start Time (s)number
Travel Modechoice
Optimize Forchoice
Distance Unitchoice
Device Typechoice

4other input fields

Output fields[3]
FieldType
Route IDtext
Optimization Problem IDtext
Member IDtext
Vehicle Aliastext
Route Costnumber
Route Distance Kmnumber
Trip Distancenumber
Addressesarray
Parameterstext
Created Timestampnumber

Create a Territory

ActionNamed territory drawn on a map.
Input fields[3]
FieldType
NameRequired
text
ShapeRequired
choice
Colortext
Center Latitudenumber
Center Longitudenumber
Radius (m)number
Pointsarray
Pointobject
Output fields[3]
FieldType
Territory IDtext
Territory Nametext
Territory Colortext
Member IDnumber
Territorytext
Addressesarray
Ordersarray

Create a User

ActionNew team member account.
Input fields[3]
FieldType
EmailRequired
text
First NameRequired
text
Last NameRequired
text
PasswordRequired
secret
User TypeRequired
choice
Phonetext
Zip Codetext
Read-only Userboolean
Hide Routed Addressesboolean
Hide Visited Addressesboolean

3other input fields

Output fields[3]
FieldType
Member IDnumber
Member Emailtext
Member First Nametext
Member Last Nametext
Member Typetext
Member Phonetext
Member Zipcodetext

Create a Vehicle

ActionFleet vehicle with its specs.
Input fields[3]
FieldType
AliasRequired
text
VINtext
Maketext
Model Yearnumber
Registration Countrytext
Registration Country IDtext
Axle Countnumber
MPG Citynumber
MPG Highwaynumber
Fuel Typetext

5other input fields

Output fields[3]
FieldType
Vehicle IDtext
Vehicle Aliastext
Vehicle VINtext
Vehicle Maketext
Vehicle Model Yearnumber
Fuel Typetext
Vehicle Type IDtext
Has Trailerboolean

Create an Avoidance Zone

ActionNamed zone to avoid, drawn as a circle, rectangle or polygon.
Input fields[3]
FieldType
NameRequired
text
ShapeRequired
choice
Colortext
Center Latitudenumber
Center Longitudenumber
Radius (m)number
Pointsarray
Pointobject
Output fields[3]
FieldType
Territory IDtext
Territory Nametext
Territory Colortext
Member IDnumber
Territorytext
Addressesarray
Ordersarray

Create an Optimization

ActionRoute plan built from stops.
Input fields[3]
FieldType
AddressesRequired
array
Addressobject
Depotsarray
Depotobject
Algorithmchoice
Route Nametext
Route Datedate
Route Start Time (s)number
Travel Modechoice
Optimize Forchoice
Distance Unitchoice
Device Typechoice

6other input fields

Output fields[3]
FieldType
Optimization Problem IDtext
Statenumber
User Errorsarray
Parameterstext
Addressesarray
Routesarray
Linkstext
Created Timestampnumber

Create an Order

ActionNew order saved with its address and schedule.
Input fields[3]
FieldType
AddressRequired
text
Address 2text
Address Aliastext
Citytext
Latitudenumber
Longitudenumber
Scheduled Daydate
Time Window Start (s)number
Time Window End (s)number
Second Time Window Start (s)number

9other input fields

Output fields[3]
FieldType
Order IDnumber
Address 1text
Address 2text
Address Aliastext
Cached Latnumber
Cached Lngnumber
Day Scheduled For YYMMDDtext
EXT FIELD First Nametext
EXT FIELD Last Nametext
EXT FIELD Emailtext

2other output fields

Create an Order Custom Field

ActionAdditional field defined for orders.
Input fields[3]
FieldType
NameRequired
text
LabelRequired
text
TypeRequired
choice
Type Info (JSON)text
Output fields[3]
FieldType
Order Custom Field IDnumber
Order Custom Field Nametext
Order Custom Field Labeltext
Order Custom Field Typetext
Order Custom Field Type Infotext

Create Config Settings in Bulk

ActionMany account settings at once.
Input fields[3]
FieldType
SettingsRequired
array
Entryobject
Output fields[3]
FieldType
Config Keytext
Config Valuetext

Delete a Config Setting

ActionStored setting cleared from the account.
Input fields[3]
FieldType
KeyRequired
text
Output fields[3]
FieldType
Statusboolean

Delete a Group

ActionAddress book group dropped from your book.
Input fields[3]
FieldType
GroupRequired
choice
Output fields[3]
FieldType
Statusboolean

Delete a Note Type

ActionCustom note type deleted.
Input fields[3]
FieldType
Type IDRequired
text
Output fields[3]
FieldType
Statusboolean

Delete a Territory

ActionRemoval of a saved territory from Route4Me.
Input fields[3]
FieldType
TerritoryRequired
choice
Output fields[3]
FieldType
Statusboolean

Delete a User

ActionAccount of a team member removed.
Input fields[3]
FieldType
UserRequired
choice
Output fields[3]
FieldType
Statusboolean

Delete a Vehicle

ActionFleet vehicle deleted from Route4Me.
Input fields[3]
FieldType
VehicleRequired
choice
Output fields[3]
FieldType
Statusboolean

Delete an Avoidance Zone

ActionRemoval of a saved avoidance zone.
Input fields[3]
FieldType
Avoidance ZoneRequired
choice
Output fields[3]
FieldType
Statusboolean

Delete an Order Custom Field

ActionOrder data field deleted from Route4Me.
Input fields[3]
FieldType
Field IDRequired
text
Output fields[3]
FieldType
Statusboolean

Delete Locations

ActionSeveral saved addresses deleted in one request.
Input fields[3]
FieldType
Location IDsRequired
array
Location IDtext
Output fields[3]
FieldType
Statusboolean

Delete Optimizations

ActionSeveral optimizations deleted at once.
Input fields[3]
FieldType
Optimization IDsRequired
array
Optimization IDtext
Output fields[3]
FieldType
Statusboolean

Delete Orders

ActionOrders removed in a single request.
Input fields[3]
FieldType
Order IDsRequired
array
Order IDtext
Output fields[3]
FieldType
Statusboolean

Delete Routes

ActionRoutes deleted in a single request.
Input fields[3]
FieldType
Route IDsRequired
array
Route IDtext
Output fields[3]
FieldType
Statusboolean

Geocode Addresses in Bulk

ActionBatch conversion of addresses.
Input fields[3]
FieldType
RowsRequired
array
Rowobject
Output fields[3]
FieldType
Addresstext
Latnumber
Lngnumber
Originaltext

Geocode an Uploaded File

ActionCoordinates for an uploaded sheet.
Input fields[3]
FieldType
Upload IDRequired
text
Output fields[3]
FieldType
Statusboolean
Upload IDtext
Rowsnumber

Log an Activity Message

ActionCustom entry in the activity feed.
Input fields[3]
FieldType
MessageRequired
text
Routechoice
Output fields[3]
FieldType
Activity IDtext
Activity Typetext
Activity Messagetext
Activity Timestampnumber
Route IDtext
Member IDnumber
Route Nametext
Note Contentstext

Make an API Call

universalYour own Route4Me REST API request.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Query Stringobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headerstext
Status Codenumber

Mark an Address as Departed

ActionDeparture logged for a route stop.
Input fields[3]
FieldType
RouteRequired
choice
Route DestinationRequired
choice
UserRequired
choice
Departedboolean
Output fields[3]
FieldType
Route Destination IDnumber
Route IDtext
Addresstext
Aliastext
Latnumber
Lngnumber
Sequence Nonumber
Is Depotboolean
Is Visitedboolean
Is Departedboolean

4other output fields

Mark an Address as Detected Departed

ActionAutomatic departure detection record.
Input fields[3]
FieldType
RouteRequired
choice
Route DestinationRequired
choice
Detected AtRequired
date
Latitudenumber
Longitudenumber
Output fields[3]
FieldType
Route Destination IDnumber
Route IDtext
Addresstext
Aliastext
Latnumber
Lngnumber
Sequence Nonumber
Is Depotboolean
Is Visitedboolean
Is Departedboolean

4other output fields

Mark an Address as Detected Visited

ActionAutomatic arrival detection record.
Input fields[3]
FieldType
RouteRequired
choice
Route DestinationRequired
choice
Detected AtRequired
date
Latitudenumber
Longitudenumber
Output fields[3]
FieldType
Route Destination IDnumber
Route IDtext
Addresstext
Aliastext
Latnumber
Lngnumber
Sequence Nonumber
Is Depotboolean
Is Visitedboolean
Is Departedboolean

4other output fields

Mark an Address as Visited

ActionVisit recorded on a stop for a team member.
Input fields[3]
FieldType
RouteRequired
choice
Route DestinationRequired
choice
UserRequired
choice
Visitedboolean
Output fields[3]
FieldType
Route Destination IDnumber
Route IDtext
Addresstext
Aliastext
Latnumber
Lngnumber
Sequence Nonumber
Is Depotboolean
Is Visitedboolean
Is Departedboolean

4other output fields

Merge Routes

ActionSeveral routes combined into one.
Input fields[3]
FieldType
Route IDsRequired
array
Route IDtext
Depot Addresstext
Depot Latitudenumber
Depot Longitudenumber
Remove Origin Routesboolean
Output fields[3]
FieldType
Statusboolean

Move a Destination to Another Route

ActionStop transferred between two routes.
Input fields[3]
FieldType
Target Route IDRequired
text
Route Destination IDRequired
text
After Destination IDRequired
text
Output fields[3]
FieldType
Statusboolean

Re-optimize an Optimization

ActionFresh solve of a stored optimization.
Input fields[3]
FieldType
OptimizationRequired
choice
Additional Fields (JSON)text
Output fields[3]
FieldType
Optimization Problem IDtext
Statenumber
User Errorsarray
Parameterstext
Addressesarray
Routesarray
Linkstext
Created Timestampnumber

Recompute Route Directions

ActionFresh driving instructions for a route.
Input fields[3]
FieldType
RouteRequired
choice
Travel Modechoice
Output fields[3]
FieldType
Route IDtext
Optimization Problem IDtext
Member IDtext
Vehicle Aliastext
Route Costnumber
Route Distance Kmnumber
Trip Distancenumber
Addressesarray
Parameterstext
Created Timestampnumber

Remove an Address from a Route

ActionStop removed from a route.
Input fields[3]
FieldType
RouteRequired
choice
Route DestinationRequired
choice
Output fields[3]
FieldType
Statusboolean

Remove an Address from an Optimization

ActionStop dropped from a plan.
Input fields[3]
FieldType
OptimizationRequired
choice
Route Destination IDRequired
text
Output fields[3]
FieldType
Statusboolean

Resequence a Route Destination

ActionStop moved in the order.
Input fields[3]
FieldType
RouteRequired
choice
Route DestinationRequired
choice
New Sequence NumberRequired
number
Output fields[3]
FieldType
Route IDtext
Optimization Problem IDtext
Member IDtext
Vehicle Aliastext
Route Costnumber
Route Distance Kmnumber
Trip Distancenumber
Addressesarray
Parameterstext
Created Timestampnumber

Set a GPS Position

ActionPosition report for a driver.
Input fields[3]
FieldType
RouteRequired
choice
UserRequired
choice
LatitudeRequired
number
LongitudeRequired
number
Coursenumber
Speednumber
Device Typechoice
Device IDtext
Output fields[3]
FieldType
Route IDtext
Member IDnumber
Latnumber
Lngnumber
Speednumber
Coursenumber
Timestampnumber

Share a Route

ActionRoute sent to someone by email.
Input fields[3]
FieldType
RouteRequired
choice
Recipient EmailRequired
text
Output fields[3]
FieldType
Statusboolean

Unlink a Route from Its Optimization

ActionRoute cut loose from its source plan.
Input fields[3]
FieldType
RouteRequired
choice
Output fields[3]
FieldType
Route IDtext
Optimization Problem IDtext
Member IDtext
Vehicle Aliastext
Route Costnumber
Route Distance Kmnumber
Trip Distancenumber
Addressesarray
Parameterstext
Created Timestampnumber

Update a Config Setting

ActionRewrites an account setting.
Input fields[3]
FieldType
KeyRequired
text
ValueRequired
text
Output fields[3]
FieldType
Config Keytext
Config Valuetext

Update a Group

ActionEdits a location group.
Input fields[3]
FieldType
GroupRequired
choice
Nametext
Colortext
Icontext
Filter (JSON)text
Clear Fieldschoice
Output fields[3]
FieldType
Group IDnumber
Group Nametext
Group Colortext
Group Icontext
Filtertext

Update a Location

ActionEdits a saved address.
Input fields[3]
FieldType
Location IDRequired
text
Addresstext
Address 2text
Aliastext
Grouptext
First Nametext
Last Nametext
Emailtext
Phonetext
Citytext

8other input fields

Output fields[3]
FieldType
Address IDnumber
Address 1text
Address 2text
Address Aliastext
Address Grouptext
First Nametext
Last Nametext
Address Emailtext
Address Phone Numbertext
Cached Latnumber

2other output fields

Update a Route

ActionEdits settings of a planned route.
Input fields[3]
FieldType
RouteRequired
choice
Route Nametext
Route Datedate
Route Start Time (s)number
Travel Modechoice
Optimize Forchoice
Distance Unitchoice
Vehicle Capacitynumber
Vehicle Max Distancenumber
Additional Fields (JSON)text
Output fields[3]
FieldType
Route IDtext
Optimization Problem IDtext
Member IDtext
Vehicle Aliastext
Route Costnumber
Route Distance Kmnumber
Trip Distancenumber
Addressesarray
Parameterstext
Created Timestampnumber

Update a Route Address

ActionEdits one stop of a route.
Input fields[3]
FieldType
RouteRequired
choice
Route DestinationRequired
choice
Addresstext
Latitudenumber
Longitudenumber
Aliastext
Service Time (s)number
Time Window Start (s)number
Time Window End (s)number
Weightnumber

7other input fields

Output fields[3]
FieldType
Route Destination IDnumber
Route IDtext
Addresstext
Aliastext
Latnumber
Lngnumber
Sequence Nonumber
Is Depotboolean
Is Visitedboolean
Is Departedboolean

4other output fields

Update a Territory

ActionTerritory boundary and color edited.
Input fields[3]
FieldType
TerritoryRequired
choice
Nametext
Colortext
Shapechoice
Center Latitudenumber
Center Longitudenumber
Radius (m)number
Pointsarray
Pointobject
Clear Fieldschoice
Output fields[3]
FieldType
Territory IDtext
Territory Nametext
Territory Colortext
Member IDnumber
Territorytext
Addressesarray
Ordersarray

Update a User

ActionDetails of a team member edited.
Input fields[3]
FieldType
UserRequired
choice
Emailtext
First Nametext
Last Nametext
Passwordsecret
User Typechoice
Phonetext
Zip Codetext
Read-only Userchoice
Hide Routed Addresseschoice

4other input fields

Output fields[3]
FieldType
Member IDnumber
Member Emailtext
Member First Nametext
Member Last Nametext
Member Typetext
Member Phonetext
Member Zipcodetext

Update a Vehicle

ActionSpecs of a fleet vehicle edited.
Input fields[3]
FieldType
VehicleRequired
choice
Aliastext
VINtext
Maketext
Model Yearnumber
Registration Countrytext
Registration Country IDtext
Axle Countnumber
MPG Citynumber
MPG Highwaynumber

7other input fields

Output fields[3]
FieldType
Vehicle IDtext
Vehicle Aliastext
Vehicle VINtext
Vehicle Maketext
Vehicle Model Yearnumber
Fuel Typetext
Vehicle Type IDtext
Has Trailerboolean

Update an Avoidance Zone

ActionZone shape, color and name edited.
Input fields[3]
FieldType
Avoidance ZoneRequired
choice
Nametext
Colortext
Shapechoice
Center Latitudenumber
Center Longitudenumber
Radius (m)number
Pointsarray
Pointobject
Clear Fieldschoice
Output fields[3]
FieldType
Territory IDtext
Territory Nametext
Territory Colortext
Member IDnumber
Territorytext
Addressesarray
Ordersarray

Update an Order

ActionEdits a delivery or pickup job.
Input fields[3]
FieldType
OrderRequired
choice
Addresstext
Address 2text
Address Aliastext
Citytext
Latitudenumber
Longitudenumber
Scheduled Daydate
Time Window Start (s)number
Time Window End (s)number

11other input fields

Output fields[3]
FieldType
Order IDnumber
Address 1text
Address 2text
Address Aliastext
Cached Latnumber
Cached Lngnumber
Day Scheduled For YYMMDDtext
EXT FIELD First Nametext
EXT FIELD Last Nametext
EXT FIELD Emailtext

2other output fields

Update an Order Custom Field

ActionEdits a custom data column.
Input fields[3]
FieldType
Field IDRequired
text
Nametext
Labeltext
Typechoice
Type Info (JSON)text
Output fields[3]
FieldType
Order Custom Field IDnumber
Order Custom Field Nametext
Order Custom Field Labeltext
Order Custom Field Typetext
Order Custom Field Type Infotext

Update Route Address Custom Data

ActionCustom fields stored on a stop.
Input fields[3]
FieldType
RouteRequired
choice
Route DestinationRequired
choice
Custom DataRequired
array
Entryobject
Output fields[3]
FieldType
Route Destination IDnumber
Route IDtext
Addresstext
Aliastext
Latnumber
Lngnumber
Sequence Nonumber
Is Depotboolean
Is Visitedboolean
Is Departedboolean

4other output fields

Upload an Address File

ActionAddress sheet sent to Route4Me.
Input fields[3]
FieldType
FileRequired
text
File NameRequired
text
Output fields[3]
FieldType
Statusboolean
Upload IDtext
Rowsnumber

Look for Route4Me templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Route4Me Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Route4Me.
  4. WEXTL® visual workflow builder data.

Last updated: Nov 14, 2026 14:55

How we write our apps documentation

How we compile these docs: sources, the role of AI, and how we verify.