Route4me

Tool to retrieve a specific avoidance zone by its territory ID. Use when you need detailed information about a particular avoidance zone for route planning or validation.

Tool to retrieve locations grouped by geographic proximity using geohash clustering. Use when you need to view locations organized by area or analyze spatial distribution of address book entries.

Tool to retrieve the current authenticated member's information. Use when you need to get details about the logged-in user including contact information, preferences, permissions, and account status.

Tool to retrieve the most recently scheduled route for a specific member as of today. Use when you need route details including waypoints, optimization settings, and delivery metrics for a team member.

Tool to get member configuration settings with optional filtering. Use when you need to retrieve specific configuration settings by mcs or config_key parameters.

Tool to retrieve all custom note types configured for the account. Use when you need to view available note classification options before adding notes to routes or addresses.

Tool to retrieve detailed information about an optimization profile by its unique identifier. Use when you need to view the configuration settings, constraints, and optimization parameters of a specific profile before creating or planning routes.

Tool to get a route address/destination by its ID. Use when you need detailed information about a specific route stop including location, status, customer details, and delivery data.

Tool to get detailed route information by route ID. Use when you need comprehensive details about a specific route including waypoints, optimization settings, delivery details, and turn-by-turn directions.

Tool to retrieve a list of routes with filtering and pagination. Returns detailed route information including status, assignments, destinations, distances, and delivery metrics. Use when you need to query routes by various criteria such as date, vehicle, driver, or status.

Tool to get route settings with detailed information including waypoints, optimization settings, and delivery details. Use when you need comprehensive configuration data for a specific route including all stops, delivery parameters, and optimization settings.

Tool to retrieve territories with location counts for geographic analysis. Use when you need to analyze address distribution across territories or understand coverage areas.

Tool to retrieve territory information by ID or get all territories. Use when you need details about geographic zones and their boundaries.

Tool to export tracking history file from Route4Me. Use when you need to retrieve device location history for analysis, reporting, or compliance purposes. Supports filtering by device, member, route, and time range.

Tool to retrieve a sub-user by their unique ID. Use when you need detailed information about a specific team member including their permissions, settings, and profile data.

Tool to retrieve authenticated user information in v4 format. Use when you need to get details about the currently authenticated user including member ID, email, name, account type, and preferences.

Tool to view locations of all users/drivers in real-time. Use when you need to track where drivers are currently located or monitor their movement.

Tool to retrieve the template of a sub-user with detailed information including contact information, preferences, and account status. Use when you need to get the user template structure or default user configuration.

Tool to retrieve vehicle capacity profiles in datatable format with pagination. Use when you need to view capacity profiles for vehicles including weight, volume, revenue, and items limits.

Tool to retrieve a specific vehicle capacity profile by its ID. Use when you need details of a particular capacity profile for route planning or vehicle configuration.

Tool to retrieve vehicle capacity profile page configuration including unit settings. Use when you need to understand available units for volume, weight, and revenue in vehicle capacity profiles.

Tool to retrieve vehicle capacity profiles with weight, volume, and item constraints. Use when you need to view available capacity profiles for route planning or vehicle assignment.

Tool to retrieve details of vehicles in the organization. Use when you need the full list of vehicles before planning routes or auditing vehicle capacities.

Tool to retrieve optimization profiles with settings and configuration details. Use when you need to view available optimization profiles, check profile settings, or select a profile for route optimization.

Tool to get a list of all optimizations or retrieve a single optimization by ID. Use when you need to view optimization details, check optimization status, or filter optimizations by state or date range.

Tool to retrieve all order custom field definitions from Route4Me v5.0 API. Use when you need to understand what custom fields are available for orders, including their types, labels, and configuration details.

Tool to get detailed route directions including turn-by-turn navigation information for each stop. Use when you need comprehensive direction details for a specific route including stop sequences, addresses, coordinates, and status information.

