Skip to content
Changelog

Report a bug

Route4me integration: operations for AI agents

Route4me connects to Type.com as an integration. This page lists the 371 operations documented for Claude and Codex in Type.com: 179 read, 127 write, 65 destructive.

About Route4me

Route4Me provides a Last Mile Routing API offering automated solutions for route planning and optimization, tailored for logistics-intensive businesses.

Categories: Productivity & Project Management

How to connect Route4me to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

371 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

371 operations listed.

Tracking page api

  • Read

    Get Destination Tracking data

    Get Destination Tracking data by tracking number

  • Read

    Get Tracking data

    Get Tracking data by tracking number

External api

  • Read

    Get Tracking data

    Get Tracking data by tracking number

Order

  • Read

    Get order info options

    Retrieve order info options

Account activation

  • Write

    Send/resend email activation code to the created member.

    This endpoint is used to send/resend email activation code as a step in the account activation process.

  • Write

    Send/resend phone sms activation code to the created member.

    This endpoint is used to send/resend email activation code as a step in the account activation process.This endpoint is used to send/resend phone sms activation code as a step in the account activation process.

  • Write

    Verify email activation code.

    This endpoint is used to verify email activation code as a step in the account activation process.

  • Write

    Verify phone sms activation code.

    This endpoint is used to verify phone sms activation code as a step in the account activation process.

Authentication

  • Write

    Authentication

    Authenticate an existing member using credentials from the request payload.

  • Write

    Authenticate device.

    Authenticate device using auth params from payload.

  • Write

    Authenticate existing member or register new one and authenticate immediately.

    Authenticate existing member or register new one and authenticate immediately.

Logout

  • Write

    Logout other devices.

    Logout other devices except for current.

Devices

  • Read

    List member push notification tokens.

    List member push notification tokens.

  • Destructive

    Delete selected member push notification tokens.

    Delete selected member push notification tokens.

Registration

  • Write

    Register Account Owner

    Register a new member using registration params from the request payload.

  • Write

    Register a new member.

    Register a new member using registration params from payload.

Upload

  • Read

    Preview the table with spreadsheet content

    Get preview table of uploaded file

  • Write

    Creates an optimization job using customer locations or uploaded spreadsheet file

    Load Customer Locations or Upload csv and params.json to Google Cloud Storage (GCS).

  • Write

    Upload spreadsheet to GCS

    Upload a file to the storage to make preview

  • Write

    Upload to GCS

    Upload csv and params.json to Google Cloud Storage (GCS).

  • Write

    Default mapping

    Get default mapping and encodings for uploads viewer

  • Write

    Send addresses in spreadsheet to geocoder

    Send addresses from spreadsheet for geocoding

Strategic destinations

  • Read

    Get destinations

    Get destinations

Strategic Visits

  • Read

    Get visits

    Get visits

  • Write

    A856500fa44abd46393f26689040bf45

    Submit selected export type for execution.

Export

  • Read

    6aaf35e6a3c88b613b61c812689537f5

    Return available export columns for the specified export type.

  • Read

    Check the file export status.

    Check the status of the exported file by specifying corresponding path parameter ID.

  • Read

    Check the file export result.

    Check the result of the exported file by specifying the corresponding path parameter ID.

  • Read

    Download the file export result.

    Download of the exported file by specifying the corresponding path parameter ID.

  • Read

    Generate activities export

    Export the Activities filtered by the corresponding query parameters into the specified file.

  • Read

    Generate activities by route id export

    Export the Activities filtered by routeid into the specified file.

  • Read

    Export the Orders.

    Export the Orders.

  • Read

    Check the file export status.

    Check the status of the exported file by specifying corresponding path parameter ID.

  • Read

    Check the file export result.

    Check the result of the exported file by specifying the corresponding path parameter ID.

  • Read

    Download the file export result.

    Download of the exported file by specifying the corresponding path parameter ID.

  • Read

    Export the specified Addresses.

    Export Address Book Contacts to the specified file by sending a body payload with the array of the corresponding Address IDs.

  • Read

    Export Addresses by the selected areas.

    Export the Address Book Contacts located in the selected areas by sending the corresponding body payload.

  • Read

    Export Addresses By Area IDs

    Export Addresses by the specified area IDs.

