API Reference
Complete API reference for EasyRoutes
The EasyRoutes API allows you to programmatically manage your routes and stops. For an overview of authentication, base URLs, error handling, and pagination, see the Overview.
Endpoints
Authentication
Drivers
List driversGET
Fetch a list of all drivers associated with the shop.
Get driverGET
Fetch a single driver by ID.
Routes
List routesGET
Fetch a list of routes based on the provided query.
Create routePOST
Create an empty route with a specified start and end location.
Get routeGET
Fetch a single route by ID.
Update routePATCH
Updates top-level fields on a route by route ID.
Dispatch routePOST
Dispatches a route, making it visible on the EasyRoutes Driver App.
Undispatch routeDELETE
Undispatches a route, revoking driver access on the EasyRoutes Driver App.
Unassign route driverDELETE
Unassigns driver from a route by route ID.
Assign route driverPUT
Assigns a driver to a route by route ID.
Update route end locationPATCH
Updates the address and/or coordinates for a route's end location by route ID, or sets one if the route currently has none (in which case `address` must be included in `updateMask`).
Update route end tasksPUT
Updates the tasks required to complete a route by route ID.
Resync route ordersPOST
Resync updates only `SHOPIFY_ORDER` stops.
Update route start locationPATCH
Updates the address and/or coordinates for a route's start location by route ID.
Update route start tasksPUT
Updates the tasks required before starting a route by route ID.
Unassign route vehicleDELETE
Unassigns vehicle from a route by route ID.
Assign route vehiclePUT
Assigns a vehicle to a route by route ID.
Stops
Reoptimize routePOST
Reoptimizes a route according to the currently configured route options.
Add route Shopify ordersPOST
Adds Shopify orders to a route by route ID as `SHOPIFY_ORDER` stops.
Add route stopsPOST
Adds stops to a route by route ID.
Delete route stopsDELETE
Deletes one or more stops from a route by route ID and stop IDs.
Get route stopGET
Fetch a single stop on a route by route ID and stop ID.
Update route stopPATCH
Updates a stop on a route by route ID and stop ID.
Update route stop itemsPUT
Updates the custom items for an imported stop or a Shopify order stop on a route.
Update route stop locationPATCH
Updates the address and/or planned coordinates for a stop on a route by route ID and stop ID.
Reorder route stopPUT
Moves a stop on a route to a specific 0-based final index in the `stops` list.
Update route stop Shopify order itemsPUT
Updates which of the Shopify order's line items a `SHOPIFY_ORDER` stop delivers, and how many of each, from the order's unfulfilled items or from one of its fulfillments.
Update route stop tasksPUT
Updates the tasks for a stop on a route.
List imported stopsGET
Fetch a list of imported stops.
Import stopsPOST
Import stops into EasyRoutes from an external source.
Get imported stopGET
Fetch a single imported stop by ID.
Update imported stopPATCH
Updates top-level fields on an existing imported stop by ID, without needing to re-send the full stop payload via ImportStops.
Delete imported stopDELETE
Delete an imported stop by ID.
Update imported stop itemsPUT
Updates the items on an existing imported stop by ID, without needing to re-send the full stop payload via ImportStops.
Update imported stop locationPATCH
Updates the address and/or coordinates for an imported stop by ID.
Get imported stop route infoGET
Fetch the route and stop IDs for an imported stop that has been added to one or more routes.
Update imported stop tasksPUT
Updates the tasks on an existing imported stop by ID, without needing to re-send the full stop payload via ImportStops.
Get Shopify stop route infoGET
Fetch the route and stop IDs for a Shopify order that has been added to one or more routes.
Vehicles
List vehiclesGET
Fetch a paginated list of vehicles associated with the shop.
Get vehicleGET
Fetch a single vehicle by ID.