Public API for Catering Partne...
Orders API
Order Schema Reference
44 min
order schema reference objects address an address record can be for users, caterers, brands, etc true 385 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type example { "city" "boston", "deliveryinstructions" "ask for jane at front desk", "name" "", "state" "ma", "statename" "massachusetts", "street" "12345 restaurant avenue", "street2" null, "street3" null, "zip" "54321" } acceptorderpayload return type of acceptorder true 336 unhandled content type unhandled content type unhandled content type unhandled content type example { "order" order! } caterer a caterer representing a specific location providing catering true 379 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type example { "address" address, "live" true, "name" "my caterer name", "storenumber" "00001", "uuid" "ezcater caterer id" } caterercart information about items on an order, from the caterer's perspective true 377 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type example { "feesanddiscounts" \[lineitem!]!, "orderitems" \[orderitem!]!, "tableware" tableware, "totals" caterertotals } caterertotals various order totals, from the caterer's perspective true 369 unhandled content type unhandled content type unhandled content type unhandled content type example { "caterertotaldue" 171 02 } event information about the event an order is associated with (e g time, date, location, etc ) true 374 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type example { "address" address, "catererhandofffoodtime" "2025 03 27t16 15 00z", "contact" eventcontact, "customerprovidedname" "team building event", "headcount" 10, "ordertype" "delivery", "thirdpartydeliverypartner" null, "timezoneidentifier" "america/new york", "timezoneoffset" " 04 00", "timestamp" "2025 03 27t16 30 00z" } eventcontact on site contact who will receive order on day of event true 374 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type example { "name" "jane doe", "phone" "5555555555" } money monetary information on tip and totals for an order true 372 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type example { "currency" "usd", "subunits" 23864, "subunitsv2" "23864" } lineitem order line items like taxes, fees, and discounts true 385 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type example { "cost" money, "name" "delivery fee" } order a customer's catering order true 370 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type example { "caterer" caterer, "caterercart" caterercart, "deliveryid" "3593ce70 7227 4fd4 8a78 9591083d0674", "event" event, "istaxexempt" false, "lifecycle" orderlifecycle, "ordercustomer" ordercustomer, "ordernumber" "o1o1o1", "ordersourcetype" "marketplace", "taxableaddress" address!, "totals" ordertotals, "uuid" "your ezcater order id" } ordercustomer a copy of the customer's contact information associated with an order true 375 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type example { "firstname" "jane", "lastname" "doe", "fullname" "jane doe" } orderitem individual selections from the menu a customer has made for an order true 378 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type example { "customizations" \[orderitemcustomization!]!, "labelfor" null, "menuitemsizeid" "ezcater menu version size 12 inch pizza item selection id", "menuitemsizename" "12\\" pizza", "name" "margherita pizza", "notetocaterer" "12\\" thin crust margherita pizza", "positemid" "12 inch pizza item selection id", "quantity" 10, "specialinstructions" "please be careful not to burn crust", "totalinsubunits" money, "uuid" "83ec5c82 fa68 437c 90d7 ad861a2c151b" } orderitemcustomization customizations for an order item true 379 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type example { "customizationid" "ezcater menu version customization parmigiano reggiano choice 12 inch selection id", "customizationtypeid" "ezcater menu version customization type cheese addon options id", "customizationtypename" "cheese addon", "name" "parmigiano reggiano", "poscustomizationid" "parmigiano reggiano choice 12 inch selection id", "quantity" 10 } orderlifecycle describes where an order is in it's lifecycle true 380 unhandled content type unhandled content type unhandled content type unhandled content type example { "orderiscurrently" "accepted" } ordertotals monetary information on tip and totals for an order true 378 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type example { "customertotaldue" money!, "pointofsaleintegrationfee" money!, "salestax" money!, "salestaxremittance" money!, "subtotal" money!, "tip" money! } rejectorderpayload return type of rejectorder true 336 unhandled content type unhandled content type unhandled content type unhandled content type example { "order" order! } tableware a collection of tableware choices true 379 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type example { "specialinstructions" null, "tablewarechoices" \[tablewarechoice!] } tablewarechoice complimentary tableware items, such as plates, napkins, utensils true 383 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type example { "choiceuuid" "7acc72ed 2240 4b9f a903 f7873b94ba60", "isincluded" true, "itemcount" 10, "name" "napkins" } input objects rejectorderinput parameters for rejecting an order true 336 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type example { "explanation" "this location can't accept any more orders for that delivery date", "reason" "at daily capacity" } enums currency allowed currency values for money true 377 unhandled content type unhandled content type unhandled content type unhandled content type feeordiscounttype a list of fee or discounts types that can be included on an order applied to the feesanddiscounts as a filter on the field's return type true 370 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type ordertypeenum allowed values for order type true 377 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type ordertypeperspective allowed values for an order type perspective applied to the ordertype as a filter on the field's return type true 371 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type ordersource allowed values for order sources an order source represents what user flow the order originated from true 372 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type rejectionreasonenum allowed values for an order rejection reason, though some are unlikely to be relevant to an api integration true 399 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type scalars bigint represents non fractional signed whole numeric values since the value may exceed the size of a 32 bit integer, it's encoded as a string boolean the boolean scalar type represents true or false date iso 8601 date only string, e g 2017 12 14 float the float scalar type represents signed double precision fractional values as specified by ieee 754 id the id scalar type represents a unique identifier, often used to refetch an object or as key for a cache the id type appears in a json response as a string; however, it is not intended to be human readable when expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an id iso8601datetime an iso 8601 encoded datetime @specifiedby(url https //tools ietf org/html/rfc3339 ) int the int scalar type represents non fractional signed whole numeric values int can represent values between (2^31) and 2^31 1 json represents untyped json string the string scalar type represents textual data, represented as utf 8 character sequences the string type is most often used by graphql to represent free form human readable text utctimestamp iso8601 formatted date & timestamp in utc uuid universally unique identifier as defined by rfc 4122