Menu Schema Reference

menu schema reference objects menucreatepayload return type of menucreate field name description errors docid\ ibvuqpk0mwpaa9dskeujy a collection of errors generated when trying to create a menu menucreationrequestid docid\ ibvuqpk0mwpaa9dskeujy a unique identifier for the specific menu creation request success docid\ ibvuqpk0mwpaa9dskeujy a boolean indicating whether the menu creation request was received successfully menucreationexception an exception that occurred when trying to create a menu field name description details docid\ ibvuqpk0mwpaa9dskeujy a list of more details related to an error or warning message docid\ ibvuqpk0mwpaa9dskeujy a warning or error message example { "details" { "source" "categories", "source name" "pizzas", "source pos id" "pizzas category id", "reference type" "items", "referenced pos id" "margherita pizza item id" }, "message" "referenced entity is not defined" } menucreationrequest an object to describe the status of a menucreationrequest field name description errors docid\ ibvuqpk0mwpaa9dskeujy the collection of errors generated by this menucreationrequest menuuuid docid\ ibvuqpk0mwpaa9dskeujy the uuid of the created menu outcome docid\ ibvuqpk0mwpaa9dskeujy an evaluation of the aggregate outcomes of all the steps status docid\ ibvuqpk0mwpaa9dskeujy the present status of the mcr warnings docid\ ibvuqpk0mwpaa9dskeujy the collection of warnings generated by this menucreationrequest example { "errors" \[menucreationexception!], "menuuuid" "ezcater menu id", "outcome" "success", "status" "complete", "warnings" \[menucreationexception!] } inputs when creating a menu, each instance of a menu entity category, item, option and choice must have a different external posid if they have different names, prices, option groups etc categoryinput a section of the menu field name description description docid\ ibvuqpk0mwpaa9dskeujy a description providing more info about this category for users itemposids docid\ ibvuqpk0mwpaa9dskeujy a list of item posid 's to be included within this category name docid\ ibvuqpk0mwpaa9dskeujy a human friendly name to be displayed for this category posid docid\ ibvuqpk0mwpaa9dskeujy a client supplied category id to easily match between systems sortorder docid\ ibvuqpk0mwpaa9dskeujy a number to determine where in the menu the category will be displayed example { "name" "pizzas", "posid" "margherita pizza item id", "sortorder" 2, "description" "a selection of our famous pizzas", "itemposids" \[ "margherita pizza item selection id" ] } choiceinput the choices available for a given option field name description caterernote docid\ ibvuqpk0mwpaa9dskeujy a label supplied by the caterer for internal use choicetypetags docid\ ibvuqpk0mwpaa9dskeujy a list of entitytypetag enums that apply to this choice defaultchoice docid\ ibvuqpk0mwpaa9dskeujy whether this choice should be selected if the customer makes no selections description docid\ ibvuqpk0mwpaa9dskeujy a description providing information about this choice for users enablesubquantities docid\ ibvuqpk0mwpaa9dskeujy = false enable the selection of what percentage of the order for which this choice applies foodlabelingtags docid\ ibvuqpk0mwpaa9dskeujy a list of foodlabelingtag enums that apply to this choice name docid\ ibvuqpk0mwpaa9dskeujy a human friendly name to be displayed for this choice posid docid\ ibvuqpk0mwpaa9dskeujy a client supplied id to easily match between systems selections docid\ ibvuqpk0mwpaa9dskeujy a collection of price selections to customize this item sortorder docid\ ibvuqpk0mwpaa9dskeujy an integer to describe where in the option this choice should be displayed example { "name" "parmigiano reggiano", "posid" "parmigiano reggiano choice", "selections" \[choiceselectioninput!]!, "description" "parmigiano reggiano cheese", "choicetypetags" \[], "foodlabelingtags" \["vegetarian"], "enablesubquantities" false } choiceselectioninput an object to describe the price increase for a choice depending on the item selection modifier field name description posid docid\ ibvuqpk0mwpaa9dskeujy a client supplied selection id to easily match between systems price docid\ ibvuqpk0mwpaa9dskeujy a price for this selection sortorder docid\ ibvuqpk0mwpaa9dskeujy an integer to describe where in the option this choice should be displayed example { "price" 1 75, "posid" "parmigiano reggiano choice 12 inch selection id", "sortorder" 1 }, { "price" 3 75, "posid" "parmigiano reggiano choice 16 inch selection id", "sortorder" 2 }, { "price" 5 75, "posid" "parmigiano reggiano choice 20 inch selection id", "sortorder" 3 } iteminput an item on the menu field name description caterernote docid\ ibvuqpk0mwpaa9dskeujy an internal note providing additional information from the caterer about this item channels docid\ ibvuqpk0mwpaa9dskeujy a list of ezcater ordering channel enums for which this item is available daybeforecutofftime docid\ ibvuqpk0mwpaa9dskeujy a hour enum indicating the day before cutoff time after which this item cannot be added to a next day order provide either leadtime or daybeforecutofftime description docid\ ibvuqpk0mwpaa9dskeujy a description providing information about this item for users description2 docid\ ibvuqpk0mwpaa9dskeujy an additional description providing more information about this item for users foodlabelingtags docid\ ibvuqpk0mwpaa9dskeujy a list of foodlabelingtag enums that apply to this item imageurl docid\ ibvuqpk0mwpaa9dskeujy a link to an image to display for the item please make sure that the referenced file has one of the following extensions gif , jpg , jpeg , png individualwrapstatus docid\ ibvuqpk0mwpaa9dskeujy an individualwrapstatus enum indicating whether this item is individually itemtypetags docid\ ibvuqpk0mwpaa9dskeujy a list of entitytypetag enums that apply to this item leadtime docid\ ibvuqpk0mwpaa9dskeujy a number in minutes indicating the minimum amount of time required to prepare this item provide either leadtime or daybeforecutofftime not both name docid\ ibvuqpk0mwpaa9dskeujy a human friendly name to be displayed for this item optionposids docid\ ibvuqpk0mwpaa9dskeujy a list of option posid 's to be included within this item posid docid\ ibvuqpk0mwpaa9dskeujy a client supplied item id to easily match between systems quantityoptions docid\ ibvuqpk0mwpaa9dskeujy a comma separated list of integers describing the quantities a customer can order some special codes are available >n will generate a list of numbers from n to 50 , then 55 95 in multiples of 5 xn will generate a list of numbers from 1 to 50 in multiples of n quantityunit docid\ ibvuqpk0mwpaa9dskeujy a quantityunit enum for a singular quantity of this item selectionprompt docid\ ibvuqpk0mwpaa9dskeujy an itemselectioninput type consisting of a collection of size and price selections to customize this item selections docid\ ibvuqpk0mwpaa9dskeujy an list of choices to customize an item usually used for size/price selection sizelabel docid\ ibvuqpk0mwpaa9dskeujy a size label for this item sortorder docid\ ibvuqpk0mwpaa9dskeujy a number to determine where in the category the item will be displayed taxcategory docid\ ibvuqpk0mwpaa9dskeujy a taxcategory enum that applies to this item vegetarianoption docid\ ibvuqpk0mwpaa9dskeujy an indicator to customers that they can expect some of the item selections will be vegetarian example { "name" "margherita pizza", "posid" "margherita pizza item id", "channels" \["marketplace"], "imageurl" "https //your domain com/menu item images/margherita pizza jpg", "selections" \[itemselectioninput!], "description" "thin crust margherita pizza", "taxcategory" "prepared food", "quantityunit" "pizza", "itemtypetags" \[], "optionposids" \[ "cheese addon options id" ], "foodlabelingtags" \["popular","vegetarian"], "individualwrapstatus" "never" } itemselectioninput an object to describe options for modifying an item selection field name description maxcalories docid\ ibvuqpk0mwpaa9dskeujy the maximum of a range to describe how many calories are in this selection mincalories docid\ ibvuqpk0mwpaa9dskeujy the minimum of a range to describe how many calories are in this selection posid docid\ ibvuqpk0mwpaa9dskeujy a client supplied selection id to easily match between systems price docid\ ibvuqpk0mwpaa9dskeujy a price for this selection serves docid\ ibvuqpk0mwpaa9dskeujy an integer to describe how many people the selection serves size docid\ ibvuqpk0mwpaa9dskeujy a human friendly string to describe the size of this selection sortorder docid\ ibvuqpk0mwpaa9dskeujy an integer to describe where in the list this selection should be displayed example { "price" 16 75, "posid" "12 inch pizza item selection id", "size" "12\\" pizza", "serves" 2, "mincalories" 512, "maxcalories" 1024, "sortorder" 1 }, { "price" 24 75, "posid" "16 inch pizza item selection id", "size" "16\\" pizza", "serves" 4, "mincalories" 512, "maxcalories" 1024, "sortorder" 1 }, { "price" 32 75, "posid" "20 inch pizza item selection id", "size" "20\\" pizza", "serves" 8, "mincalories" 512, "maxcalories" 1024, "sortorder" 1 } menuinput input object for creating a new menu field name description locationid docid\ ibvuqpk0mwpaa9dskeujy the ezcater caterer location uuid that this menu will be attached to caterer location uuid's can be retrieved using the docid\ laomlo pm8bz0wziz99hv api name docid\ ibvuqpk0mwpaa9dskeujy a human friendly name for the menu posid docid\ ibvuqpk0mwpaa9dskeujy a client supplied menu id to easily match between systems startdate docid\ ibvuqpk0mwpaa9dskeujy a date when the menu will become active enddate docid\ ibvuqpk0mwpaa9dskeujy a date when the menu will stop being active categories docid\ ibvuqpk0mwpaa9dskeujy a categoryinput type consisting of a collection of categories for the menu items docid\ ibvuqpk0mwpaa9dskeujy an iteminput type consisting of a collection of items available within categories options docid\ ibvuqpk0mwpaa9dskeujy an optioninput type consisting of a collection of options available within items choices docid\ ibvuqpk0mwpaa9dskeujy a choiceinput type consisting of a collection of choices available within options example { "name" "your menu name", "locationid" "ezcater caterer id", "posid" "your menu version id", "startdate" "2024 01 01", "enddate" "2024 04 01", "categories" \[categoryinput!]!, "items" \[iteminput!]!, "options" \[optioninput!], "choices" \[choiceinput!] } optioninput a choice to customize a menu item field name description catererlabel docid\ ibvuqpk0mwpaa9dskeujy a label supplied by the caterer for internal use choiceposids docid\ ibvuqpk0mwpaa9dskeujy a list of choice posid 's to be included within this option customerprompt docid\ ibvuqpk0mwpaa9dskeujy an alternative text to display to the customer maxchoiceselections docid\ ibvuqpk0mwpaa9dskeujy the maximum number of selections a customer may choose leave nil for unlimited minchoiceselections docid\ ibvuqpk0mwpaa9dskeujy the minimum number of selections a customer must choose name docid\ ibvuqpk0mwpaa9dskeujy a human friendly name to be displayed for this option posid docid\ ibvuqpk0mwpaa9dskeujy a client supplied option id to easily match between systems example { "name" "cheese addon", "posid" "cheese addon options id", "catererlabel" "cheese", "choiceposids" \[ "feta choice id", "parmigiano reggiano choice id", "parmesan choice id" ], "customerprompt" "add additional cheese?", "maxchoiceselections" 1, "minchoiceselections" 1 } enums channel ordering channels in which certain menu items are available ezcater provides multiple channels to present menu data the standard entry is marketplace however restaurant partners participating in the meal program it may be appropriate to use relish applied to the channels type as the field's return type enum name description marketplace determines whether a menu item is available on the marketplace relish determines whether a menu item is available on the meal program entitytypetag tags applied to either an item or a choice to further describe the menu entity applied to the itemtypetags and choicetypetags types as the field's return type enum name description dessert identifies a menu entity as a dessert drinks identifies a menu entity as a drink ice identifies a menu entity as ice individually packaged relish side identifies a menu entity as a individually packaged side when participating in the meal program channel this tag is only relevant for choicetypetags utensils identifies a menu entity as a utensil foodlabelingtag tags applied to either an item or a choice to classifying the menu entity applied to the foodlableingtags type as the field's return type enum name description award this identifies that the food item has received some form of recognition or award for its quality or taste gluten free this identifies food items that do not contain gluten, making them suitable for individuals with gluten intolerance or celiac disease halal this identifies that the food item is prepared following islamic dietary laws, making it permissible for consumption by individuals who follow halal dietary restrictions healthy this identifies that the food item is recognized for its health benefits, which could include being low in fat, sugar, or sodium, and rich in essential nutrients kosher this identifies that the food item conforms to the dietary laws of kashrut, which are applicable to individuals who follow jewish dietary guidelines popular this identifies that the food items that are frequently ordered and favored by customers, indicating their popularity spicy this identifies food items that are hot and spicy, catering to customers who prefer a bit of heat in their meals star this identifies food items that are highly recommended or signature dishes, often highlighted for their exceptional taste or quality vegan this identifies that the food item contains no animal products, making it suitable for vegan diets vegetarian this identifies that the food items that contain no meat, making them suitable for vegetarian diets, although they may still include animal products like dairy or eggs hour hours of the day applied to the daybeforecutofftime type as the field's return type enum name description eight am eight pm eleven am eleven pm five am five pm four am four pm nine am nine pm one am one pm seven am seven pm six am six pm ten am ten pm three am three pm twelve am twelve pm two am two pm individualwrapstatus describes whether food items are or could be individually wrapped applied to the individualwrapstatus type as the field's return type enum name description never this status indicates that the individual wrap option is never be available for the food item possible this status indicates that the individual wrap option is available for the food item but is optional wrap this status indicates that the individual wrap option will be used for the food item quantityunit describes the unit for a singular quantity of an item applied to the quantityunit type as the field's return type enum name description bar bottle bowl box buffet cake can carafe dozen foot full pan gallon half gallon half pan item kit liter package pan person pie piece pint pizza platter pound quart roll six pack skewer slider taco tray twelve pack two liter taxcategory categories used to determine how items should be taxed applied to the taxcategory type as the field's return type enum name description bakery items items that primarily include baked goods such as bread, pastries, and other bakery products cakes and pies desserts specifically categorized as cakes and pies candy items that include various types of confectionery and candy chips and snacks snack foods that primarily include chips and other similar snack items coffee tea milk beverages classified under coffee, tea, and milk dressings and condiments various types of dressings and condiments used to accompany meals exempt items that are exempt from sales tax under the given regulations ice cream frozen desserts categorized specifically as ice cream miscellaneous items that do not fit into other specific categories and are grouped as miscellaneous non soda drinks beverages that are not classified as soda, including juices, water, and other non carbonated drinks prepared food food items that are prepared and ready for consumption, often part of catering and meal services sandwiches items specifically identified as sandwiches soda carbonated soft drinks water bottled or packaged water scalars 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 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 uuid universally unique identifier as defined by rfc 4122