Strategic Optimizations

  • Read

    Get strategic optimization

    Get strategic optimization

  • Read

    Get strategic optimizations

    Get strategic optimizations

  • Read

    Optimization scenarios parameters

    Get optimization scenarios parameters by optimization

  • Write

    6083bba17a08cd60808d978c2ba54fc0

    Submit selected export type for execution.

  • Write

    9d6685be83ba9f225e4882f17dca0a20

    Export Optimizations with nested entities using separate filters

  • Write

    252e6afcaf786e30f2adc01a4f277215

    Get totals for nested entities using separate filters

  • Write

    Create or update strategic optimizations

    Create or update strategic optimizations

  • Write

    Bulk delete strategic optimizations

    Bulk delete strategic optimizations

  • Write

    Create draft strategic optimization

    Create draft strategic optimization from existing optimization

  • Write

    Add scenarios to optimization

    Add scenarios to optimization

  • Destructive

    Update strategic optimizations

    Update strategic optimizations

  • Destructive

    Delete strategic optimization

    Delete strategic optimization

Strategic Scenarios

  • Read

    Get scenario

    Get scenario

  • Read

    Get scenarios

    Get scenarios

  • Write

    2365e0094957e75957564c691e12b9a6

    Export scenarios with nested entities using separate filters

  • Write

    892886abca5e46cb9501933c48df1985

    Get totals for nested entities using separate filters

  • Write

    28be38b1d49a355915353e65b65b0134

    Submit selected export type for execution.

  • Write

    Accept scenario

    Accept scenario

  • Write

    Complete scenario

    Complete scenario

Strategic Locations

  • Read

    Get locations

    Get locations

  • Read

    Get locations

    Get locations

  • Read

    Get locations

    Get locations clustering

  • Read

    Get location

    Get location

  • Write

    2cae1a3931e21d6f72cf19e10eeb1c6d

    Submit selected export type for execution.

  • Write

    Update draft location

    Update draft location

  • Write

    Bulk update locations

    Bulk update locations

  • Write

    Bulk delete locations

    Bulk delete locations

  • Destructive

    Get location

    Get location

  • Destructive

    Delete draft optimization location

    Delete draft optimization location

Strategic Routes

  • Read

    Get routes

    Get routes

  • Write

    89bc63988528dd1d54ae0531ba4922e1

    Submit selected export type for execution.

Generative AI

  • Write

    19b4a47d55fbc7b42e1f965407ef3f06

    Use prompt to allow AI generate scenario configuration.

Pattern Analysis

  • Read

    Preview the table with spreadsheet content

    Get preview table of uploaded file

  • Write

    Upload spreadsheet to GCS

    Upload a file to the storage to make preview

  • Write

    Initiate Pattern Analysis

    Initiate Pattern Analysis using uploaded spreadsheet file

Jobs

  • Read

    Check the asynchronous job status.

    Check the asynchronous job status by specifying the jobid path parameter.

  • Read

    Get the asynchronous job result.

    Get the asynchronous job result by specifying the jobid path parameter.

Imported Routes

  • Read

    Get routes

    Get routes

  • Read

    Get route by id

    Get route by id

  • Read

    Get routes combined

    Get routes combined

  • Read

    Get route stops combined

    Get route stops combined

  • Write

    Create internal routes from imported routes

    Create internal routes from imported routes

Vendor

  • Read

    List every telematics vendor

    Proxies the Telematics API GET /vendors/all endpoint and returns the full vendor catalog.

  • Read

    List telematics vendors

    Proxies the Telematics API GET /vendors endpoint. Provide vendorid to fetch a specific vendor.

  • Write

    Create a telematics vendor

    Creates a vendor metadata entry via the Telematics API.

  • Destructive

    Update a telematics vendor

    Updates vendor data.

Connected vehicles

  • Read

    List connected vehicles for a telematics connection

    List connected vehicles for a telematics connection.

  • Destructive

    Deletes vehicles for a connection.

    Deletes vehicles for a connection.

Connection

  • Read

    List or fetch telematics connections

    Proxies the Telematics API GET /connections endpoint.

  • Write

    Create a telematics connection

    Creates a new vendor connection through the Telematics API.

  • Write

    Partially update a telematics connection

    Applies partial updates by proxying the Telematics API PATCH

  • Destructive

    Update a telematics connection

    Updates an existing connection using the Telematics API PUT.

  • Destructive

    Delete a telematics connection

    Deletes a vendor connection.

Locations

  • Read

    Fetch the latest vehicle locations

    Fetch the latest vehicle locations.

  • Read

    Check vehicle location availability

    HEAD proxy to the Telematics API that returns headers only.

  • Read

    Get combined list with locations data

    Get combined list with locations data

  • Read

    Get list with locations data

    Get list with locations data

  • Read

    Get clustered locations

    Get clustered locations

  • Read

    Get a heat map of the locations

    Get a heat map of the locations

  • Read

    Get a location service-time heatmap

    Get a location service-time heatmap

  • Read

    Get territories with the number of locations

    Get territories with the number of locations

  • Read

    Get columns info for locations export

    Get columns info for locations export

  • Read

    Export locations

    Export locations

Imported Trips

  • Read

    Get trips

    Get trips

  • Read

    Get trip by id

    Get trip by id

  • Read

    Get trip stops combined

    Get trip stops combined

  • Write

    Create internal routes from trips

    Create internal routes from trips

Trips

  • Read

    Get trips combined

    Get trips combined

Vehicle Activity

  • Read

    Get vehicle activity combined

    Get vehicle activity combined

  • Write

    Create vehicle activities batch and dispatch reindex (staging only)

    Staging-only debug endpoint. Creates VehicleActivity records in DynamoDB and dispatches reindex in batch to trigger driver break processing.

Vendor Users

  • Read

    Get vendor users

    Get vendor users

  • Read

    Get vendor user by id

    Get vendor user by id

  • Read

    Get vendor users combined

    Get vendor users combined

  • Write

    Create internal users from vendor users

    Create internal users from vendor users

Routes

  • Read

    Get Route Info By Route Id

    GET /api/v5.0/routes/{route_id}

  • Read

    Get last scheduled by today route information by member id

    GET /api/v5.0/routes/member-route/{member_id}

  • Read

    Get last scheduled by today route information by vehicle id

    GET /api/v5.0/routes/vehicle-route/{vehicle_id}

  • Read

    Display the route(s)

    Get a list of all the routes or single route if the parameter routeid is specified.

  • Write

    Destination Deliver Request

    POST /api/v5.0/destination/deliver

  • Write

    Destination Deliver By Barcode Request

    POST /api/v5.0/destination/deliver-barcode

  • Write

    Create Master Route Request

    POST /api/v5.0/routes/master-route

  • Write

    Route Assign Preview Request

    POST /api/v5.0/routes/assign-preview

  • Write

    Route Facility Assign Request

    POST /api/v5.0/routes/assign-facility

  • Write

    Route Assign Request

    POST /api/v5.0/routes/bulk/update

  • Write

    Route Assign Request

    POST /api/v5.0/routes/bulk/update-collection

  • Write

    Route Dispatch Request

    POST /api/v5.0/routes/dispatch

  • Write

    Create Route Request

    Create a regular route. This endpoint does not use the Master Route template.

  • Write

    Duplicate a route

    Duplicate the route(s) in database.

  • Destructive

    Re-optimize a route

    Re-optimize a route by changing route parameters and/or addresses.

  • Destructive

    Remove the route(s)

    Remove the route(s) from database.

Directions

  • Read

    Get Directions

    GET /api/v5.0/routes/{route_id}/directions

Internal API

  • Read

    Get Nested object structure

    GET /api/v5.0/routes/reindex-callback/nested/config

  • Write

    Index/reindex data in Elasticsearch by specified Route IDs

    POST /api/v5.0/routes/reindex-callback

  • Write

    Index/reindex nested fields(such as routedata, notes) of the specified route

    Index/reindex nested fields(such as routedata, notes) of the specified route

Manifest

  • Read

    Manifest for route

    GET /api/v5.0/routes/manifest/{route_id}

Optimization

  • Read

    Get optimizations

    Get optimizations

Index

  • Read

    Get route list.

    POST /api/v5.0/routes/

Delete

  • Destructive

    Delete routes by filters.

    DELETE /api/v5.0/routes/delete

List

  • Read

    Get route list.

    POST /api/v5.0/routes/list

  • Read

    List configuration request

    GET /api/v5.0/routes/list/config

  • Read

    Get combined route list.

    POST /api/v5.0/routes/list/combined

  • Read

    Get activities

    Get Datatable Activities by specifying query parameters with pagination by cursor. Endpoint supports translation functionality.

  • Read

    Get Datatable Config

    Get Datatable Config.

  • Write

    Display the list of Orders.

    Display the Orders.

  • Write

    Display Orders for orders list.

    Display a datatable of the orders for orders list.

