Public API

welcome to the ezcater public api! ezcater is excited to provide you with solutions and guidance focusing on business class food for work integration solutions this site describes solutions focusing on connecting ezcater to menu management solutions, order management platforms and delivery management solutions this guide provides an overview of the processes involved in setting up ezcater’s public api functionality and information about specific solutions and features it also provides examples of how you can use these tools to pull information from ezcater and into your solutions 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 in a general sense, you’ll need to connect your ecosystem to ezcater via api users and tokens via graphql listen for events related to menu and order use cases map stores from ezcater to your store technology send menu content from your content management systems to ezcater’s menu catalog orders api process orders by accepting and rejecting orders via ezmanage’s auto/manual processes or via integration and inject order data into store systems for fulfillment and other use cases provide delivery tracking information to help consumers and support teams to assist with order fulfillment this includes information such as assigned courier, delivery lifecycle events, real time lat/lng information and delivery dropoff images example public api workflow a brand team member creates or updates menu content to ensure customers have current and accurate information when placing an order customer places order on ezcater marketplace customer receives order placed notification caterer receives order placed notification & accepts order the order is accepted or rejected manually via ezmanage, automatically via ezmanage or via integration '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 customer receives 'order accepted' notification 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 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 optional customer receives notification of confirmation of modification or cancellation customer gets 'day of confirmation' text food arrives right on time store prepares food store may use ezdispatch or their own drivers for delivery/setup 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 catering use case includes orders having multiple modifications prior to preparing the order ezcater recommends that prior to pushing orders to the pos for fulfillment that you ensure you have the latest order modifications this can be attained by performing an order query immediately prior to sending the order for fulfillment menu synchronization is an important part of the solution bulk updates to store configuration cannot be made through the api