To further automate workflows, connect your delivery management system directly to ezCater via the Delivery Public API. This enables bi-directional syncing—your system both receives order data and pushes delivery/tracking events and statuses back to ezCater, so customers and support agents are always up-to-date. To view our delivery API documentation please visit the link here.
API Integration Steps Overview:
1. Create a Technical User-
- In ezManage, under Settings → Users & Permissions, add a new user specifically for API integration.
- Assign only the relevant store locations and grant “Integrations” permission to authorize token generation.
2. Generate Your API Token
-
- Log in as the API user, go to Settings → Integrations, and generate your one-time authorization token. Save it securely.
3. Connect to the Public API
-
- Make authenticated HTTP POST requests to ezCater’s GraphQL endpoint using the token and required headers.
- Set up webhooks to your delivery system so it can receive order events (order accepted, canceled, etc.).
4. Configure Event Subscriptions
-
- Use the deliverySubscriptionCreate mutation to subscribe your system to order-related webhook events for your store locations. This enables ezCater to send real-time notifications to your specified endpoint.
- To report delivery status updates back to ezCater, utilize the appropriate delivery lifecycle mutations (eg, courierEventCreate). These updates are separate from event subscriptions and ensure accurate tracking info is relayed to customers.
5. Sync Delivery Events and Tracking
-
- Use the courierEventCreate mutation to report key delivery lifecycle events such as “courier assigned,” “en route to customer,” “picked up,” “delivered,” and for real time tracking, utilize the courierTrackingEventCreate mutation to send tracking coordinates. We recommend sending location updates every 20 seconds while the delivery is in progress to ensure accurate and real-time tracking. To ensure an order is counted as tracked, your integration must send at minimum both an order picked up and order dropped off event using the courierEventCreate mutation.
- Use provided API mutations to submit updates, upload delivery photos, and keep all parties informed.
6. Testing and Go-Live
-
- Once your integration is complete, please reach out to Aleena McClean [aleena.mcclean@ezcater.com] so we can initiate the Delivery Public API verification and ensure everything is working as expected.
Best Practices for Self Delivery
- Encourage drivers to use delivery status updates faithfully—including proof-of-delivery photos.
- Review delivery metrics regularly to ensure on-time and accurate service.
- If you have technical questions or require advanced support, contact your Partner Success manager or api_support@ezcater.com.
By following these steps, you’ll deliver a seamless, trackable customer experience.