Rating

  • Write

    Set route rating.

    POST /api/v5.0/routes/{route_id}/rating

Settings

  • Read

    Get Route Settings

    GET /api/v5.0/routes/{route_id}/settings

  • Destructive

    Update Route Settings

    PUT /api/v5.0/routes/{route_id}/settings

Activities

  • Read

    Get all activities

    Get Activities by specifying the corresponding query parameters. Endpoint supports translation functionality.

  • Read

    Get activities list by route id

    Get Activities by route id. Endpoint supports translation functionality.

Activity Types Config

  • Read

    Get All Activity types config

    Get All Activity types config

  • Read

    Get route activity types

    Get Route types config

Export Status

  • Read

    Check the file export status.

    Check the status of the exported file by specifying corresponding path parameter ID.

  • Read

    Check the file export result.

    Check the result of the exported file by specifying the corresponding path parameter ID.

  • Read

    Download the file export result.

    Download of the exported file by specifying the corresponding path parameter ID.

Skill Management

  • Read

    Show all skills

    GET /api/v5.0/skill-management

  • Read

    Show a skill

    GET /api/v5.0/skill-management/{skill_id}

  • Write

    Create a new skill

    POST /api/v5.0/skill-management

  • Destructive

    Update a skill

    PUT /api/v5.0/skill-management/{skill_id}

  • Destructive

    Delete a skill

    DELETE /api/v5.0/skill-management/{skill_id}

Combined

  • Read

    Get combined skill list.

    POST /api/v5.0/skill-management/combined

  • Read

    Get vehicles list.

    Get vehicles list.

Columns

  • Read

    Get columns list.

    Get columns list.

  • Read

    Get UI columns configuration

    Get UI columns configuration

  • Read

    Get columns list.

    Get columns list.

  • Read

    Get columns list.

    Get columns list.

  • Destructive

    Edit columns list.

    Edit columns list.

  • Destructive

    Update UI columns configuration

    Update UI columns configuration

  • Destructive

    Edit columns list.

    Edit columns list.

  • Destructive

    Edit columns list.

    Edit columns list.

Note Custom Type

  • Read

    Get all Note Custom Types.

    Get all Note Custom Types.

  • Write

    Store new Note Custom Type.

    Store new Note Custom Type.

  • Destructive

    Update Note Custom Type.

    Update Note Custom Type.

  • Destructive

    Delete Note Custom Type.

    Delete Note Custom Type.

Notes

  • Read

    Get Notes by Route

    Get Notes by Route ID

  • Read

    Get Notes by Destination

    Get Notes by Destination ID or UUID

  • Read

    Get Notes by Filter

    Get Notes By Filter

  • Read

    Get Notes by Orders

    Get Notes By Orders

  • Read

    Get Notes Combined

    Get Notes Combined

  • Read

    Get Note By Id

    Get Note By Id

  • Write

    Create new Route Note.

    Create New Note

  • Write

    Create New Route Notes

    Store Notes Bulk

  • Write

    Upload Note attachment for store notes bulk.

    Upload Note Attachment

  • Write

    Update Note By Id

    Update Note By Id

  • Destructive

    Delete Note attachment.

    Delete Note attachment

  • Destructive

    Delete Note By Id

    Delete Note By Id

Get Customers

  • Read

    Get a customer by ID

    Get a customer by ID

  • Read

    Get combined list with customers data

    Get combined list with customers data

  • Read

    Get list with customers data

    Get list with customers data

Modify Customers

  • Write

    Create a customer

    Create a customer

  • Destructive

    Update a customer

    Update a customer

  • Destructive

    Delete a customer

    Delete a customer