Tool to get the list of team members/users in the account. Use when you need to view all members, their roles, permissions, and contact information.

Tool to get a paginated list of team members/users in the account. Use when you need to retrieve team members with pagination support, search filtering, or when dealing with large teams where retrieving all users at once is not practical.

Tool to retrieve detailed information about team members by their member IDs. Use when you need to get specific user details for one or more members by their IDs.

Tool to lookup optimal routes for inserting a new destination. Use when you need to find the best existing route(s) to add a new stop to, based on distance or time optimization.

Tool to generate a preview of route assignments based on filters, grouping, sorting, and assignment strategy without applying changes. Returns grouped results and subtotals for review before actual assignment.

Tool to reverse geocode coordinates to obtain an address. Use when you need to convert latitude/longitude coordinates into a human-readable street address.

Tool to retrieve datatable configuration for vehicle capacity profiles. Use when you need to display vehicle capacity profiles in a datatable UI component with column definitions, filters, and action configurations.

Tool to geocode an address by sending a body payload with the address and options. Use when you need to convert an address string into geographic coordinates (latitude/longitude).

Tool to convert an address to geographic coordinates using forward geocoding. Use when you need latitude/longitude from an address string for route planning or location-based services.

Tool to retrieve a heat map of location clusters from the address book. Use when visualizing location density or analyzing geographic distribution of stops.

Tool to retrieve location service-time heatmap data for address book locations. Use when analyzing historical service times and performance metrics for specific locations over a trailing 30-day period.

Tool to get location type details by ID. Use when you need to retrieve specific information about a location type in the address book.

Tool to get user modification history from Route4Me. Returns detailed audit trail of changes made to a user's account including field modifications, timestamps, and who initiated the changes. Use when you need to track user account changes or audit user information updates.

Tool to retrieve location type definitions used in the address book system. Use when categorizing addresses or locations in Route4Me.

Tool to create a new route optimization in Route4Me. Use when you need to optimize delivery routes, plan multi-stop trips, or generate efficient vehicle routing solutions.

Tool to create a new territory with circular, rectangular, or polygon shape. Use when you need to define geographic regions for route planning, service areas, or operational zones.

Tool to create a vehicle capacity profile with weight, volume, item count, and revenue limits. Use when you need to define operational constraints for vehicles in route planning and fleet management.

Tool to duplicate one or more existing routes. Use when you need to create copies of routes for similar deliveries or to use an existing route as a template.

Tool to submit device GPS tracking information to Route4Me. Use when you need to send location updates from a mobile device or tracking unit to the Route4Me platform.

Tool to update an existing location type in the address book. Use when you need to modify location type details such as name, parent/child type status, or description.

Tool to update a member configuration setting. Use when you need to modify account-level configuration values such as notification preferences, feature flags, or service provider settings.

Tool to update an existing optimization profile. Use when you need to modify routing preferences, constraints, or settings for route optimization.

Tool to update an existing order custom field in Route4Me. Use when you need to modify the label, type, or configuration of a custom field for orders.

Tool to update route settings including optimization parameters, distance units, and device types. Use when you need to modify route configuration such as optimization criteria, distance measurement units, or device-specific settings.

Tool to update route parameters and addresses in Route4Me. Use when you need to modify route name, optimization settings, duration constraints, or reassign routes to team members.

Tool to bulk update multiple routes in a single operation. Use when you need to update route names, optimization settings, duration constraints, or reassign multiple routes to team members efficiently.

Tool to update an existing territory. Use when you need to modify the name, color, or geographic boundaries of a territory for route planning and organization.

Tool to update an existing vehicle capacity profile by ID. Use when you need to modify capacity constraints such as weight, volume, item count, or revenue limits for a specific vehicle profile.

Tool to delete a territory by territory_id. Use when you need to remove a specific territory from the system.

Tool to delete a vehicle capacity profile by ID. Use when you need to remove a specific vehicle capacity profile from the system.