The Route4Me connector lets your AI agent act in each user's Route4Me account. Each user connects their own Route4Me API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 54 tools.
- Tools
- 54
- What they doRead · write · destructive
- 23 · 21 · 1023 read21 write10 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Route4Me connection
In AgentKit > Connections, create a Route4Me connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'route4me'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Route4Me:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'route4me_activities_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "route4me"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Route4Me:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="route4me_activities_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Route4Me credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolroute4me_activities_listList activity feed events (stops visited/departed, routes optimized, notes added, members changed, geofence events...), optionally for one route or type.Read-onlyList Activities
List activity feed events (stops visited/departed, routes optimized, notes added, members changed, geofence events...), optionally for one route or type. Returns results (activities with activity_id, activity_type, activity_message, route_id, member and timestamp) and total. Use this to audit what happened. Use route4me_activity_log to add a message.
Inputs
activity_typestring- Only this type, e.g. mark-destination-visited, mark-destination-departed, route-optimized, note-insert, insert-destination, delete-destination, route-delete, member-created, geofence-entered, user_message. Example: mark-destination-visited.
limitinteger- Number of records to return. Example: 20.
offsetinteger- Number of records to skip. Example: 0.
route_idstring- Only activities for this route. Example: 5C15E83A4BE005BCD1537955D28D51D7.
teamboolean- true for team activities on the route. Example: true.
route4me_avoidance_zone_getGet one avoidance zone (an area routes must avoid).Read-onlyGet Avoidance Zone
Get one avoidance zone (an area routes must avoid). Returns its name, color and shape. Use this when you know the ID.
Inputs
territory_idstringrequired- Avoidance zone ID. Example: 596A2A44FE9FB19EEB9C3C072BF2D0BE.
route4me_avoidance_zones_listList avoidance zone areas.Read-onlyList Avoidance Zones
List avoidance zone areas. Returns items with territory_id, territory_name, territory_color and territory shape. Use this to find IDs. Use route4me_avoidance_zone_get for one.
Inputs
This tool takes no inputs.
route4me_geocodeGeocode one or more addresses (separated by new lines) or reverse-geocode a lat,lng pair.Read-onlyGeocode Addresses
Geocode one or more addresses (separated by new lines) or reverse-geocode a lat,lng pair. Returns geocoding results with address, lat, lng and type. Use this to get coordinates before creating orders or optimizations.
Inputs
addressesstringrequired- Address(es) or a latitude,longitude pair. Example: Los Angeles International Airport, CA.
formatstring- Response format. Example: json.one of
jsonxml
route4me_location_group_getGet one address book group.Read-onlyGet Location Group
Get one address book group. Returns the group's name, color and filter. Use this when you know the ID.
Inputs
group_idstringrequired- Group ID. Example: 4F39929B6A8A9D3E9A6B2B9F6B5C2E11.
route4me_location_groups_listList address book groups (saved filters of locations).Read-onlyList Location Groups
List address book groups (saved filters of locations). Returns groups with group_id, group_name, group_color and filter. Use this to find a group_id.
Inputs
limitinteger- Number of records to return. Example: 20.
offsetinteger- Number of records to skip. Example: 0.
route4me_locations_getGet address book locations by ID.Read-onlyGet Locations by ID
Get address book locations by ID. Returns the locations. Use this when you know the IDs.
Inputs
address_idstringrequired- Location ID, or several separated by commas. Example: 37023651.
route4me_locations_listList or search address book locations.Read-onlyList Locations
List or search address book locations. Returns results (locations with address_id, address_1, coordinates, alias, contact) and total. Use this to browse or search. Use route4me_locations_get for specific IDs.
Inputs
displaystring- routed for locations already in routes, unrouted for the rest, all (default). Example: all.one of
allroutedunrouted fieldsstring- Comma-separated fields to return. Example: address_id,address_1,address_alias.
limitinteger- Number of records to return. Example: 20.
offsetinteger- Number of records to skip. Example: 0.
querystring- Search text. Example: Milford.
route4me_optimization_getGet one optimization problem.Read-onlyGet Optimization
Get one optimization problem. Returns state, parameters, addresses and the routes produced. Use this to check an optimization's state or find its routes.
Inputs
optimization_problem_idstringrequired- Optimization problem ID (32-character hex). Example: 07372F2CF3814EC6DFFAFE92E22771AA.
route4me_optimizations_listList optimization problems, optionally by state or date range.Read-onlyList Optimizations
List optimization problems, optionally by state or date range. Returns optimizations with optimization_problem_id, state, parameters and route counts. Use this to browse plans. Use route4me_optimization_get for one.
Inputs
end_datestring- End date (YYYY-MM-DD). Example: 2026-01-31.
limitinteger- Number of records to return. Example: 20.
offsetinteger- Number of records to skip. Example: 0.
start_datestring- Start date (YYYY-MM-DD). Example: 2026-01-01.
statestring- Comma-separated states: 1 initial, 2 matrix processing, 3 optimizing, 4 optimized, 5 error, 6 computing directions. Example: 4.
route4me_order_getGet one or more orders by ID.Read-onlyGet Orders by ID
Get one or more orders by ID. Returns the orders. Use this when you know the IDs.
Inputs
order_idstringrequired- Order ID, or several separated by commas. Example: 7205704,7205705.
route4me_orders_listList or search orders, optionally by date added or scheduled date.Read-onlyList Orders
List or search orders, optionally by date added or scheduled date. Returns results (orders with order_id, address_1, coordinates, scheduled date, status) and total. Use this to find orders. Use route4me_order_get for specific IDs.
Inputs
day_added_yymmddstring- Date the order was added (YYYY-MM-DD). Example: 2026-01-15.
fieldsstring- Comma-separated fields to return. Example: order_id,address_1,day_scheduled_for_YYMMDD.
limitinteger- Number of records to return. Example: 20.
offsetinteger- Number of records to skip. Example: 0.
querystring- Text to search in all order fields. Example: Lafayette.
scheduled_for_yymmddstring- Scheduled date (YYYY-MM-DD). Example: 2026-01-20.
route4me_route_address_getGet one stop of a route, optionally with its notes.Read-onlyGet Route Address
Get one stop of a route, optionally with its notes. Returns the stop with address, coordinates, sequence, visited/departed status, time windows and notes. Use this for one stop's details.
Inputs
route_destination_idintegerrequired- Route destination (stop) ID. Example: 183045808.
route_idstringrequired- Route ID (32-character hex). Example: 5C15E83A4BE005BCD1537955D28D51D7.
notesinteger- 1 to include notes. Example: 1.
route4me_route_getGet one route with its stops, optionally with directions, path, tracking history and notes.Read-onlyGet Route
Get one route with its stops, optionally with directions, path, tracking history and notes. Returns the route with route_id, parameters, addresses (stops with route_destination_id, sequence, ETA), trip distance and duration. Use this to read a route. Use route4me_routes_list to find route IDs.
Inputs
route_idstringrequired- Route ID (32-character hex). Example: 5C15E83A4BE005BCD1537955D28D51D7.
compress_path_pointsboolean- Compress path points. Example: false.
device_tracking_historyinteger- 1 to include GPS tracking history. Example: 0.
directionsinteger- 1 to include turn-by-turn directions. Example: 0.
notesinteger- 1 to include stop notes. Example: 1.
originalinteger- 1 to include the original (pre-change) route. Example: 0.
route_path_outputstring- Points to include the route path as points. Example: Points.
route4me_routes_listList routes, newest first, optionally by date range.Read-onlyList Routes
List routes, newest first, optionally by date range. Returns routes with route_id, parameters (route_name, route_date), stop counts, distance and duration. Use this to browse routes. Use route4me_routes_search for a text search.
Inputs
end_datestring- End date (YYYY-MM-DD). Example: 2026-01-31.
limitinteger- Number of records to return. Example: 20.
offsetinteger- Number of records to skip. Example: 0.
start_datestring- Start date (YYYY-MM-DD). Example: 2026-01-01.
route4me_routes_searchSearch routes by text (name, addresses...).Read-onlySearch Routes
Search routes by text (name, addresses...). Returns matching routes with route_id and parameters. Use this to find a route by name or stop. Use route4me_routes_list to browse.
Inputs
querystringrequired- Text to search for. Example: Milledgeville.
limitinteger- Number of records to return. Example: 20.
offsetinteger- Number of records to skip. Example: 0.
route4me_settings_listGet all account configuration keys, or one by key.Read-onlyList Configuration Settings
Get all account configuration keys, or one by key. Returns config keys and values. Use this to read account settings.
Inputs
config_keystring- Only this key. Example: destination_icon_uri.
route4me_territories_listList territory areas.Read-onlyList Territories
List territory areas. Returns items with territory_id, territory_name, territory_color and territory shape. Use this to find IDs. Use route4me_territory_get for one.
Inputs
This tool takes no inputs.
route4me_territory_getGet one territory (an area used to group stops and assign routes).Read-onlyGet Territory
Get one territory (an area used to group stops and assign routes). Returns its name, color and shape, and optionally enclosed addresses and orders. Use this when you know the ID.
Inputs
territory_idstringrequired- Territory ID. Example: 596A2A44FE9FB19EEB9C3C072BF2D0BE.
addressesinteger- 1 to include enclosed addresses. Example: 1.
ordersinteger- 1 to include enclosed orders. Example: 1.
route4me_tracking_status_getGet the delivery status of a stop by its tracking number.Read-onlyGet Tracking Status
Get the delivery status of a stop by its tracking number. Returns tracking_number, status history, ETA and the stop's location. Use this to answer 'where is my delivery?'.
Inputs
trackingstringrequired- Tracking number of the stop or order. Example: Q7G9P1L4.
route4me_user_getGet one user's details.Read-onlyGet User
Get one user's details. Returns member_id, name, email, phone, member_type and settings. Use this when you know the member ID.
Inputs
member_idintegerrequired- Member ID. Example: 1.
route4me_user_locations_listList the last known GPS location of each user (driver), optionally searched by name.Read-onlyList User Locations
List the last known GPS location of each user (driver), optionally searched by name. Returns users with member_id, name, last position and timestamp. Use this to see where drivers are.
Inputs
querystring- Search text for user names. Example: Jane.
route4me_users_listList the account's sub-users (drivers, dispatchers).Read-onlyList Users
List the account's sub-users (drivers, dispatchers). Returns users with member_id, member_first_name, member_last_name, member_email and member_type. Use this for driver IDs.
Inputs
This tool takes no inputs.
route4me_activity_logPost a user message to the activity feed, optionally on a route.WriteLog Activity Message
Post a user message to the activity feed, optionally on a route. Returns status true on success. Use this to leave a note in the activity feed.
Inputs
activity_messagestringrequired- Message text. Example: Driver delayed by traffic.
route_idstring- Route the message is about. Example: 5C15E83A4BE005BCD1537955D28D51D7.
route4me_avoidance_zone_createCreate a avoidance zone (an area routes must avoid) from a circle, polygon or rectangle.WriteCreate Avoidance Zone
Create a avoidance zone (an area routes must avoid) from a circle, polygon or rectangle. Returns the created item with territory_id. Use this to define an area.
Inputs
territoryobjectrequired- Shape: type circle (data: ["lat,lng", "radius meters"]), poly (data: ["lat,lng", ...]) or rect (data: ["lat,lng" top-left, "lat,lng" bottom-right]). Example: {"type": "circle", "data": ["37.5697528227865,-77.4783325195313", "5000"]}
territory_namestringrequired- Name. Example: sk-test avoidance zone.
territory_colorstring- Hex color without #. Example: ff7700.
route4me_avoidance_zone_updateUpdate a avoidance zone's name, color or shape.WriteUpdate Avoidance Zone
Update a avoidance zone's name, color or shape. Returns the updated item. Use this to change an area.
- Idempotent
Inputs
territoryobjectrequired- Shape: type circle (data: ["lat,lng", "radius meters"]), poly (data: ["lat,lng", ...]) or rect (data: ["lat,lng" top-left, "lat,lng" bottom-right]). Example: {"type": "circle", "data": ["37.5697528227865,-77.4783325195313", "5000"]}
territory_idstringrequired- Avoidance zone ID. Example: 596A2A44FE9FB19EEB9C3C072BF2D0BE.
territory_namestringrequired- Name. Example: sk-test avoidance zone.
territory_colorstring- Hex color without #. Example: ff7700.
route4me_location_createAdd a location (contact) to the address book, optionally with a recurring schedule.WriteCreate Location
Add a location (contact) to the address book, optionally with a recurring schedule. Returns the created location with address_id. Use this to save customers for repeated routing.
Inputs
address_1stringrequired- Street address. Example: 17205 RICHMOND TNPK, MILFORD, VA, 22514.
cached_latnumberrequired- Latitude. Example: 38.024654.
cached_lngnumberrequired- Longitude. Example: -77.338814.
address_aliasstring- Location name. Example: sk-test location.
address_citystring- City. Example: Milford.
address_custom_dataobject- Custom key-value data. Example: {"account": "A-1001"}
address_emailstring- Contact email. Example: jane@example.com.
address_groupstring- Group name. Example: Key accounts.
address_phone_numberstring- Contact phone. Example: +1 540-555-0100.
address_zipstring- Postal code. Example: 22514.
first_namestring- Contact first name. Example: Jane.
last_namestring- Contact last name. Example: Doe.
schedulearray- Recurring schedule objects (e.g. weekly on given days) for scheduled locations. Example: [{"enabled": true, "mode": "weekly", "weekly": {"every": 1, "weekdays": [1, 3]}}]
service_timeinteger- Service time in seconds. Example: 300.
route4me_location_group_createCreate an address book group from a filter.WriteCreate Location Group
Create an address book group from a filter. Returns the created group with group_id. Use this to save a location filter.
Inputs
group_namestringrequired- Group name. Example: sk-test key accounts.
filterobject- Filter rules selecting the group's locations (field, operator and value). Example: {"condition": "AND", "rules": [{"id": "address_1", "field": "address_1", "operator": "contains", "value": "Milford"}]}
group_colorstring- Hex color without #. Example: 92e1c0.
route4me_location_group_updateUpdate an address book group.WriteUpdate Location Group
Update an address book group. Returns the updated group. Use this to rename or change the filter.
- Idempotent
Inputs
group_idstringrequired- Group ID. Example: 4F39929B6A8A9D3E9A6B2B9F6B5C2E11.
filterobject- Filter rules selecting the group's locations (field, operator and value). Example: {"condition": "AND", "rules": [{"id": "address_1", "field": "address_1", "operator": "contains", "value": "Milford"}]}
group_colorstring- Hex color without #. Example: 92e1c0.
group_namestring- Group name. Example: sk-test key accounts.
route4me_location_updateUpdate an address book location.WriteUpdate Location
Update an address book location. Returns the updated location. Use this to change contact details or the schedule.
- Idempotent
Inputs
address_idintegerrequired- Location ID. Example: 37023651.
address_1string- Street address. Example: 17205 RICHMOND TNPK, MILFORD, VA, 22514.
address_aliasstring- Location name. Example: sk-test location.
address_citystring- City. Example: Milford.
address_custom_dataobject- Custom key-value data. Example: {"account": "A-1001"}
address_emailstring- Contact email. Example: jane@example.com.
address_groupstring- Group name. Example: Key accounts.
address_phone_numberstring- Contact phone. Example: +1 540-555-0100.
address_zipstring- Postal code. Example: 22514.
cached_latnumber- Latitude. Example: 38.024654.
cached_lngnumber- Longitude. Example: -77.338814.
first_namestring- Contact first name. Example: Jane.
last_namestring- Contact last name. Example: Doe.
schedulearray- Recurring schedule objects (e.g. weekly on given days) for scheduled locations. Example: [{"enabled": true, "mode": "weekly", "weekly": {"every": 1, "weekdays": [1, 3]}}]
service_timeinteger- Service time in seconds. Example: 300.
route4me_optimization_addresses_addInsert stops into an existing optimization, optionally re-optimizing it.WriteAdd Addresses to Optimization
Insert stops into an existing optimization, optionally re-optimizing it. Returns the updated optimization. Use this to grow a plan. Use route4me_route_addresses_add for a single route.
- Idempotent
Inputs
addressesarrayrequired- Stops, each an object with address and lat/lng, plus optional alias, is_depot, time (service seconds), time_window_start/end (seconds), first_name, last_name, email, phone, weight, cube, pieces, revenue and custom_fields. Example: [{"address": "151 Arbor Way Milledgeville GA 31061", "lat": 33.132675, "lng": -83.244743, "is_depot": true, "time": 0}, {"address": "230 Arbor Way Milledgevi...
optimization_problem_idstringrequired- Optimization problem ID (32-character hex). Example: 07372F2CF3814EC6DFFAFE92E22771AA.
reoptimizeinteger- 1 to re-optimize after inserting, 0 not to. Example: 1.
route4me_optimization_createCreate and solve a route optimization from a list of stops (the first depot is the start) and route parameters, producing one or more optimized routes.WriteCreate Optimization
Create and solve a route optimization from a list of stops (the first depot is the start) and route parameters, producing one or more optimized routes. Returns the optimization with optimization_problem_id, state, parameters, addresses in optimized order and routes with route_id. Use this to plan routes from scratch. Use route4me_route_addresses_add to add stops to an existing route.
Inputs
addressesarrayrequired- Stops, each an object with address and lat/lng, plus optional alias, is_depot, time (service seconds), time_window_start/end (seconds), first_name, last_name, email, phone, weight, cube, pieces, revenue and custom_fields. Example: [{"address": "151 Arbor Way Milledgeville GA 31061", "lat": 33.132675, "lng": -83.244743, "is_depot": true, "time": 0}, {"address": "230 Arbor Way Milledgevi...
depotsarray- Depot objects (same shape as addresses) for multi-depot problems. Example: [{"address": "151 Arbor Way Milledgeville GA 31061", "lat": 33.132675, "lng": -83.244743}]
optimized_callback_urlstring- URL Route4Me POSTs to when the optimization is solved or fails. Example: https://example.com/route4me/callback.
parametersobject- Route parameters: route_name, route_date (Unix date), route_time (seconds after midnight), algorithm_type (1 TSP, 2 VRP, 3 CVRP_TW_SD, 4 CVRP_TW_MD...), optimize (Distance, Time, timeWithTraffic), travel_mode (Driving, Walking, Trucking), distance_unit (mi, km), device_type, vehicle_capacity, route_max_duration and more. Example: {"route_name": "sk-test single driver", "algorithm_type": 1, "optimize": "Distance", "travel_mode": "Driving", "distance_unit": "mi", "route_time": 25200, "d...
route4me_order_createCreate an order (a stop to be scheduled into routes) with address, coordinates, time window and customer details.WriteCreate Order
Create an order (a stop to be scheduled into routes) with address, coordinates, time window and customer details. Returns the created order with order_id. Use this to queue deliveries. Use route4me_optimization_create to route them.
Inputs
address_1stringrequired- Street address. Example: 318 S 39 St, Lafayette, IN 47909, USA.
cached_latnumberrequired- Latitude. Example: 40.4141.
cached_lngnumberrequired- Longitude. Example: -86.8501.
address_aliasstring- Order or stop name. Example: sk-test order 1.
address_citystring- City. Example: Lafayette.
address_zipstring- Postal code. Example: 47909.
day_scheduled_for_yymmddstring- Scheduled date (YYYY-MM-DD). Example: 2026-01-20.
ext_field_custom_dataobject- Custom key-value data. Example: {"gate_code": "1234"}
ext_field_emailstring- Customer email. Example: jane@example.com.
ext_field_first_namestring- Customer first name. Example: Jane.
ext_field_last_namestring- Customer last name. Example: Doe.
ext_field_phonestring- Customer phone. Example: +1 765-555-0100.
ext_field_weightnumber- Weight. Example: 12.5.
local_time_window_endinteger- Time window end in seconds after midnight. Example: 39600.
local_time_window_startinteger- Time window start in seconds after midnight. Example: 32400.
service_timeinteger- Service time in seconds. Example: 300.
route4me_order_updateUpdate an order's fields.WriteUpdate Order
Update an order's fields. Returns the updated order. Use this to change an address, schedule or customer details.
- Idempotent
Inputs
order_idintegerrequired- Order ID. Example: 7205704.
address_1string- Street address. Example: 318 S 39 St, Lafayette, IN 47909, USA.
address_aliasstring- Order or stop name. Example: sk-test order 1.
address_citystring- City. Example: Lafayette.
address_zipstring- Postal code. Example: 47909.
cached_latnumber- Latitude. Example: 40.4141.
cached_lngnumber- Longitude. Example: -86.8501.
day_scheduled_for_yymmddstring- Scheduled date (YYYY-MM-DD). Example: 2026-01-20.
ext_field_custom_dataobject- Custom key-value data. Example: {"gate_code": "1234"}
ext_field_emailstring- Customer email. Example: jane@example.com.
ext_field_first_namestring- Customer first name. Example: Jane.
ext_field_last_namestring- Customer last name. Example: Doe.
ext_field_phonestring- Customer phone. Example: +1 765-555-0100.
ext_field_weightnumber- Weight. Example: 12.5.
local_time_window_endinteger- Time window end in seconds after midnight. Example: 39600.
local_time_window_startinteger- Time window start in seconds after midnight. Example: 32400.
service_timeinteger- Service time in seconds. Example: 300.
route4me_route_address_mark_departedMark a stop as departed or not departed.WriteMark Address Departed
Mark a stop as departed or not departed. Returns the updated stop. Use this to record a departure.
- Idempotent
Inputs
is_departedbooleanrequired- true to mark departed, false to clear. Example: true.
route_destination_idintegerrequired- Route destination (stop) ID. Example: 183045808.
route_idstringrequired- Route ID (32-character hex). Example: 5C15E83A4BE005BCD1537955D28D51D7.
route4me_route_address_mark_visitedMark a stop as visited or not visited.WriteMark Address Visited
Mark a stop as visited or not visited. Returns the updated stop. Use this to record a visit. Use route4me_route_address_mark_departed for departure.
- Idempotent
Inputs
is_visitedbooleanrequired- true to mark visited, false to clear. Example: true.
route_destination_idintegerrequired- Route destination (stop) ID. Example: 183045808.
route_idstringrequired- Route ID (32-character hex). Example: 5C15E83A4BE005BCD1537955D28D51D7.
route4me_route_address_updateUpdate a stop on a route (alias, contact, address, stop type, sequence, time windows, cargo, custom fields).WriteUpdate Route Address
Update a stop on a route (alias, contact, address, stop type, sequence, time windows, cargo, custom fields). Returns the updated stop. Use this to edit a stop. Use route4me_route_address_mark_visited for visit status.
- Idempotent
Inputs
route_destination_idintegerrequired- Route destination (stop) ID. Example: 183045808.
route_idstringrequired- Route ID (32-character hex). Example: 5C15E83A4BE005BCD1537955D28D51D7.
addressstring- Street address. Example: 230 Arbor Way Milledgeville GA 31061.
address_stop_typestring- PICKUP, DELIVERY, BREAK or MEETUP. Example: DELIVERY.one of
PICKUPDELIVERYBREAKMEETUP aliasstring- Stop name. Example: Customer A.
custom_fieldsobject- Custom key-value data. Example: {"gate_code": "1234"}
emailstring- Recipient email. Example: jane@example.com.
first_namestring- Recipient first name. Example: Jane.
last_namestring- Recipient last name. Example: Doe.
phonestring- Recipient phone. Example: +1 478-555-0100.
piecesinteger- Pieces. Example: 2.
sequence_nointeger- New position in the route. Example: 2.
timeinteger- Service time in seconds. Example: 300.
time_window_endinteger- Time window end in seconds after midnight. Example: 39600.
time_window_startinteger- Time window start in seconds after midnight. Example: 32400.
weightnumber- Weight. Example: 12.5.
route4me_route_addresses_addAdd stops to an existing route, either at their sequence position or at the optimal position.WriteAdd Addresses to Route
Add stops to an existing route, either at their sequence position or at the optimal position. Returns the updated route. Use this to add stops. Use route4me_route_address_remove to drop one.
- Idempotent
Inputs
addressesarrayrequired- Stops, each an object with address and lat/lng, plus optional alias, is_depot, time (service seconds), time_window_start/end (seconds), first_name, last_name, email, phone, weight, cube, pieces, revenue and custom_fields. Example: [{"address": "151 Arbor Way Milledgeville GA 31061", "lat": 33.132675, "lng": -83.244743, "is_depot": true, "time": 0}, {"address": "230 Arbor Way Milledgevi...
route_idstringrequired- Route ID (32-character hex). Example: 5C15E83A4BE005BCD1537955D28D51D7.
optimal_positionboolean- Insert each address at its optimal position. Example: true.
route4me_route_duplicateDuplicate one or more routes.WriteDuplicate Route
Duplicate one or more routes. Returns the new route IDs. Use this to reuse a route as a template.
Inputs
duplicate_routes_idarrayrequired- Route IDs to duplicate. Example: ["5C15E83A4BE005BCD1537955D28D51D7"]
route4me_route_updateUpdate a route's parameters (name, date, time, vehicle, driver...) or unlink it from its optimization.WriteUpdate Route
Update a route's parameters (name, date, time, vehicle, driver...) or unlink it from its optimization. Returns the updated route. Use this to rename or reassign a route.
- Idempotent
Inputs
route_idstringrequired- Route ID (32-character hex). Example: 5C15E83A4BE005BCD1537955D28D51D7.
parametersobject- Route parameters to change, e.g. route_name, member_id (driver), vehicle_id, route_date, route_time. Example: {"route_name": "sk-test renamed"}
unlink_from_master_optimizationboolean- Detach the route from its optimization. Example: false.
route4me_setting_setAdd a configuration key and value to the account.WriteAdd Configuration Setting
Add a configuration key and value to the account. Returns result true on success. Use route4me_setting_update to change an existing key.
Inputs
config_keystringrequired- Key. Example: sk_test_key.
config_valuestringrequired- Value. Example: enabled.
route4me_setting_updateChange the value of a configuration key.WriteUpdate Configuration Setting
Change the value of a configuration key. Returns result true on success. Use this to change a setting.
- Idempotent
Inputs
config_keystringrequired- Key. Example: sk_test_key.
config_valuestringrequired- New value. Example: disabled.
route4me_territory_createCreate a territory (an area used to group stops and assign routes) from a circle, polygon or rectangle.WriteCreate Territory
Create a territory (an area used to group stops and assign routes) from a circle, polygon or rectangle. Returns the created item with territory_id. Use this to define an area.
Inputs
territoryobjectrequired- Shape: type circle (data: ["lat,lng", "radius meters"]), poly (data: ["lat,lng", ...]) or rect (data: ["lat,lng" top-left, "lat,lng" bottom-right]). Example: {"type": "circle", "data": ["37.5697528227865,-77.4783325195313", "5000"]}
territory_namestringrequired- Name. Example: sk-test territory.
territory_colorstring- Hex color without #. Example: ff7700.
route4me_territory_updateUpdate a territory's name, color or shape.WriteUpdate Territory
Update a territory's name, color or shape. Returns the updated item. Use this to change an area.
- Idempotent
Inputs
territoryobjectrequired- Shape: type circle (data: ["lat,lng", "radius meters"]), poly (data: ["lat,lng", ...]) or rect (data: ["lat,lng" top-left, "lat,lng" bottom-right]). Example: {"type": "circle", "data": ["37.5697528227865,-77.4783325195313", "5000"]}
territory_idstringrequired- Territory ID. Example: 596A2A44FE9FB19EEB9C3C072BF2D0BE.
territory_namestringrequired- Name. Example: sk-test territory.
territory_colorstring- Hex color without #. Example: ff7700.
route4me_avoidance_zone_deleteDelete a avoidance zone.DestructiveDelete Avoidance Zone
Delete a avoidance zone. Returns status true on success. Use this to remove an area.
- Idempotent
Inputs
territory_idstringrequired- Avoidance zone ID. Example: 596A2A44FE9FB19EEB9C3C072BF2D0BE.
route4me_location_group_deleteDelete an address book group (the locations stay).DestructiveDelete Location Group
Delete an address book group (the locations stay). Returns status true on success. Use this to remove a group.
- Idempotent
Inputs
group_idstringrequired- Group ID. Example: 4F39929B6A8A9D3E9A6B2B9F6B5C2E11.
route4me_locations_deleteDelete address book locations.DestructiveDelete Locations
Delete address book locations. Returns status true on success. Use this to remove locations.
- Idempotent
Inputs
address_idsarrayrequired- Location IDs to delete. Example: ["37023651"]
route4me_optimization_address_removeRemove one stop from an optimization.DestructiveRemove Address from Optimization
Remove one stop from an optimization. Returns deleted: true and the route_destination_id. Use this to drop a stop from a plan.
- Idempotent
Inputs
optimization_problem_idstringrequired- Optimization problem ID (32-character hex). Example: 07372F2CF3814EC6DFFAFE92E22771AA.
route_destination_idintegerrequired- Route destination (stop) ID. Example: 183045808.
route4me_optimization_deleteDelete one or more optimization problems and their routes.DestructiveDelete Optimizations
Delete one or more optimization problems and their routes. Returns status and the removed count. Use this to clean up plans.
- Idempotent
Inputs
optimization_problem_idsarrayrequired- Optimization problem IDs to delete. Example: ["07372F2CF3814EC6DFFAFE92E22771AA"]
route4me_order_deleteDelete one or more orders.DestructiveDelete Orders
Delete one or more orders. Returns status true on success. Use this to remove orders.
- Idempotent
Inputs
order_idsarrayrequired- Order IDs to delete. Example: [7205704]
route4me_route_address_removeRemove one stop from a route.DestructiveRemove Route Address
Remove one stop from a route. Returns deleted: true and the route_destination_id. Use this to drop a stop.
- Idempotent
Inputs
route_destination_idintegerrequired- Route destination (stop) ID. Example: 183045808.
route_idstringrequired- Route ID (32-character hex). Example: 5C15E83A4BE005BCD1537955D28D51D7.
route4me_route_deleteDelete one or more routes.DestructiveDelete Route
Delete one or more routes. Returns deleted: true and the route IDs. Use this to remove routes; it cannot be undone.
- Idempotent
Inputs
route_idstringrequired- Route ID, or several separated by commas. Example: 5C15E83A4BE005BCD1537955D28D51D7.
route4me_setting_deleteDelete a configuration key.DestructiveDelete Configuration Setting
Delete a configuration key. Returns result true on success. Use this to remove a setting.
- Idempotent
Inputs
config_keystringrequired- Key to delete. Example: sk_test_key.
route4me_territory_deleteDelete a territory.DestructiveDelete Territory
Delete a territory. Returns status true on success. Use this to remove an area.
- Idempotent
Inputs
territory_idstringrequired- Territory ID. Example: 596A2A44FE9FB19EEB9C3C072BF2D0BE.
No tools match.