Menu Creation Request

viewing menu creation request status the menucreationrequest query provides detailed information about a specific menu creation request, including the creation status, warning message and error messages to explain why a menu was not successfully created to use the query a valid menucreationrequestid is required this uuid is returned with the menu create docid\ igacztgmsnoyf0fe3zage mutation as well as within the payload of menucreationrequest subscription notifications, which are sent after a menu creation request is completed processing since menu creation is an asynchronous process we recommend subscribing to menu notifications docid\ gjaiaywoubugvfi8lfy6e to be informed when the process is complete instead of continuously retrying the query query query query menucreationrequest($menucreationrequestid uuid!) { menucreationrequest(id $menucreationrequestid) { errors { details message } menuuuid outcome status warnings { details message } } } variables variables { "menucreationrequestid" "your ezcater menu creation request id" } arguments argument name description id menu schema reference docid\ ibvuqpk0mwpaa9dskeujy the menucreationrequestid that was returned by the menucreate mutation or received from a menu creation request notification return type returns a menu schema reference docid\ ibvuqpk0mwpaa9dskeujy success responses when the menucreationrequest query succeeds you can expect the response payload to look in one of two different ways if the menu was created with the outcome of success , the warnings and errors field values will empty if the menu was created with the outcome of success with warnings , the warnings will be provided and the the errors field value will empty response success { "data" { "menucreationrequest" { "errors" \[], "menuuuid" "ezcater menu version id", "outcome" "success", "status" "complete", "warnings" \[] } } } response success with warnings { "data" { "menucreationrequest" { "errors" \[], "menuuuid" "your ezcater menu version id", "outcome" "success with warnings", "status" "completed", "warnings" \[ { "details" {}, "message" "item with pos id assorted sodas item selection id has a price of $0 00 it will not be displayed " } ] } } } failure responses not authenticated when an the user is unable to be authenticated response { "errors" \[ { "message" "not authenticated ", "extensions" { "code" "err unauthenticated" } } ] } invaild menucreationrequestid when an invalid menucreationrequestid is provided, no menucreationrequest data is returned in the response payload response { "data" { "menucreationrequest" null } } internal error when an internal error occurs, we are unable to provide additional details response { "data" { "menucreationrequest" { "errors" \[ { "details" {}, "message" "internal error" } ], "menuuuid" null, "outcome" "failure", "status" "completed", "warnings" \[] } } } referenced entity is not defined when a menu entity references a child menu entity, but it is not properly defined you can expect an outcome of failure and the response payload to include a message with details response { "data" { "menucreationrequest" { "errors" \[ { "details" { "source" "categories", "source name" "drinks", "source pos id" "drinks category id", "reference type" "items", "referenced pos id" "drinks item id" }, "message" "referenced entity is not defined" } ], "menuuuid" null, "outcome" "failure", "status" "completed", "warnings" \[] } } } number of choice selections when the minimum number of choice selections is greater than the number of available choices you can expect an outcome of failure and the response payload to include a message with details response min choice selections { "data" { "menucreationrequest" { "errors" \[ { "details" { "minchoices" 10, "entity name" "cheese addon", "entity pos id" "cheese addon options id", "choices present" 7 }, "message" "minchoiceselections must be less than or equal to count of choices"" } ], "menuuuid" null, "outcome" "failure", "status" "completed", "warnings" \[] } } } response max choice selections { "data" { "menucreationrequest" { "errors" \[ { "details" { "maxchoices" 1, "minchoices" 2, "entity name" "cheese addon", "entity pos id" "cheese addon options id" }, "message" "maxchoiceselections must be greater than or equal to minchoiceselections" } ], "menuuuid" null, "outcome" "failure", "status" "completed", "warnings" \[] } } } invalid images when there is a problem finding the item image you can expect the response payload to include a message with details response { "data" { "menucreationrequest" { "errors" \[ { "details" { "image url" "https //your domain com/menu item images/margherita pizza jpg", "item pos id" "margherita pizza item id" }, "message" "problem with item image could not find image" } ], "menuuuid" "ezcater menu id", "outcome" null, "status" "completed", "warnings" \[] } } }