# Route4Me integration

> Route optimization, dispatch and fleet management API: optimizations, routes, orders, address book, vehicles, tracking and territories.

- Authentication: apiKey

## Tools (243)

- **Activate Vehicles**: Activate the Vehicles from the list of their ids asynchronously.
- **Add a Configuration Key**: Add a configuration key to the member account.
- **Add Addresses to a Route**: Insert addresses into a route at a given sequence number, or at the optimal position.
- **Add an Array of Configuration Keys**: Add several configuration keys at once.
- **Add an Order to an Optimization (v4)**: Insert an existing order into an existing optimization.
- **Add an Order to a Route (v4)**: Insert an existing order into an existing route.
- **Add a Note File**: Add a note to a route through a file upload.
- **Add Custom Data to a User (v4)**: Add or edit custom data of a user.
- **Add Custom Note to Route**: Add a custom-type note to a route destination.
- **Add Custom Note Type**: Add a custom note type to the account.
- **Add Route Notes**: Add a note to a route destination.
- **Assign Routes to Facilities**: Route Facility Assign Request
- **Batch Geocode Addresses (v4)**: Geocode many addresses at once.
- **Bulk Geocode**: bulk geocoding address
- **Bulk Update Facility Custom Data**: Update facilities custom data in bulk
- **Create Address**: Add a new Address Book Contact by sending a body payload with the corresponding parameters.
- **Create Address Book Group**: Add a new Address Book Group by sending a body payload with the corresponding Address Book Group parameters.
- **Create Addresses**: Add multiple new Address Book Contacts by sending a body payload with the array of the corresponding Address parameters.
- **Create a Group**: Add an address book group.
- **Create a Location (v4)**: Add a location to the address book.
- **Create an Avoidance Zone**: Create an avoidance zone of circle, polygon or rectangle shape.
- **Create an Order (v4)**: Add an order to the account.
- **Create a Route**: Create a new route from an existing optimization problem solution.
- **Create a Territory**: Create a territory of circle, polygon or rectangle shape.
- **Create a User (v4)**: Create a sub-user.
- **Create Customer**: Create a customer
- **Create Facility**: create facility
- **Create Location Type**: Create location type
- **Create Master Route**: Create Master Route Request
- **Create Optimization**: Store a new optimization in database.
- **Create Optimization Profile**: Store new Optimization Profile.
- **Create Order**: Create an Order by sending a body payload with the corresponding Order parameters.
- **Create Order Custom Field**: Store new Order Custom Field.
- **Create Order Custom User Field (v4)**: Create a custom user field for orders.
- **Create Orders from Contacts**: Create orders from contacts
- **Create Participant Telematics Connection (v1)**: Create a connection to a telematics vendor for a participant.
- **Create Telematics Connection**: Creates a new vendor connection through the Telematics API.
- **Create Temporal Access Address**: Insert a new temporal access address into the database by sending the corresponding body payload.
- **Create Temporal Access Addresses (Async)**: Insert a new temporal access addresses into the database asynchronously by sending the corresponding body payload.
- **Create Temporary Vehicle**: Create a new temporary Vehicle by sending the corresponding body payload.
- **Create User**: Add a new sub-user to the Member account by sending the corresponding body payload with the sub-users parameters.
- **Create Users**: Add multiple sub-users to the User account by sending the corresponding body payload with the array of the sub-users' parameters.
- **Create Vehicle**: Create a new Vehicle in the user's account by sending the corresponding body payload with the Vehicle parameters.
- **Create Vehicle Capacity Profile**: Create a new Vehicle Capacity Profile.
- **Create Vehicle Profile**: Create a new Vehicle Profile by sending the corresponding body payload with the Vehicle Profile's parameters.
- **Deactivate Vehicles**: Deactivate the Vehicles from the list of their ids asynchronously.
- **Delete Address Book Group**: Delete the Address Book Group by specifying the 'group' path parameter.
- **Delete Addresses**: Delete multiple Address Book Contacts by sending a body payload with the array of the corresponding Address IDs.
- **Delete Addresses (Selected Areas)**: Delete the Address Book Contacts located in the selected areas by sending the corresponding body payload.
- **Delete Current User**: Delete current user.
- **Delete Customer**: Delete a customer
- **Delete Facility**: delete facility
- **Delete Location Type**: Delete location type
- **Delete Optimization**: Remove an optimization from database.
- **Delete Optimization Profile**: Delete Optimization Profile by id.
- **Delete Optimization Profiles**: Delete optimization profiles entities
- **Delete Order Custom Field**: Delete Order Custom Field.
- **Delete Order Custom User Field (v4)**: Delete a custom user field of orders.
- **Delete Participant Telematics Connection (v1)**: Delete a participant telematics connection.
- **Delete Routes by Filters**: Delete routes by filters.
- **Delete Telematics Connection**: Deletes a vendor connection.
- **Delete User**: Delete the sub-user by specifying the path parameter ID.
- **Delete Vehicle**: Delete the Vehicle by specifying the path parameter ID.
- **Delete Vehicle Capacity Profile**: Delete the Vehicle Capacity Profile by its ID.
- **Delete Vehicle Profile**: Delete the Vehicle Profile by specifying the path parameter ID.
- **Delete Vehicle Profiles (Code)**: Delete Vehicle Profiles by the vehicle profile code.
- **Delete Vehicles**: Delete the Vehicles from the list of their ids asynchronously.
- **Deliver Destination Inventory**: Destination Deliver Request
- **Deliver Destination Inventory (Barcode)**: Destination Deliver By Barcode Request
- **Dispatch Routes**: Route Dispatch Request
- **Duplicate a Route**: Duplicate routes with the same metadata and ownership.
- **Execute Order (GET)**: Execute the Vehicle's Order by sending the corresponding body payload with the corresponding location, and Vehicle ID.
- **Execute Order (POST)**: Execute the Vehicle's Order by sending the corresponding body payload with the corresponding location, and Vehicle ID.
- **Filter by Address Book Group ID and cluster output**: Filter ad Cluster the Address Book Contacts by sending the corresponding body payload and by specifying the 'display', 'group_id' and 'precision' query parameters.
- **Filter by Address Book Group ID and output as a list of Addresses**: Filter the Address Book Contacts by sending the corresponding body payload and by specifying the 'display' and 'group_id' query parameters.
- **Filter by Address Book Group rules and output as a list of Addresses**: Filter the Address Book Contacts by the Address Book Group rules by sending the corresponding body payload with the option to filter the Contacts by 'Routed' or 'Unrouted'.
- **Filter by the Address Book Group rules and cluster output**: Filter and cluster the Address Book Contacts by sending a body payload with the option to specify the Address showing option and cluster precision values by the corresponding query parameters.
- **Find Address**: Find an Address by sending the 'address_id' query parameter.
- **Find Address Book Group**: Find the Address Book Group by specifying the 'group' path parameter.
- **Find Addresses**: Find multiple Addresses by sending a body payload with the array of the corresponding Address IDs.
- **Find Best Insertion Positions**: Synchronously find the best positions to insert a new destination into existing routes. Evaluates candidate routes/positions and returns the list of best insertion options inline.
- **Find Best Insertion Positions (Async)**: Asynchronously find the best positions to insert a new destination into existing routes.
- **Forward Geocode**: forward geocoding address (the same as basic geocoding)
- **Forward Geocode Address (v4)**: Convert place names to coordinates.
- **Get Activities by Type**: Get activities of one event type, from all routes or one route.
- **Get Activities by User**: Get the activities of one user.
- **Get Address Book Groups**: Get all Address Book Groups.
- **Get Address Clusters**: Get the Address clusters filtered by the corresponding query text, and with the option to filter the result by the 'routed' and 'unrouted' state.
- **Get Address Clusters (Body Filter)**: Get the Address clusters by sending the corresponding body payload.
- **Get Address Custom Fields**: Get all Address custom fields.
- **Get Address Notes**: Get the notes of a route destination.
- **Get All Activities**: Get recorded activities for the account, paged by `limit`/`offset`.
- **Get All User Locations**: Get the locations of all users.
- **Get an Address from a Route**: Get one destination from a route.
- **Get a Route**: Get a single route with optional extras.
- **Get Asset Tracking Data**: Get the status of a package by its tracking number.
- **Get Avoidance Zones**: Get all avoidance zones, or one by `territory_id`.
- **Get Clustered Locations**: Get clustered locations
- **Get Configuration Data**: Get all configuration data, or one key via `config_key`.
- **Get Contacts by Group**: Get the address book contacts in a group.
- **Get Current Member Information**: Display the current Member information.
- **Get Customer**: Get a customer by ID
- **Get Custom Note Types**: Get all custom note types.
- **Get Depots Addresses**: Get depots Addresses.
- **Get Device Location History**: Get the last location history of a route device, or the history within a time range.
- **Get Facilities Custom Data**: Get facilities custom data by facility IDs
- **Get Facility**: Get facility by it ID
- **Get Facility Custom Data**: Get custom data for a facility
- **Get Facility Type**: facility type details
- **Get Groups**: Get address book groups, or one by `group_id`.
- **Get Last Activities**: Get activities recorded after a time.
- **Get Last Scheduled Route (Member)**: Get last scheduled by today route information by member id
- **Get Last Scheduled Route (Vehicle)**: Get last scheduled by today route information by vehicle id
- **Get Location Heatmap**: Get a heat map of the locations
- **Get Location Service-Time Heatmap**: Get a location service-time heatmap
- **Get Locations (v4)**: Get, search or page address book locations.
- **Get Location Type**: Get location type by Id
- **Get Multiple Routes**: Get routes in the account, paged by `limit`/`offset` or filtered by a date range.
- **Get Optimization Profile**: Get Optimization Profile by id.
- **Get Optimization Profiles**: Get optimization profiles entities
- **Get Optimization Profiles Template**: Get optimization profiles entities template
- **Get Order Custom User Fields (v4)**: Get all custom user fields of the order entity.
- **Get Order History**: Display the order history.
- **Get Orders (v4)**: Get orders in the account: one or several by ID, by date, with field selection, or by text search.
- **Get Participant Telematics Connection (v1)**: Get a participant telematics connection.
- **Get Route Info**: Get Route Info By Route Id
- **Get Route Path Points or Directions**: Return a route with path points or directions.
- **Get Route Settings**: Get Route Settings
- **Get Route With Tracking History**: Get a route including its device tracking history.
- **Get Schedule Calendar**: Get scheduled events from the account.
- **Get Simple Order History**: Display the simple order history.
- **Get Team Activities on a Route**: Get activities for a route, including team members.
- **Get Territories**: Get all territories, or one by `territory_id`.
- **Get Territories with Location Counts**: Get territories with the number of locations
- **Get User**: Get the sub-user by specifying the path parameter ID.
- **Get User Details (v4)**: Get a user by `member_id`.
- **Get User Modification History**: Get user modification history.
- **Get User Template**: Get the template of sub-user.
- **Get Vehicle**: Get the Vehicle by specifying the path parameter ID.
- **Get Vehicle Capacity Profile**: Get a Vehicle Capacity Profile by its ID.
- **Get Vehicle Confirmation**: Get vehicle confirmation.
- **Get Vehicle Profile**: Get the Vehicle Profile by specifying the path parameter ID.
- **Get Vehicle Profile (Code)**: Get the Vehicle Profile by specifying vehicle profile code.
- **Get Vehicle Profile (License Plate)**: Get the Vehicle Profile by license plate.
- **Get Vehicle Track**: Get the Vehicle track by specifying the path parameter ID.
- **Insert an Address into an Optimization**: Insert addresses into an optimization, which recalculates the optimal routes.
- **Insert Route Tracking Data**: Set the GPS position of a device.
- **Latest Vehicle's Locations**: Get the latest know vehicle's locations.
- **List Addresses**: Get all Addresses filtered by specifying the corresponding query parameters.
- **List Addresses (Paginated)**: Get a paginated list of all Addresses.
- **List Archive Orders**: Display the Archive Orders.
- **List Customers**: Get list with customers data
- **List Facilities**: Get facilities
- **List Facility Types**: facility types list
- **LIst Locations**: Get list with locations data
- **List Location Types**: Get location types
- **List Member's Territories**: Display the list of Member's territories.
- **List Optimization Profiles**: Get Optimization Profiles.
- **List Optimizations**: Get a list of all the optimizations or single optimization if the parameter idParam is specified.
- **List Order Custom Fields**: Get all Order Custom Fields.
- **List Orders**: Display the Orders.
- **List Root Members (Customer Support)**: Display the list of Root Members for customer support user.
- **List Route Directions**: Get Directions
- **List Routes**: Get route list.
- **List Sub-users (v4)**: View sub-users in the member account.
- **List Telematics Connections**: Proxies the Telematics API GET /connections endpoint.
- **List Telematics Connections (v1)**: List active telematics connections from the Telematics Gateway.
- **List Users**: View all existing sub-users associated with the Member’s account.
- **List Users by IDs**: Get the sub-users by Member IDs.
- **List Users (Paginated)**: Display the list of Members with pagination.
- **List Vehicle Profiles**: Get the list of Vehicle Profiles.
- **List Vehicles**: Get the paginated list of Vehicles.
- **List Vehicles (Paginate)**: Get the paginated list of Vehicles.
- **Log a Specific Message**: Store a message in the activity feed, for example for a chat solution.
- **Mark Address as Departed**: Mark a route destination as departed.
- **Mark Address as Detected as Departed**: Mark a route address as detected as departed.
- **Mark Address as Detected as Visited**: Mark a route address as detected as visited.
- **Mark Address as Visited**: Mark an address as visited.
- **Merge Routes**: Merge the destinations of several routes into one new route with a new route ID.
- **Move a Destination into a Route**: Move a destination to another route, or within the same route.
- **Patch Telematics Connection**: Applies partial updates by proxying the Telematics API PATCH
- **Preview Route Assignment**: Route Assign Preview Request
- **Remove a Configuration Key**: Remove a configuration key.
- **Remove a Group**: Remove an address book group.
- **Remove an Address from an Optimization**: Remove a destination from an optimization problem.
- **Remove an Address from a Route**: Remove an address from a route.
- **Remove an Avoidance Zone**: Delete an avoidance zone.
- **Remove a Territory**: Delete a territory.
- **Remove a User (v4)**: Remove a sub-user from the member account.
- **Remove Locations (v4)**: Remove locations from the address book.
- **Remove Orders (v4)**: Remove one or more orders.
- **Remove Routes**: Delete several routes at once, bound to the authenticated member.
- **Re-run Optimization**: Re-optimize an optimization by changing route parameters and/or addresses.
- **Resequence a Route Destination**: Move one destination to a new position in a route.
- **Reverse Geocode**: geocoding by coordinates to get address information
- **Reverse Geocode Address (v4)**: Get address names from a latitude/longitude point.
- **Search Addresses**: Get all Addresses filtered and sorted by sending the corresponding body payload, with the option to search by the specified areas.
- **Search Addresses (Paginated)**: Get the paginated list of all Addresses filtered and sorted by sending the corresponding body payload, with the option to search by the specified areas.
- **Search Optimization Profiles**: Get optimization profiles
- **Search Routes**: Search all routes in the account for text.
- **Search User Locations**: Search user locations by query text (email, name, member ID).
- **Search Vehicle**: Search for the Vehicle by sending the corresponding body payload with Vehicles ids and location.
- **Search Vehicle by Location**: Search for the Vehicle by sending the corresponding body payload with Vehicles ids and location.
- **Set Route Rating**: Set route rating.
- **Share a Route**: Share a route by email.
- **Sort Address Book Groups**: Change address book groups positions (group sort order) by sending a body payload with the all group ids (hex) in the new sorting order.
- **Sync Pending Vehicle**: Sync the Vehicle by sending the corresponding body payload with the Vehicle's parameters and by specifiying vehicle_alias, r4m_telematics_gateway_connection_id and r4m_telematics_gateway_vehicle_id
- **Track Vehicle Confirmation**: Track Vehicle Confirmation.
- **Update a Configuration Key Value**: Update a configuration key value.
- **Update Address**: Update the Address Book Contact by specifying the 'address_id' path parameter and by sending a body payload with the corresponding Address parameters.
- **Update Address Book Group**: Update the Address Book Group by specifying the 'group' path parameter and by sending a body payload with the corresponding Address Book Group parameters.
- **Update Addresses**: Update multiple Address Book Contacts by sending a body payload with the array of the corresponding Address IDs and Address parameters.
- **Update Addresses (Async)**: Asynchronous updating multiple Address Book Contacts by sending a body payload with the array of the corresponding Address IDs and Address parameters.
- **Update Addresses (Selected Areas)**: Update Address Book Contacts by sending a body payload with the corresponding query text and specified territory areas.
- **Update a Group**: Update an address book group.
- **Update a Location (v4)**: Update an address book location.
- **Update an Avoidance Zone**: Update an avoidance zone.
- **Update an Order (v4)**: Update an order by the values passed, including custom data.
- **Update a Route**: Update route parameters, recompute directions, or unlink the route from its master optimization.
- **Update a Route Destination**: Update a destination of a route; also used to set its custom data.
- **Update a Territory**: Update a territory.
- **Update a User (v4)**: Update an existing user.
- **Update Customer**: Update a customer
- **Update Facility**: update facility
- **Update Facility Custom Data**: Update facility custom data
- **Update Location Type**: Update location type
- **Update Optimization Profile**: Update Optimization Profile.
- **Update Optimization Profiles**: Save optimization profiles entities
- **Update Order**: Update the specified Order in the storage by sending the body payload with the specified 'order_id' parameter.
- **Update Order Custom Field**: Update Order Custom Field.
- **Update Order Custom User Field (v4)**: Update a custom user field of orders.
- **Update Participant Telematics Connection (v1)**: Update the name of a participant telematics connection.
- **Update Route**: Route Assign Request
- **Update Routes**: Route Assign Request
- **Update Route Settings**: Update Route Settings
- **Update Telematics Connection**: Updates an existing connection using the Telematics API PUT.
- **Update User**: Update the sub-user by specifying the path parameter ID and by sending the corresponding body payload with the sub-user's parameters.
- **Update Vehicle**: Update the Vehicle by specifying the path parameter ID and by sending the corresponding body payload with the Vehicle's parameters.
- **Update Vehicle Profile**: Update the Vehicle Profile by specifying the path parameter ID and by sending the corresponding body payload with the Vehicle Profile's parameters.
- **Update Vehicle Profile (Code)**: Update the Vehicle Profile by the vehicle profile code.
- **Update Vehicles**: Update the Vehicle list asynchronously by sending the corresponding body payload with the Vehicles list with their parameters.
- **Validate a Session**: Check whether a session is valid.
- **Vehicles Restore**: Restore the Vehicles from the list of their ids asynchronously.

Connect Route4Me in General Input: https://www.generalinput.com/apps/route4me