Default

  • Read

    List all PodWorkflows.

    List all PodWorkflows.

  • Read

    Get PodWorkflow by UUID.

    Get PodWorkflow by UUID.

  • Read

    Get action-evidences.

    Get action-evidences.

  • Read

    Get action-evidence by UUID.

    Get action-evidence by UUID.

  • Read

    Display the order history.

    Display the order history.

  • Read

    Display the simple order history.

    Display the simple order history.

  • Read

    Display the list of Members.

    View all existing sub-users associated with the Member’s account.

  • Read

    Display the list of Members with pagination.

    Display the list of Members with pagination.

  • Read

    Get the sub-user by ID.

    Get the sub-user by specifying the path parameter ID.

  • Read

    Display the current Member information.

    Display the current Member information.

  • Read

    Display the list of Member's territories.

    Display the list of Member's territories.

  • Read

    Display the list of Root Members for customer support user.

    Display the list of Root Members for customer support user.

  • Read

    Get the template of sub-user.

    Get the template of sub-user.

  • Read

    Get user modification history.

    Get user modification history.

  • Read

    Get the sub-users by IDs.

    Get the sub-users by Member IDs.

  • Read

    Get the status of an asynchronous job.

    Returns the current status of an asynchronous job. While the job is running the response is 200 with the X-R4M-Async-Job-Running-Time header; once terminal it responds 303 with a Location header pointing at the result endpoint.

  • Read

    Get the result of an asynchronous job.

    Returns the final result of a terminal asynchronous job. The result payload matches the synchronous lookup-for-new-destination response: the list of best insertion options.

  • Read

    Find the best positions to insert a new destination.

    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.

  • Write

    Create a new PodWorkflow.

    Create a new PodWorkflow.

  • Write

    Create action-evidence.

    Create action-evidence.

  • Write

    Create bulk action-evidence.

    Create bulk action-evidence.

  • Write

    Store an Order in database.

    Create an Order by sending a body payload with the corresponding Order parameters.

  • Write

    Store a new Member in the database.

    Add a new sub-user to the Member account by sending the corresponding body payload with the sub-users parameters.

  • Write

    Update the sub-user by ID.

    Update the sub-user by specifying the path parameter ID and by sending the corresponding body payload with the sub-user's parameters.

  • Write

    Store a new sub-user in the database.

    Add multiple sub-users to the User account by sending the corresponding body payload with the array of the sub-users' parameters.

  • Write

    Dispatch an asynchronous lookup for a new destination.

    Asynchronously find the best positions to insert a new destination into existing routes. Enqueues the lookup and immediately returns a job identifier; poll the job-tracker status endpoint and then fetch the result.

  • Destructive

    Update a PodWorkflow by UUID.

    Update a PodWorkflow by UUID.

  • Destructive

    Delete a Pod Workflow by UUID.

    Delete a PodWorkflow by UUID.

  • Destructive

    Update the specified Order in the storage.

    Update the specified Order in the storage by sending the body payload with the specified 'orderid' parameter.

  • Destructive

    Delete the sub-user by ID.

    Delete the sub-user by specifying the path parameter ID.

  • Destructive

    Delete current user.

    Delete current user.

Geocoding

  • Read

    geocoding address

    GET /

  • Write

    geocoding address

    POST /

  • Write

    forward geocoding address (the same as basic geocoding)

    POST /forward

  • Write

    reverse geocoding address

    geocoding by coordinates to get address information

  • Write

    bulk geocoding address

    POST /bulk

Facilities Assets

  • Read

    Facility assets

    get facility assets

  • Write

    Create facilities assets.

    Create facilities assets

  • Destructive

    Delete facility asset

    delete facility asset

Assets

  • Read

    Get asset facilities.

    Get asset facilities.

  • Read

    Get Asset.

    Get Asset.

  • Read

    Get assets list.

    Get assets list.

  • Read

    Get columns list.

    Get assets columns list.

  • Write

    Update asset with facility types

    Update asset with facility types

  • Write

    Create Asset.

    Create Asset.

  • Destructive

    Update asset with facility types

    Update asset with facility types

  • Destructive

    Update Asset.

    Update Asset.

  • Destructive

    Delete Asset.

    Delete Asset.

  • Destructive

    Edit columns list.

    Edit assets columns list.

Facilities

  • Read

    Get facility

    Get facility by it ID

  • Read

    Get facilities

    Get facilities

  • Read

    Get facilities and UI columns configuration

    Get facilities and UI columns configuration

  • Write

    Create facility

    create facility

  • Destructive

    Update facility

    update facility

  • Destructive

    Delete facility

    delete facility

Facilities Custom Data

  • Read

    Facility custom data

    Get custom data for a facility

  • Read

    Get facilities custom data by facility IDs

    POST /api/v5.0/facilities/custom-data/bulk

  • Destructive

    Update facility custom data

    Update facility custom data

  • Destructive

    Bulk update facility custom data

    Update facilities custom data in bulk

