Route4me

These are the Route4me actions available to the apps you build with Snow. Connecting an account does not make Snow run these on its own.

• Add Order Custom Field

  Tool to add a new custom field definition for orders. Use when you need to create additional data fields to capture order-specific information beyond the standard order properties.

• Add Route Note

  Tool to add a note to a route or address destination. Use when recording delivery status, customer feedback, or activity logs at specific stops.

• Bulk Geocode Addresses

  Tool to geocode multiple addresses in a single request. Use when you need latitude/longitude coordinates for multiple addresses at once before creating routes or destinations.

• Create Address

  Tool to add a new address to the address book. Use when you need to create a new contact location for route planning or delivery management.

• Create Avoidance Zone

  Tool to create an avoidance zone with circular, rectangular, or polygon shape. Use when you need to define geographic regions that routes should avoid, such as construction areas, restricted zones, or traffic-prone regions.

• Create Custom Note Type

  Tool to create a new custom note type in Route4me. Use when you need to define a new category of notes with predefined selectable values for route destinations or activities.

• Create Location Type

  Tool to create a new location type in the address book. Use when you need to categorize locations with custom types before adding them to routes.

• Create Master Route

  Tool to create a new master route in Route4Me. Use when you need to create a route with waypoints, optimization settings, and delivery details.

• Create Optimization Profile

  Tool to create a new optimization profile in Route4Me. Use when you need to store reusable optimization settings for route planning with specific configurations like driver assignment, vehicle settings, constraints, and preferences.

• Create Order Custom Field

  Tool to create a new custom field definition for orders. Use when you need to define new custom data fields that can be attached to orders for tracking additional information beyond standard order fields.

• Create Orders from Contacts

  Tool to create orders from address book contacts. Use when you need to generate new orders from existing contacts for a specific delivery date.

• Create Route Optimization

  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.

• Create Territory

  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.

• Create Vehicle Capacity Profile

  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.

• Delete Address from Route

  Tool to delete an address from a route. Use when you need to remove a specific destination from an optimization problem or route.

• Delete Addresses

  Tool to delete addresses from the Route4Me address book. Use when you need to remove one or more addresses permanently from the address book.

• Delete Avoidance Zone

  Tool to delete an avoidance zone by territory_id. Use when you need to remove a specific avoidance zone from the routing system.

• Delete Configuration Setting

  Tool to delete a member configuration setting by config_key. Use when you need to remove a specific configuration setting from the account.

• Delete Current User

  Tool to delete the current authenticated user account. Use when you need to permanently remove the current user's account including contact information, preferences, and account status. This action is irreversible.

• Delete Location Type

  Tool to delete a location type from the address book. Use when you need to remove a location type record with its associated details such as coordinates, address, and metadata.

• Delete Optimization

  Tool to remove optimization problems from the Route4Me database. Use when you need to clean up or delete optimization records that are no longer needed.

• Delete Optimization Profile

  Tool to delete an optimization profile by ID. Use when you need to remove a specific optimization profile record from the system.

• Delete Order Custom Field

  Tool to delete an order custom field by ID. Use when you need to remove a custom field definition from order records.

• Delete Route V4

  Tool to delete one or more routes by route_id. Use when you need to permanently remove routes from the system. Supports single or multiple route deletion via comma-separated route_ids.

• Delete Territory

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

• Delete Vehicle Capacity Profile by ID

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

• Dispatch Routes

  Tool to approve or revoke routes for execution in Route4Me. Use when you need to set approval status for routes based on filters like route ID, vehicle ID, member ID, route status, or schedule date.

• Duplicate Routes

  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.

• Find Address

  Tool to retrieve detailed information about a specific address from the Route4Me address book. Use when you need to look up address details, contact information, or service requirements by address ID.

• Geocode Address

  Tool to geocode an address and obtain its coordinates. Use when you need latitude/longitude for an address string before creating routes or destinations.

• Get Activity Feed

  Tool to retrieve activities from the Route4Me activity feed with optional filtering and pagination. Use when you need to track changes, monitor team actions, or audit route modifications.

