EasyRoutes API

API Changelog

New features, improvements, and fixes in the EasyRoutes API.

rev 3a7e902
3 endpoint changes

Endpoint changes

PATCH/stops/imports/{id}
Update imported stop

Updates top-level fields on an existing imported stop by ID without requiring a full payload. This partial update applies only the fields specified in the update mask.

Added

Added the PATCH /stops/imports/{id} endpoint to allow partial updates to imported stops using an update mask.

Tags: Stops
PATCH/routes/{routeId}/end/location
Update route end location

A new endpoint has been added to update the address or coordinates for a route's end location. This partial update affects distances, ETAs, and optimization status.

Added

Added the PATCH /routes/{routeId}/end/location endpoint to update or set a route's end location.

Tags: Routes
PATCH/routes/{routeId}/start/location
Update route start location

Updates the address and/or coordinates for a route's start location by route ID. This partial update requires an updateMask for address or coordinates and results in recalculated distances and ETAs.

Added

Added the PATCH /routes/{routeId}/start/location endpoint to update a route's start location address or coordinates.

Tags: Routes

rev 39a5531
7 schema changes

Schema changes

RouteUpdate

You can now configure additional constraints and preferences when updating a route.

Tags: Routes
Changed

Added optional maxDuration property.

Changed

Added optional maxStops property.

Changed

Added optional maxItemCount property.

Changed

Added optional maxKilograms property.

Changed

Added optional avoidTolls property.

Changed

Added optional avoidUTurns property.

Changed

Added optional speedFactor property.

Affected endpointsPATCH /routes/{routeId}

rev a2a8e35
1 endpoint change

Endpoint changes

PATCH/routes/{routeId}
Update route

Updates top-level fields on a route by route ID. This is a partial update: provide the fields to change in route and list their paths in updateMask. Only the paths listed in updateMask are applied; omitted fields are left unchanged. The route must not be archived. The response returns the full updated route.

Added

Added the UpdateRoute endpoint to allow partial updates to route fields using a PATCH request.

Tags: Routes

rev e45bc94
7 schema changes

Schema changes

Route

Access new route constraints and routing preferences.

Tags: Routes · Stops
Changed

Added maxDuration to specify the maximum allowed time for a route.

Changed

Added maxStops to limit the number of stops on a route.

Changed

Added maxItemCount to define the maximum number of items allowed.

Changed

Added maxKilograms to set the maximum weight capacity.

Changed

Added avoidTolls to indicate if toll roads should be bypassed.

Changed

Added avoidUTurns to indicate if U-turns should be restricted.

Changed

Added speedFactor to adjust travel time calculations.

Affected endpointsGET /routesPOST /routesGET /routes/{id}POST /routes/{id}/reoptimizeDELETE /routes/{routeId}/dispatchPOST /routes/{routeId}/dispatchDELETE /routes/{routeId}/driverPUT /routes/{routeId}/driverPOST /routes/{routeId}/stopsDELETE /routes/{routeId}/stops/{stopIds}PUT /routes/{routeId}/stops/{stopId}/position

rev 702a824
2 endpoint changes

Endpoint changes

PUT/routes/{routeId}/stops/{stopId}/tasks
Update route stop tasks

Updates the tasks for an imported stop on a route. Allows you to set or replace the list of driver tasks for a stop that was previously imported via ImportStops.

Added

Added the PUT /routes/{routeId}/stops/{stopId}/tasks endpoint to allow full replacement of driver tasks for imported stops.

Tags: Stops
GET/stops/imports
Imported stops

Retrieve a list of imported stop locations.

Breaking

The limit parameter now requires a minimum value of 1.

Tags: Stops

rev ef74bb4
2 schema changes

Schema changes

Route

Access route-level tags and default stop durations.

Tags: Routes · Stops
Changed

Added optional tags to the Route.

Changed

Added an optional default stop duration.

Affected endpointsGET /routesPOST /routesGET /routes/{id}POST /routes/{id}/reoptimizeDELETE /routes/{routeId}/dispatchPOST /routes/{routeId}/dispatchDELETE /routes/{routeId}/driverPUT /routes/{routeId}/driverPOST /routes/{routeId}/stopsDELETE /routes/{routeId}/stops/{stopIds}PUT /routes/{routeId}/stops/{stopId}/position

rev 7d39caf
1 schema change

Schema changes

Route

You can now view additional notes associated with your routes.

Tags: Routes · Stops
Changed

Includes an optional note.

Affected endpointsGET /routesPOST /routesGET /routes/{id}POST /routes/{id}/reoptimizeDELETE /routes/{routeId}/dispatchPOST /routes/{routeId}/dispatchDELETE /routes/{routeId}/driverPUT /routes/{routeId}/driverPOST /routes/{routeId}/stopsDELETE /routes/{routeId}/stops/{stopIds}PUT /routes/{routeId}/stops/{stopId}/position