How can I integrate with EasyRoutes?
EasyRoutes API is available for early access in closed beta — contact us if you are interested in API access.
In general, EasyRoutes is deeply integrated with your Shopify setup, many use cases where you are looking for API access can be enabled through working with Shopify's API directly, or with EasyRoutes functionality/API.
Below are common scenarios that we can address either using Shopify directly or with EasyRoutes functionality.
Common Scenarios
Show or use information (e.g. notes or tags to my order) in EasyRoutes via 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 review your EasyRoutes settings to show specific information (e.g. order notes, tags, attributes, customer notes, etc.)
You can also use your Shopify order data for planning (e.g. filter routes by tags, attributes, etc.)
Optionally, you can write the proof of delivery photos, signature and driver note onto an order's attributes.
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.
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.
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.
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.
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
Separately, EasyRoutes also provides access webhooks related to your routes with our Webhooks API.
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)
With access to our EasyRoutes Routes API, you can also access route or stop data directly.
Access route or stop data for reporting and third-party apps
You 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?
You can also perform bulk actions on route orders by using the "View in Orders Page" functionality.
With access to our EasyRoutes Routes API, you can also access route or stop data directly.
Further reading: