Platform APIs
This section provides a brief overview of the Route4Me API endpoints.
For detailed descriptions of each API endpoint, including all parameters, responses, and code examples, see the complete API reference.
For detailed real-world examples addressing various business needs, see the API tutorials.
The Route4Me API provides a wide range of features for route planning and optimization and logistics management.
Available APIs
Optimizations
Create, retrieve, update, and remove optimizations or perform re-optimization.
An optimization problem is a set of addresses to visit, and a solution to an optimization problem gives a set of routes based on various constraints for each address and depot.
See Optimisations API Reference
Routes
Create, update, search, retrieve, merge, duplicate, resequence, share, and remove routes, or get the schedule calendar.
A route is a collection of addresses to be visited by a single vehicle in the optimal sequence within a specific period. The route sequencing depends on the attributes, constraints, and metadata of each address.
Orders
Create, retrieve, update, and remove orders or add them to routes and optimizations.
An order is a request for a freight delivery to a party. To improve integration with various e-commerce platforms, Route4Me allows you to get, add, update, and remove custom fields for orders.
Addresses
Mark addresses either as visited, departed, detected as visited, or detected as departed.
An address is a location of a stop or destination. It usually contains street name and number, city, state, country, and ZIP Code.
Geocoding
Forward geocode, reverse geocode, and batch geocode addresses.
Geocoding converts addresses into geographic coordinates to place them as markers on a map or performs the reverse conversion.
Tracking
Retrieve asset and route tracking data, insert route tracking data, get all user locations, and search user locations.
GPS tracking is location surveillance to remotely track an object's coordinates, speed, and course.
Members
Create, update, remove, and authenticate users, view account sub-users, validate sessions, register Route4Me accounts, get user details, add custom data to users, or add, retrieve, update, and remove configuration keys in member accounts.
A member is an authorized user of the Route4Me API.
Notes
Add and retrieve route notes, upload note files, add custom notes to routes, or add and retrieve custom route types.
A note is a piece of information that is attached to an address or a route.
Vehicles
Create, retrieve, update, and remove vehicles or assign them to routes.
A vehicle is a mode of transportation that belongs to an account and is assigned to a route.
Commercial Routing
Create trucks in your account and optimize routes for trucking operations.
A truck is a large and powerful vehicle that may be configured to mount specialized equipment. Trucking services require special considerations, such as truck size, the presence of hazardous materials, trailer type and parameters, and local transportation rules for trucking.
See Commercial Routing API Reference
Activity Feed
Retrieve activities: all or last, related to a team on the route, a user, or a specific event, or log a message to the activity feed (e.g., for two-way chatting).
The activity feed is a record of all routing events in your account: route, optimization and address modifications, events related to drivers, and more.
Address Book
Create, retrieve, update, search, and remove address book locations.
An address book is a repository for user locations.
See Address Book API Reference
Address Book Group
Create, retrieve, update, and remove groups, or get contacts by group.
An address book group is used to search and group the address book contacts.
See Address Book Group API Reference
Avoidance Zones
Create, retrieve, update, and remove avoidance zones.
An avoidance zone is a geographic area to avoid in a route. A user defines the avoidance zones for the optimization algorithm.
See Avoidance Zones API Reference
Territories
Create, retrieve, update, and remove territories.
A territory consists of smaller areas that are combined. For instance, a sales territory could be a group of zip code areas, counties, or states, and a school district could be a group of blocks or streets.
Telematics
Create, retrieve, list, update, and remove telematics connections.
A telematics connection links your account in the Operational Assessment system and your telematics vendor. It allows you to import and synchronize the data with telematics vendors such as Verizon Connect, Geotab, Samsara, Azuga, and Fleet Complete.
Last updated