Order Schema Reference

order schema reference objects address an address record can be for users, caterers, brands, etc field name description city string! docid\ u2uigsyo0gfpxj 5tuif0 the name of the city where the address is located deliveryinstructions string docid\ u2uigsyo0gfpxj 5tuif0 specific instructions provided for the delivery, such as parking details or particular points of entry name string docid\ u2uigsyo0gfpxj 5tuif0 the name associated with the address, which could be a business name or a contact person state string! docid\ u2uigsyo0gfpxj 5tuif0 the two letter abbreviation for the state in which the address is located (e g , ma for massachusetts) statename string docid\ u2uigsyo0gfpxj 5tuif0 the full name of the state corresponding to the address (e g , massachusetts) street string! docid\ u2uigsyo0gfpxj 5tuif0 the primary street address or street line 1 street2 string docid\ u2uigsyo0gfpxj 5tuif0 the secondary street address or street line 2, used for additional address components such as apartment or suite numbers street3 string docid\ u2uigsyo0gfpxj 5tuif0 an additional address field for further granularity, often used for large complexes or extended addresses zip string docid\ u2uigsyo0gfpxj 5tuif0 the postal code for the address location 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 field name description order order! docid\ u2uigsyo0gfpxj 5tuif0 a customer's order for catering example { "order" order! } caterer a caterer representing a specific location providing catering field name description address address docid\ u2uigsyo0gfpxj 5tuif0 the physical location or mailing address of a store or entity, which can include various subfields such as street, city, state, and zip code live boolean! docid\ u2uigsyo0gfpxj 5tuif0 indicates whether an the caterer location is currently active, or operational name string! docid\ u2uigsyo0gfpxj 5tuif0 the name associated with the caterer location storenumber string docid\ u2uigsyo0gfpxj 5tuif0 a unique identifier assigned to each store it is used to differentiate between different stores in a chain or franchise uuid uuid! docid\ u2uigsyo0gfpxj 5tuif0 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 field name description feesanddiscounts(types \[feeordiscounttype!]) \[lineitem!]! docid\ u2uigsyo0gfpxj 5tuif0 enumeration of various fees and discounts provided to the caterer orderitems \[orderitem!]! docid\ u2uigsyo0gfpxj 5tuif0 the specific items ordered by a customer each order item typically includes details such as the item's name, price, quantity, special instructions, and any associated options or customizations tableware tableware docid\ u2uigsyo0gfpxj 5tuif0 the collection of utensils and other tableware items included with the order, such as forks, knives, or plates totals caterertotals docid\ u2uigsyo0gfpxj 5tuif0 the summarized financial details of the order, including subtotals, total due, taxes, tips, and overall amounts payable by the customer example { "feesanddiscounts" \[lineitem!]!, "orderitems" \[orderitem!]!, "tableware" tableware, "totals" caterertotals } caterertotals various order totals, from the caterer's perspective field name description caterertotaldue float docid\ u2uigsyo0gfpxj 5tuif0 the sum of all order item prices, line items, and tip with commission and cc fee subtracted example { "caterertotaldue" 171 02 } event information about the event an order is associated with (e g time, date, location, etc ) field name description address(shouldusesearchaddress boolean = false) address docid\ u2uigsyo0gfpxj 5tuif0 the location at which the order is expected to be delivered by the caterer when shouldusesearchaddress boolean = true then it includes the address the customer searched for (relevant for takeout orders) catererhandofffoodtime utctimestamp docid\ u2uigsyo0gfpxj 5tuif0 the utc timestamp indicating when the caterer must be ready to give prepared food to the customer or delivery partner contact eventcontact docid\ u2uigsyo0gfpxj 5tuif0 on site contact who will receive order on day of event customerprovidedname string docid\ u2uigsyo0gfpxj 5tuif0 the name for the event that was provided by the customer headcount int docid\ u2uigsyo0gfpxj 5tuif0 the number of people that an order is intended to serve ordertype(perspective ordertypeperspective) ordertypeenum! docid\ u2uigsyo0gfpxj 5tuif0 the specific manner in which an order is processed or fulfilled thirdpartydeliverypartner string docid\ u2uigsyo0gfpxj 5tuif0 the third party delivery partner's name timezoneidentifier string docid\ u2uigsyo0gfpxj 5tuif0 the time zone identifier of the event in a format like 'america/new york' full list of time zone identifiers here https //en wikipedia org/wiki/list of tz database time zones https //en wikipedia org/wiki/list of tz database time zones timezoneoffset string docid\ u2uigsyo0gfpxj 5tuif0 the utc offset for time zone identifier, for example 4 00 timestamp utctimestamp docid\ u2uigsyo0gfpxj 5tuif0 the utc timestamp indicating when the customer expects to receive food 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 field name description name string docid\ u2uigsyo0gfpxj 5tuif0 the name of the on site contact who will receive the order phone string docid\ u2uigsyo0gfpxj 5tuif0 the phone number of the on site contact who will receive the order example { "name" "jane doe", "phone" "5555555555" } money monetary information on tip and totals for an order field name description currency currency! docid\ u2uigsyo0gfpxj 5tuif0 allowed currency values for money subunits int! docid\ u2uigsyo0gfpxj 5tuif0 monetary amount in currency sub units (e g for us dollars, this would be an amount in pennies); limited to 32 bit integer ( 2 147 483 647 == $21 474 836 47 ) subunitsv2 bigint! docid\ u2uigsyo0gfpxj 5tuif0 monetary amount in currency sub units (e g for us dollars, this would be an amount in pennies) example { "currency" "usd", "subunits" 23864, "subunitsv2" "23864" } lineitem order line items like taxes, fees, and discounts field name description cost money docid\ u2uigsyo0gfpxj 5tuif0 monetary information for the order line item name string docid\ u2uigsyo0gfpxj 5tuif0 name of the order line item example { "cost" money, "name" "delivery fee" } order a customer's catering order field name description caterer caterer docid\ u2uigsyo0gfpxj 5tuif0 a caterer representing a specific location or store providing catering caterercart caterercart docid\ u2uigsyo0gfpxj 5tuif0 the information about items on the order, from the caterer's perspective deliveryid id docid\ u2uigsyo0gfpxj 5tuif0 the globally unique identifier of the delivery for the order event event docid\ u2uigsyo0gfpxj 5tuif0 information about the order's event (e g time, date, location, etc ) istaxexempt boolean! docid\ u2uigsyo0gfpxj 5tuif0 whether or not this order is tax exempt lifecycle orderlifecycle docid\ u2uigsyo0gfpxj 5tuif0 a description of where an order is in it's lifecycle ordercustomer ordercustomer docid\ u2uigsyo0gfpxj 5tuif0 customer's contact information for privacy reasons, this may not always be provided ordernumber string docid\ u2uigsyo0gfpxj 5tuif0 reference identifier to be used when interacting with support at ezcater ordersourcetype ordersource docid\ u2uigsyo0gfpxj 5tuif0 the channel that an order comes in through taxableaddress address! docid\ u2uigsyo0gfpxj 5tuif0 the address used to calculate sales tax for an order this will either be the origin (store) address or the destination (event) address totals ordertotals docid\ u2uigsyo0gfpxj 5tuif0 monetary information on order's tip and totals uuid uuid! docid\ u2uigsyo0gfpxj 5tuif0 the id of the specific order 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 field name description firstname string docid\ u2uigsyo0gfpxj 5tuif0 customers first name lastname string docid\ u2uigsyo0gfpxj 5tuif0 customers last name fullname string docid\ u2uigsyo0gfpxj 5tuif0 customers full name example { "firstname" "jane", "lastname" "doe", "fullname" "jane doe" } orderitem individual selections from the menu a customer has made for an order field name description customizations \[orderitemcustomization!]! docid\ u2uigsyo0gfpxj 5tuif0 selected customizations for the order item labelfor string docid\ u2uigsyo0gfpxj 5tuif0 the name of the person attached to the order item menuitemsizeid uuid docid\ u2uigsyo0gfpxj 5tuif0 the id corresponding with a specifically sized item in the caterer's menu menuitemsizename string docid\ u2uigsyo0gfpxj 5tuif0 size selected by the customer in string format name string docid\ u2uigsyo0gfpxj 5tuif0 name of the order item notetocaterer string docid\ u2uigsyo0gfpxj 5tuif0 a note to describe what's included in the item only visible to the caterer positemid string docid\ u2uigsyo0gfpxj 5tuif0 the the posid for the size specified by the order item this id represents the id of this item in an external api quantity int! docid\ u2uigsyo0gfpxj 5tuif0 quantity of the specific order item specialinstructions string docid\ u2uigsyo0gfpxj 5tuif0 specific instructions written by the customer for this item totalinsubunits money docid\ u2uigsyo0gfpxj 5tuif0 total cost of item, including customizations, in currency sub units uuid uuid! docid\ u2uigsyo0gfpxj 5tuif0 the id of the specific order item 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 field name description customizationid id! docid\ u2uigsyo0gfpxj 5tuif0 id corresponding with a specifically sized item customization in the caterer's menu customizationtypeid id! docid\ u2uigsyo0gfpxj 5tuif0 id corresponding with a specific customization label in the caterer's menu customizationtypename string! docid\ u2uigsyo0gfpxj 5tuif0 name corresponding with a specific customization label in the caterer's menu name string! docid\ u2uigsyo0gfpxj 5tuif0 name of the order item customization poscustomizationid string docid\ u2uigsyo0gfpxj 5tuif0 pos id corresponding with a specific customization in the caterer's menu quantity int docid\ u2uigsyo0gfpxj 5tuif0 count of items with this customization note that these items may also have other customizations 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 field name description orderiscurrently string docid\ u2uigsyo0gfpxj 5tuif0 where the order is in its lifecycle example { "orderiscurrently" "accepted" } ordertotals monetary information on tip and totals for an order field name description customertotaldue money! docid\ u2uigsyo0gfpxj 5tuif0 the total amount that the customer owes for their order pointofsaleintegrationfee money! docid\ u2uigsyo0gfpxj 5tuif0 fee charged for using a specific pos system salestax money! docid\ u2uigsyo0gfpxj 5tuif0 the sales tax collected for the order salestaxremittance money! docid\ u2uigsyo0gfpxj 5tuif0 the sales tax remitted by ezcater subtotal money! docid\ u2uigsyo0gfpxj 5tuif0 total cost of all food items in an order tip money docid\ u2uigsyo0gfpxj 5tuif0 the gratuities added to the order for the delivery or kitchen personnel example { "customertotaldue" money!, "pointofsaleintegrationfee" money!, "salestax" money!, "salestaxremittance" money!, "subtotal" money!, "tip" money! } rejectorderpayload return type of rejectorder field name description order order! docid\ u2uigsyo0gfpxj 5tuif0 a customer's order for catering example { "order" order! } tableware a collection of tableware choices field name description specialinstructions string docid\ u2uigsyo0gfpxj 5tuif0 instructions written by customer about tableware needs tablewarechoices \[tablewarechoice!] docid\ u2uigsyo0gfpxj 5tuif0 tableware selections a customer has made for the order example { "specialinstructions" null, "tablewarechoices" \[tablewarechoice!] } tablewarechoice complimentary tableware items, such as plates, napkins, utensils field name description choiceuuid uuid! docid\ u2uigsyo0gfpxj 5tuif0 id corresponding with the tableware item in the caterer's menu isincluded boolean! docid\ u2uigsyo0gfpxj 5tuif0 this boolean term indicates whether the tableware is included on the order itemcount int! docid\ u2uigsyo0gfpxj 5tuif0 the number of pieces of tableware included on the order name string! docid\ u2uigsyo0gfpxj 5tuif0 the name or description of the tableware item on the order example { "choiceuuid" "7acc72ed 2240 4b9f a903 f7873b94ba60", "isincluded" true, "itemcount" 10, "name" "napkins" } input objects rejectorderinput parameters for rejecting an order field name description explanation string docid\ u2uigsyo0gfpxj 5tuif0 reason rejectionreasonenum! docid\ u2uigsyo0gfpxj 5tuif0 provides a reason for rejecting the order not all of the reasons are relevant to an api integration 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 enum name description usd currency is in us dollars (usd) 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 enum name description adjustment adjustments can represent various alterations to the order total, such as refunds or corrections to previous charges delivery fee delivery fees are charged to cover the cost associated with delivering the order from the caterer to the customer discount discounts are applied to reduce the total amount due for the customer, often as a promotional offer or incentive misc fee miscellaneous fees can include various charges that do not fall under standard categories, such as concierge or specific administrative fees ordertypeenum allowed values for order type enum name description delivery the customer selects delivery, and the caterer is responsible for delivering the order themselves using their own fleet takeout the customers selects to pick up their order directly from the caterer's location, eliminating the need for delivery third party delivery the customer selects delivery, and the caterer uses dispatch, to deliver the order to the customer ordertypeperspective allowed values for an order type perspective applied to the ordertype as a filter on the field's return type enum name description caterer filters ordertype information to align with the perspective of the caterer customer filters ordertype information to align with the perspective of the customer ezcater filters ordertype information to align with the perspective of ezcater ordersource allowed values for order sources an order source represents what user flow the order originated from enum name description club soda order was placed through club soda, also known as meal program, a service that allows for grouping individual catering orders from multiple people into one larger order, typically for workplace consumption direct entry order was placed through direct entry, a feature within ezcater that allows restaurant partners to submit their own orders directly into the system ez ordering order was placed through online ordering, an ordering platform supported by ezcater that enables restaurant partners to facilitate online orders through their own websites marketplace order was placed through the marketplace, ezcater’s primary platform where users can place catering orders from a broad range of partner restaurants rejectionreasonenum allowed values for an order rejection reason, though some are unlikely to be relevant to an api integration enum name description at daily capacity used when the caterer has reached their maximum order capacity for the entire day at hourly capacity used when the caterer has reached their maximum number of orders for a specific hour, rather than for the full day commission or fees too high used when the caterer rejects an order because the commission or fees associated with it are deemed too high distance too far used when the caterer rejects an order because the delivery distance is beyond their serviceable range does not offer take out or delivery used when the caterer doesn't provide either takeout or delivery services does not remember signing up for ezcater used when the caterer claims no recollection of subscribing to ezcater services emergency closure used when unforeseen circumstances cause the caterer to shut down temporarily holiday closure used when the caterer has planned closures on holidays lack of inventory used when the caterer has insufficient stock or ingredients lead time too short to deliver used when there's insufficient time to deliver the order as requested lead time too short to prepare used when there's not enough time to prepare the order menu incorrect used when there are issues with the menu items specified in the order missing customer contact information used when the order cannot be fulfilled due to the lack of necessary customer contact details no drivers available used when there are no drivers available to deliver the order no tip used when the lack of a tip influences the caterer's decision to reject the order ownership changed used when the ownership of the caterer has changed, which affects the order fulfillment capabilities permanently closed used when the caterer has ceased operations permanently reason not listed used when none of the listed reasons accurately describe the rejection this is a catch all category staff shortage used when there are not enough staff members to handle the order temporarily closed used when the caterer is temporarily closed for short term reasons weather used when adverse weather conditions preventing order fulfillment wrong hours used when the order is placed outside of the caterer's operational hours 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 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