How can I integrate with EasyRoutes?

You can integrate with EasyRoutes directly through our Routes and Webhooks API. This integration is compatible with both EasyRoutes for Shopify and EasyRoutes for Web, providing flexibility regardless of your platform choice. You can learn more about how to:

• Start using our API with our API Getting Started Guide
• Use our Routes API to add stops into EasyRoutes for route planning, and access route and stop data
• Use our Webhooks API to react to real-time changes in routes and stops for integrations or connect with Zapier to integrate with no-code workflows

Additionally, our APIs are designed to work seamlessly with Zapier, allowing you to:

• Feed webhooks into Zapier as triggers. Learn how to connect webhooks to Zapier that are triggered by route updates or events in EasyRoutes (see Integrate Zapier with Webhooks)
• Import stops into EasyRoutes for planning with our Import Stop action on Zapier.

This functionality enables you to automate workflows and connect with a wide range of applications without the need for extensive coding.  

Integration Scenarios

Below are common scenarios that we can address either using Shopify directly or with EasyRoutes functionality.

Access route or stop data for reporting and third-party apps

With access to our EasyRoutes Routes API, you can also access route or stop data directly. You also can export route or stop data by CSV or copy this data to your clipboard using our export functionality. Learn more here: How do I export a route?

With EasyRoutes for Shopify, you can also perform bulk actions on route orders by using the "View in Orders Page" functionality.

I need to import orders into EasyRoutes from data sources

We support importing stops via spreadsheet, by Zapier or API which allows you to add orders for deliveries from many data sources. Check out our this page for more on how to integrate your data sources with EasyRoutes by API, Zapier action or guides on importing orders from popular e-commerce platforms. You can do this on EasyRoutes for Shopify and EasyRoutes for Web.

Show or use information (e.g. notes or tags to my order) in EasyRoutes

You can specify many different details on a stop when you import it into EasyRoutes using our EasyRoutes Routes API, (notes, tags, attributes, etc.)

For Shopify orders, EasyRoutes uses Shopify order information directly in our app and our driver mobile app. If you want to add information to show to your drivers or dispatcher for planning, add it to your Shopify order itself via the admin interface, the order object directly with the Shopify API, or workflow automation software like Shopify Flow (e.g. tag an order when it's created based on a condition) or Zapier. There are also apps like Draft Order Attributes that let you add custom order attributes. You can also use your Shopify order data for planning (e.g. filter routes by tags, attributes, etc.)

You can review your EasyRoutes settings to show specific information (e.g. order notes, tags, attributes, customer notes, etc.)

Sync metadata or attributes back into a Shopify order

You can Sync Route Information to Shopify Order Attributes either on dispatch or manually. Learn more.

Optionally, you can write the proof of delivery photos, signature and driver note onto an order's attributes when they are added on a stop if you enable these in your settings.

Add a scheduled delivery date to my order

EasyRoutes includes a setting that can be enabled to show the delivery date collected via the most popular date scheduling apps in the Shopify App Store. You can also write these values directly into an order with a supported format. Learn more.

For imported stops - you can add a delivery date on import by spreadsheet or through the API.

Add a time window to my order

EasyRoutes includes a setting that can be enabled to show the delivery time window collected via the most popular date scheduling apps in the Shopify App Store. You can also write these values directly into an order with a supported format. You can also add time windows on import. Learn more.

For imported stops - you can add a time window on import by spreadsheet or through the API.

Delivery Statuses, Orders and Notifications

EasyRoutes creates and updates Shopify order fulfillments, and this also triggers Shopify or EasyRoutes notifications based on your store and app settings. In general, when a route stop has a status update, we attempt to create FulfillmentEvents on the order fulfillment that's related to the route with the appropriate status.

These events generally map to the "Delivery Status" filter in your Shopify admin for Shopify orders on the Orders page:

Relevant API documentation to review:

• FulfillmentEvent - see the status field on the FulfillmentEvent resource — for example, on out for delivery updates, we create this object on a fulfillment with status set to out_for_delivery
• Listen for the fulfillment_events/create, fulfillment/create or fulfillment/update webhooks through which Shopify will tell you that this event has been created, or access these events via Shopify Flow

Here's the list of statuses that we map to for a FulfillmentEvent:

• confirmed: Ready for Delivery
• out_for_delivery: Out for Delivery
• delivered: Delivered
• attempted_delivery: Attempted

Learn more about how EasyRoutes notifications work here.

Access EasyRoutes tracking information on an order

EasyRoutes creates and updates Shopify order fulfillments. In general, when a route stop has a status update, we attempt to add the EasyRoutes tracking page link to the fulfillment when we fulfill your order, based on your settings.

It's possible to make something that listens to Shopify webhooks (e.g., fulfillments/create, fulfillments/update) to access the tracking link when it's added, or on the order fulfillment itself, or access these events via Shopify Flow.

Learn more about how our tracking links work here.

Access EasyRoutes proof of delivery photos on an order

You can show your Photo Proof of Delivery in any of your email notifications using Shopify's order attributes once photos are taken and uploaded. Learn more and see sample integration code here: Proof of Delivery (Photos, E-Signature, Notes)

Perform bulk actions for orders on a route

Customers can use the "View in orders page" action on a route to launch the Shopify admin with route orders for performing bulk actions directly on the orders themselves.

Further reading:

• More on how EasyRoutes works with your Shopify setup and third-party apps