Built by Metorial, the integration platform for agentic AI.
Add a new vehicle to your fleet with its properties and constraints.
Delete an avoidance zone. This action is permanent.
Create a new territory for organizing operations geographically. Define the territory as a circle, polygon, or rectangle.
List all territories or retrieve a specific one. Territories define service areas for organizing operations geographically.
Update an existing order's properties such as address, customer info, scheduling, or custom fields.
Update an existing contact in the address book.
Delete a route by ID. This action is permanent and cannot be undone.
List all avoidance zones or retrieve a specific one. Avoidance zones are geographic areas that routes should avoid during optimization.
Create a new avoidance zone. Routes will avoid this geographic area during optimization. Define the zone as a circle, polygon, or rectangle.
Remove a team member from your account. This action is permanent.
Search and retrieve contacts from the address book. Supports filtering by query text and retrieving specific contacts by ID.
Remove a vehicle from your fleet. This action is permanent.
Add a new team member to your account. Specify their role, contact info, and permissions. Supported member types: "PRIMARY_ACCOUNT" (owner), "SUB_ACCOUNT_ADMIN", "SUB_ACCOUNT_REGIONAL_MANAGER", "SUB_ACCOUNT_DISPATCHER", "SUB_ACCOUNT_PLANNER", "SUB_ACCOUNT_DRIVER", "SUB_ACCOUNT_ANALYST".
Retrieve an optimization problem by ID, or list all optimizations. Returns the optimization state, routes, and addresses. Use this to check optimization status, retrieve computed routes, or browse all optimizations.
Create a new order for route planning. Orders represent customer deliveries or pickups that can be optimized into routes.
Convert a street address to geographic coordinates (forward geocoding) or convert lat/lng to a street address (reverse geocoding). Provide either an address string for forward geocoding, or lat/lng for reverse geocoding.
Delete a territory. This action is permanent.
Delete one or more orders by their IDs. This action is permanent.
Retrieve activities from the activity feed. The activity feed is an audit log of all routing-related events: route optimization, stop changes, driver arrivals, geofence events, notes, member changes, and more. Filter by route, activity type, or time range.
List all vehicles in your fleet, or retrieve a specific vehicle by ID. Returns vehicle properties, capacity, and constraints.
Retrieve the list of team members (users) associated with your account. Returns member details including roles and contact info.
Retrieve a single order by ID or list orders. Returns order details including address, customer info, and scheduling.
Retrieve the Route4Me member associated with the connected API key, including their ID, role, and contact information.
Add a new contact to the address book. Contacts serve as reusable destinations for route planning.
Retrieve notes for a specific stop/address on a route. Returns all notes including text content and metadata.
Retrieve a single route by ID or list all routes. Returns route details including stops, directions, and tracking info.
Update an existing vehicle's properties and constraints.
Create and solve a route optimization problem. Provide a set of addresses/destinations with constraints and Route4Me will calculate optimal routes. Supports multiple algorithm types including TSP, CVRP with time windows, and multi-depot scenarios. Returns the optimized routes with sequenced stops.
Update a route's properties, resequence stops, add addresses, or remove an address. Choose one type of edit per call. Route name, member, and vehicle properties can be updated together.
Report a GPS position for a device. Used to update the current location of a driver/device for real-time tracking.
Add a text note to a stop/address within a route. Notes are commonly used by drivers for proof of delivery, status updates, and other annotations.
Update an existing team member's profile, role, or permissions.
Create a copy of an existing route. The duplicated route will have a new route ID but contain the same stops and settings.
Delete one or more contacts from the address book. This action is permanent.
Retrieve GPS tracking history for a specific route. Returns the recorded location data points for the device that was tracked on the route.