Facility Types

  • Read

    Facility type details

    facility type details

  • Read

    Facility types list

    facility types list

Archive Orders

  • Write

    Display the list of Archive Orders.

    Display the Archive Orders.

Custom Fields

  • Read

    Get all Order Custom Fields.

    Get all Order Custom Fields.

  • Write

    Store new Order Custom Field.

    Store new Order Custom Field.

  • Destructive

    Update Order Custom Field.

    Update Order Custom Field.

  • Destructive

    Delete Order Custom Field.

    Delete Order Custom Field.

Tracking

  • Read

    Get embedded tracking of Order.

    Get embedded tracking of Order.

Users

  • Read

    Get Users Combined.

    Get Users Combined

Reindex

  • Write

    Reindex callback.

    Reindex callback.

Gradual release

  • Read

    Get active releases

    Get active releases

  • Write

    Activate gradual release

    Activate gradual release

  • Destructive

    Deactivate gradual release

    Deactivate gradual release

Entities

  • Read

    Get optimization profiles entities

    Get optimization profiles entities

  • Read

    Get optimization profiles entities template

    Get optimization profiles entities template

  • Write

    Save entities

    Save optimization profiles entities

  • Destructive

    Delete optimization profiles entities

    Delete optimization profiles entities

Optimization Profiles

  • Read

    Get optimization profiles

    Get optimization profiles

Data List

  • Read

    Get All data list of Optimization Profiles.

    Get All data list of Optimization Profiles.

Optimization Profiles API

  • Read

    Get Optimization Profiles.

    Get Optimization Profiles.

  • Read

    Get Optimization Profile by id.

    Get Optimization Profile by id.

  • Write

    Store new Optimization Profile.

    Store new Optimization Profile.

  • Destructive

    Update Optimization Profile.

    Update Optimization Profile.

  • Destructive

    Delete Optimization Profile by id.

    Delete Optimization Profile by id.

Addresses

  • Read

    Get all Addresses.

    Get all Addresses filtered by specifying the corresponding query parameters.

  • Read

    Get all Addresses.

    Get all Addresses filtered and sorted by sending the corresponding body payload, with the option to search by the specified areas.

  • Read

    Get a paginated list of all Addresses.

    Get a paginated list of all Addresses.

  • Read

    Get a paginated list of all Addresses.

    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.

  • Read

    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.

  • Read

    Get Address clusters.

    Get the Address clusters by sending the corresponding body payload.

  • Read

    Find an Address by ID.

    Find an Address by sending the 'addressid' query parameter.

  • Read

    Find multiple Addresses by their IDs.

    Find multiple Addresses by sending a body payload with the array of the corresponding Address IDs.

  • Read

    Get Address custom fields.

    Get all Address custom fields.

  • Read

    Get depots Addresses.

    Get depots Addresses.

  • Write

    Add a new Address.

    Add a new Address Book Contact by sending a body payload with the corresponding parameters.

  • Write

    Add multiple Addresses.

    Add multiple new Address Book Contacts by sending a body payload with the array of the corresponding Address parameters.

  • Write

    Reindex data in ElasticSearch by specified address IDs

    POST /reindex-callback

  • Destructive

    Update the Address by ID.

    Update the Address Book Contact by specifying the 'addressid' path parameter and by sending a body payload with the corresponding Address parameters.

  • Destructive

    Update multiple Addresses by their IDs.

    Update multiple Address Book Contacts by sending a body payload with the array of the corresponding Address IDs and Address parameters.

  • Destructive

    Update multiple Addresses by their IDs asynchronously.

    Asynchronous updating multiple Address Book Contacts by sending a body payload with the array of the corresponding Address IDs and Address parameters.

  • Destructive

    Update Addresses by the selected areas.

    Update Address Book Contacts by sending a body payload with the corresponding query text and specified territory areas.

  • Destructive

    Delete multiple Addresses by their IDs.

    Delete multiple Address Book Contacts by sending a body payload with the array of the corresponding Address IDs.

  • Destructive

    Delete Addresses by the selected areas.

    Delete the Address Book Contacts located in the selected areas by sending the corresponding body payload.

Import

  • Write

    Import addresses from files

    Import Address Book Contacts from spreadsheet file CSV, XLS or XLSX.

