How can I integrate with EasyRoutes?

Learn how EasyRoutes for Shopify provides full native integration with your Shopify store and how we work with your orders and apps here.

See each of the sections and quick links below for integration tips specific to various platforms & EasyRoutes use cases:

EasyRoutes-native API Integrations:

Shopify-specific Integrations:

General EasyRoutes Integrations:

EasyRoutes-native API Integrations

You can integrate with EasyRoutes directly via 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.

Use EasyRoutes' API:

  • Start using our API by reviewing 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.

Use EasyRoutes' API + Zapier:

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

Shopify-specific Integrations

In general, EasyRoutes for Shopify is deeply integrated with your Shopify setup, and many use cases can be implemented by working with Shopify's API directly.  Each of the integration scenarios described in this section apply specifically to users of EasyRoutes for Shopify.

Access route or stop data for reporting and third-party app usage

With EasyRoutes for Shopify, use the View in Orders Page functionality to select orders on a route and access only these orders for further editing or bulk actions directly within the Shopify Admin.  Full details in this support article.

Route or stop data can also be exported to CSV (or copied to the clipboard) using our export functionality. Learn more here: How do I export a route?

Sync metadata or attributes back into a Shopify order

You can sync route Information to Shopify Order Attributes either on dispatch or manually - including proof of delivery photos, eSignature, and driver notes when they are added on a stop. Full details on configuring this behaviour are available in this support article.

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

You can specify many different details on a stop (including order notes, tags, attributes, etc.) when you import it into EasyRoutes using our EasyRoutes Routes API, as well as importing via CSV file.

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.) - full details here: Filtering using Order Tags and Attributes

Add a scheduled delivery date or time window to orders

EasyRoutes includes a setting that can be enabled to show the delivery date and/or time window collected via the most popular date scheduling apps in the Shopify App Store, or included on CSV or API imports. You can also write these values directly into an order with a supported format. Learn more in the support articles for delivery dates and time windows.

Work with Shopify 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. Learn more about how EasyRoutes notifications work here.

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

Relevant Shopify 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

Separately, EasyRoutes also provides access webhooks related to your routes with our Webhooks API.

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.

With access to our EasyRoutes Routes API, you can also access stop data directly for tracking.

Access EasyRoutes proof of delivery photos for 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)

With access to our EasyRoutes Routes API, you can also access route or stop data directly.

General EasyRoutes Integrations

Each of the integration scenarios described in this section apply to users of both EasyRoutes for Shopify & EasyRoutes for Web.

Access route or stop data for reporting and third-party app usage

Route or stop data can be exported to CSV (or copied to the clipboard) using our export functionality. Learn more here: How do I export a route?

Import orders into EasyRoutes from external 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 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.

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

You can specify many different details on a stop (including order notes, tags, attributes, etc.) when you import it into EasyRoutes using our EasyRoutes Routes API, as well as importing via CSV file.

You can also use imported tag/attribute order data for route planning (e.g. filter routes by tags, attributes, etc.) - full details here: Filtering using Order Tags and Attributes

Add a scheduled delivery date or time window to orders

EasyRoutes includes a setting that can be enabled to show the delivery date and/or time window for an order - learn more.  Both delivery date and time window values can be included when importing orders via CSV import or the EasyRoutes API.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Related Articles