• Get Activity Feed

  Tool to retrieve all activities from the Route4Me activity feed. Use when you need to view activity history, track changes to routes, or monitor team member actions.

• Get Address

  Tool to get address/destination information from a route. Use when you need details about a specific stop including coordinates, status, contact information, and delivery data.

• Get Address Book Groups

  Tool to retrieve address book groups from Route4Me. Use when you need to list all address book groups for filtering or organizing contacts.

• Get Addresses from Address Book

  Tool to retrieve addresses from the Route4Me address book. Use when you need to list contacts, search for specific addresses, or paginate through the address book. Supports filtering by address IDs and pagination with limit/offset.

• Get All Territories (Avoidance Zones v5)

  Tool to retrieve all avoidance zones (territories) using API v5.0. Use when you need to view existing territories for route planning, optionally filtered by geographic location and distance.

• Get Async Export Tracking History

  Tool to save tracking history file via async export. Use when you need to export device tracking data in CSV, JSON, or XML format. The operation is asynchronous and returns a job ID for tracking the export progress.

• Get Avoidance Zone By ID

  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.

• Get Clustered Locations

  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.

• Get Current Member Information

  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.

• Get Last Scheduled Route for Member

  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.

• Get Member Configuration Settings

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

• Get Note Custom Types

  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.

• Get Optimization Profile

  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.

• Get Route Destination By ID

  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.

• Get Route Info

  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.

• Get Route List

  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.

• Get Route Settings

  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.

• Get Territories with Location Counts

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

• Get Territory

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

• Get Tracking History Export

  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.

• Get User By ID

  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.

• Get User Information (v4)

  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.

• Get User Locations

  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.

• Get User Template

  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.

• Get Vehicle Capacity Profile As Datatable

  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.

• Get Vehicle Capacity Profile by ID

  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.

• Get Vehicle Capacity Profile Page Config

  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.

• Get 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.

• Get Vehicles

  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.

• List Optimization Profiles

  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.

• List Optimizations

  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.

• List Order Custom Fields

  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.

• List Route Directions

  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.

• List Team Users

  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.

• List Team Users (Paginated)

  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.

• List Users By IDs

  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.

• Lookup For New Destination

  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.

• Merge Routes

  Tool to merge multiple routes into a single target route. Use when consolidating routes to optimize delivery operations or reduce the number of active routes.

• Move Route Destination

  Tool to move a destination from one route to another. Use when reorganizing routes or reassigning stops between different routes.

• Preview Route Assignment

  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.

• Re-run Optimization

  Tool to re-optimize an existing optimization problem by updating route parameters and/or addresses. Use when you need to modify an existing route optimization with new parameters or address changes.

• Reverse Geocode Address

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

• Set Destination Status

  Tool to set or update the status of a route destination. Use after confirming deliveries to mark stops as visited or departed.

• Set Route Rating

  Tool to set a rating for a route. Use when you need to record user feedback or satisfaction level for a completed route.

• Set Route Tracking Data

  Tool to insert tracking data for a route. Use when you need to update the real-time location and status of a vehicle or driver on a route.

• Submit Device Tracking Data

  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.

• Update Address

  Tool to update an existing address in the Route4Me address book. Use when you need to modify contact details, location information, or time windows for an address.

• Update Avoidance Zone

  Tool to update an existing avoidance zone. Use when you need to modify the name, color, or geographic boundaries of an avoidance zone for route planning.

• Update Custom Note Type

  Tool to update an existing custom note type in Route4Me. Use when you need to modify the name or values of a custom note type.

• Update Location Type

  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.

• Update Member Configuration Setting

  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.

• Update Optimization Profile

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

• Update Order Custom Field

  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.

• Update Route Settings

  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.

• Update Route V4

  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.

• Update Routes

  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.

• Update Territory

  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.

• Update Vehicle Capacity Profile By ID

  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.

• Display Datatable Config

  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.

• Geocode Address (Body)

  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).

• Geocode Address Forward

  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.

• Get Location Heatmap

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

• Get Location Service-Time Heatmap

  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.

• Get Location Type

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

• Get User Modification History

  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.

• List Location Types

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