Location Types

  • Read

    Get location types

    Get location types

  • Read

    Get location type by Id

    Get location type by Id

  • Write

    Create location type

    Create location type

  • Destructive

    Update location type

    Update location type

  • Destructive

    Delete location type

    Delete location type

Tracked job

  • Read

    Check the asynchronous job status.

    Check the asynchronous job status by specifying the 'jobid' path parameter.

  • Read

    Get the asynchronous job result.

    Check the asynchronous job status by specifying the 'jobid' path parameter.

Groups

  • Read

    Get all Address Book Groups.

    Get all Address Book Groups.

  • Read

    Find the Address Book Group by ID.

    Find the Address Book Group by specifying the 'group' path parameter.

  • Write

    Add a new Address Book Group.

    Add a new Address Book Group by sending a body payload with the corresponding Address Book Group parameters.

  • Write

    Change address book groups positions (group sort order).

    Change address book groups positions (group sort order) by sending a body payload with the all group ids (hex) in the new sorting order.

  • Destructive

    Update the 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.

  • Destructive

    Delete the Address Book Group.

    Delete the Address Book Group by specifying the 'group' path parameter.

Group Filtering

  • Write

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

  • Write

    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.

  • Write

    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 'groupid' query parameters.

  • Write

    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', 'groupid' and 'precision' query parameters.

Temporal access

  • Write

    Store a new temporal access address.

    Insert a new temporal access address into the database by sending the corresponding body payload.

  • Write

    Store a new temporal access addresses asynchronously.

    Insert a new temporal access addresses into the database asynchronously by sending the corresponding body payload.

Orders

  • Write

    Create orders from contacts

    Create orders from contacts

Vehicles

  • Read

    Display the list of Vehicles.

    Get the paginated list of Vehicles.

  • Read

    Display the list of Vehicles.

    Get the paginated list of Vehicles.

  • Read

    Get the vehicle by ID.

    Get the Vehicle by specifying the path parameter ID.

  • Read

    Search for the vehicle.

    Search for the Vehicle by sending the corresponding body payload with Vehicles ids and location.

  • Read

    Search for the vehicle.

    Search for the Vehicle by sending the corresponding body payload with Vehicles ids and location.

  • Read

    Execute order.

    Execute the Vehicle's Order by sending the corresponding body payload with the corresponding location, and Vehicle ID.

  • Read

    Latest vehicle's locations.

    Get the latest know vehicle's locations.

  • Read

    Get the Vehicle track.

    Get the Vehicle track by specifying the path parameter ID.

  • Read

    Get the Vehicle profile by license plate.

    Get the Vehicle Profile by license plate.

  • Read

    Get vehicle confirmation.

    Get vehicle confirmation.

  • Write

    Store a new Vehicle in database

    Create a new Vehicle in the user's account by sending the corresponding body payload with the Vehicle parameters.

  • Write

    Update the Vehicle in database

    Update the Vehicle by specifying the path parameter ID and by sending the corresponding body payload with the Vehicle's parameters.

  • Write

    Bulk Vehicles restore.

    Restore the Vehicles from the list of their ids asynchronously.

  • Write

    Store a new temporary Vehicle in the database

    Create a new temporary Vehicle by sending the corresponding body payload.

  • Write

    Execute order.

    Execute the Vehicle's Order by sending the corresponding body payload with the corresponding location, and Vehicle ID.

  • Write

    Sync a pending Vehicle from Telematics.

    Sync the Vehicle by sending the corresponding body payload with the Vehicle's parameters and by specifiying vehiclealias, r4mtelematicsgatewayconnectionid and r4mtelematicsgatewayvehicleid in this body payload.

  • Write

    Bulk Vehicles delete.

    Delete the Vehicles from the list of their ids asynchronously.

  • Write

    Bulk Vehicles update.

    Update the Vehicle list asynchronously by sending the corresponding body payload with the Vehicles list with their parameters.

  • Write

    Bulk Vehicles activate.

    Activate the Vehicles from the list of their ids asynchronously.

  • Write

    Bulk Vehicles deactivate.

    Deactivate the Vehicles from the list of their ids asynchronously.

  • Write

    Reindex Vehicles.

    Reindex Vehicles.

  • Write

    Track Vehicle Confirmation.

    Track Vehicle Confirmation.

  • Destructive

    Delete the vehicle by ID.

    Delete the Vehicle by specifying the path parameter ID.

