Menu Schema Reference

30 min

menu schema reference objects menucreatepayload return type of menucreate true 391,228 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type menucreationexception an exception that occurred when trying to create a menu true 384 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type 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 true 326 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 { "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 true 329 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 { "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 true 329 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 { "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 true 327 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 { "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 true 330 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 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 true 312 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 { "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 true 312 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 { "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 true 315 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 { "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 catering partners participating in relish it may be appropriate to use relish applied to the channels type as the field's return type true 309 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type 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 true 312 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 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 true 314 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 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 true 353 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type quantityunit describes the unit for a singular quantity of an item applied to the quantityunit type as the field's return type true 327 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 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 taxcategory categories used to determine how items should be taxed applied to the taxcategory type as the field's return type true 329 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 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