API Reference

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.

Authenticate a client to obtain an access token using a client ID and secret key.

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.

Stops

Reoptimize routePOST

Reoptimizes a route according to the currently configured route options.

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 an imported stop on a route by route ID and stop ID.

Update route stop itemsPUT

Updates the items for an imported 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 tasksPUT

Updates the tasks for an imported 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.

Delete imported stopDELETE

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

Get Shopify stop route infoGET

Fetch the route and stop IDs for a Shopify order that has been added to one or more routes.

Webhooks

List webhook subscriptionsGET

Fetch a list of all webhook subscriptions.

Subscribe webhookPOST

Creates a new webhook subscription to receive events from EasyRoutes.

Unsubscribe webhookDELETE

Unsubscribe from a webhook by ID.

Endpoints

Authentication

AuthenticatePOST