Vehicle Capacity Profiles

  • Read

    Get Vehicle Capacity Profile as a datatable.

    Filtering Data Send Vehicle Capacity Profile attribute's name with the corresponding value, e.g. maxvolume=99.99.

  • Read

    Get Vehicle Capacity Profile as a data list.

    Filtering Data Send Vehicle Capacity Profile attribute's name with the corresponding value, e.g. maxvolume=99.99.

  • Read

    Get a Vehicle Capacity Profile by its ID.

    Get a Vehicle Capacity Profile by its ID.

  • Read

    Display the datatable config.

    Display the datatable config.

  • Read

    Display the data list config.

    Display the data list config.

  • Read

    Get Vehicle Capacity Profile Page Config.

    Get Vehicle Capacity Profile Page Config.

  • Write

    Create a new Vehicle Capacity Profile

    Create a new Vehicle Capacity Profile.

  • Write

    Create a new Vehicle Capacity Profile

    Create a new Vehicle Capacity Profile.

  • Destructive

    Delete the Vehicle Capacity Profile by its ID.

    Delete the Vehicle Capacity Profile by its ID.

Vehicle Profiles

  • Read

    Get the list of Vehicle Profiles.

    Get the list of Vehicle Profiles.

  • Read

    Get the Vehicle Profile by ID.

    Get the Vehicle Profile by specifying the path parameter ID.

  • Read

    Get the Vehicle Profile by specifying vehicle profile code.

    Get the Vehicle Profile by specifying vehicle profile code.

  • Write

    Store a new Vehicle Profile in database

    Create a new Vehicle Profile by sending the corresponding body payload with the Vehicle Profile's parameters.

  • Write

    Update the Vehicle Profile by ID

    Update the Vehicle Profile by specifying the path parameter ID and by sending the corresponding body payload with the Vehicle Profile's parameters.

  • Write

    Update the Vehicle Profile by the vehicle profile code.

    Update the Vehicle Profile by the vehicle profile code.

  • Write

    Complex datatable endpoint with filters, grouping and etc.

    Complex datatable endpoint with filters, grouping and etc.

  • Destructive

    Delete the Vehicle Profile by ID.

    Delete the Vehicle Profile by specifying the path parameter ID.

  • Destructive

    Delete Vehicle Profiles by the vehicle profile code.

    Delete Vehicle Profiles by the vehicle profile code.

Optimization v4

  • Read

    Display the optimization(s)

    Get a list of all the optimizations or single optimization if the parameter idParam is specified.

  • Write

    Store a new optimization in database.

    POST /optimization_problem.php

  • Destructive

    Re-optimize an optimization by changing route parameters and/or addresses.

    PUT /optimization_problem.php

  • Destructive

    Remove an optimization from database.

    DELETE /optimization_problem.php

User

  • Read

    List of member configuration settings

    Get the Member Configuration Settings by specifying the 'mcs' and 'configkey' query parameters.

  • Write

    Create a new Member Configuration Settings.

    Create a new Member Configuration Settings by sending the corresponding body payload.

  • Write

    Bulk get the Member Configuration Settings

    Bulk get the Member Configuration Settings by specifying the 'mcs' in query parameters and keys (array of objects).

  • Write

    Bulk setting the Member Configuration Settings.

    Bulk setting configs by sending the corresponding body payload.

  • Destructive

    Update the Member Configuration Settings.

    Update the Member Configuration Settings by sending the corresponding body payload.

  • Destructive

    Delete the Member Configuration Settings

    Delete the Member Configuration Settings by specifying the 'configkey' query parameter.

Internal

  • Write

    Clear cache

    Clear cache by root member ids.

Organization

  • Read

    List organization configuration settings

    Display a listing of organization configuration settings.

  • Write

    Store organization configuration settings

    Store organization configuration settings in storage. The request may contain one or more configuration settings.

  • Write

    Bulk get the Organization Configuration Settings

    Bulk get the Organization Configuration Settings by specifying the 'mcs' in query parameters and keys (array of objects).

  • Write

    Bulk store organization configuration settings

    Bulk set member configuration settings to storage.

  • Destructive

    Update organization configuration setting

    Update the specified organization configuration settings in storage.

  • Destructive

    Delete organization configuration setting

    Remove the specified organization configuration settings from storage.

See How connections work for access and permissions, or browse all integrations.