Public API

6min

Welcome to the ezCater Public API!

ezCater has built systems to support integration between your brand’s ezCater orders and other platforms, such as Point of Sale platforms or reporting systems, including a webhook event system and a publicly consumable API to retrieve Menu and Order data. The sections of this guide provide an overview of the processes involved in setting up the Public API’s functionality. It also provides examples of some of the ways you can use these tools to pull information from ezManage and into your POS. In a general sense, you’ll need to:

  1. Generate a one-time authentication token for that user
  2. Use that token to connect to the API
  3. Create a subscriber with GraphQL
  4. Use that subscriber to set up any desired subscriptions


What kinds of tasks can the Public API be used for?

The Public API utilizes webhooks to allow you to pull information on order events and store menus into a Point of Sale or other integrated platforms, as well as exchange information regarding menu and delivery updates. By integrating with the API, you’re able to...

  • Populate order information for injection into a store’s POS, with no manual entry required, including when an order is submitted, accepted, rejected, and cancelled
  • Pull details on your menus that exist within ezManage, and create new menus to be added into ezManage
  • Update an order within ezManage to reflect changes regarding delivery, including assignment, unassignment, and tracking


How does this integration affect order acceptance?

The short answer is: it doesn’t... yet! Accepting orders via the public API is on controlled availability as we test the feature with initial integration partners. Otherwise, caterer workflow for order acceptance will continue the same way that you’re used to. Integration with the API has no effect on the current setup of order notifications; caterers still get the phone calls, emails, and/or text messages alerting them to new ezCater orders just like they’re used to.


  1. Customer places order on ezCater Marketplace
  2. Customer receives Order Placed notification
  3. Caterer receives Order Placed notification & accepts order
    • Caterer accepts order within ezManage
    • 'Accepted' webhook notification sent to all Subscribed webhook URLs
      • Integrating Platform (vendor or brand) makes API Request Query using the order entity ID received within webhook payload
  4. Customer receives 'Order Accepted' notification
  5. Optional: Customer initiates Modification or Cancellation
    • Customer modifies order
      • Customer may request modification online until Store’s Lead Time Cutoff time
      • ezCater Customer Service may execute modification at any time, including after order fulfillment, with approval from Store if under Lead Time Cutoff
      • Customer receives Modification Accepted notification after Caterer Accept
    • Customer cancels order
      • Customer may request cancellation up to 24 hours of order fulfillment
      • ezCater Customer Service may cancel order at any time, with approval from Caterer if under 24 hours
  6. Optional: Caterer confirms Modification or Cancellation
    • Cater confirms modification
      • Modifications require additional Caterer Accept action
        • Once completed a new 'Accepted' webhook notification will be sent out, there is no 'Updated' notification
        • Integrating Partner/Brand is expected to check if 'Accepted' webhook is for new or existing order and handle accordingly
        • Caterer Accept may be completed either ezCater Customer Service with authorization from Store
    • Caterer confirms cancellation
      • 'Canceled' webhook notification sent out
  7. Optional: Customer receives notification of confirmation of Modification or Cancellation
  8. Customer gets 'Day of Confirmation' text
  9. Food arrives right on time
    • Store prepares food
    • Store may use ezDispatch or their own drivers for delivery/setup
  10. Customer receives 'Receipt' email


Special Call-Outs

  • Strategies on managing your brand's need for API Users and their subsequent Tokens will be discussed throughout the Implementations process
  • Order Query will advise whether Third Party Delivery (ezDispatch) is active on the order, which means ezCater will not pay restaurant for either tip/gratuity or delivery fee, even if those values are present in the Order Query Response
  • The best practice is for the Integrating Partner/brand to do a new Order Query prior to pushing to POS to ensure that POS has most current version of order
  • Menu synchronization is not part of the API, however, we will work with you to develop custom process for ezCater to ingest your menus, either via scheduled pulls or webhook notifications when updates are made
    • Those updates will be made manually by ezCater’s Menus Team after they have been received/processed
  • Bulk updates to Store configuration cannot be made through the API



Updated 18 Feb 2025
Did this page help you?
NEXT
Creating an API User in ezManage
Docs powered by Archbee