Caterer List

7 min

viewing caterers this query will return a list of all of the caterers that your user has access to it may be useful to include the address information so that you can know which uuid corresponds to which location currently, this query does not have paging if your user has access to many locations, you may experience a large load time when running this query query query caterers($ids \[id!], $uuids \[id!]) { caterers(ids $ids, uuids $uuids) { address { city deliveryinstructions name state statename street street2 street3 zip } live name storenumber uuid } } query alternate query caterers { caterers { address { city deliveryinstructions name state statename street street2 street3 zip } live name storenumber uuid } } variables the ids and uuids arguments are only necessary to if you want to filter the results to specific caterer locations to return all caterers remove the arguments from the query or pass null variables uuids { "ids" null, "uuids" \["ezcater caterer 1 id", "ezcater caterer 2 id"] } variables null { "ids" null, "uuids" null } arguments argument name description ids caterer schema reference docid\ pl8pdcbb1ebl u3 fqodc the id for the caterer(s) for which you wish to view information uuids caterer schema reference docid\ pl8pdcbb1ebl u3 fqodc the uuid for the caterer(s) for which you wish to view information return type returns a caterer schema reference docid\ pl8pdcbb1ebl u3 fqodc successful responses when the caterers query succeeds you can expect the response payload to look like response { "data" { "caterers" \[ { "address" { "city" "boston", "deliveryinstructions" null, "name" "", "state" "ma", "statename" "massachusetts", "street" "12345 restaurant avenue", "street2" null, "street3" null, "zip" "54321" }, "live" true, "name" "my first caterer name", "storenumber" "0001", "uuid" "ezcater caterer 1 id" }, { "address" { "city" "boston", "deliveryinstructions" null, "name" "", "state" "ma", "statename" "massachusetts", "street" "54321 caterer street", "street2" null, "street3" null, "zip" "12345" }, "live" true, "name" "my second caterer name", "storenumber" "00002", "uuid" "ezcater caterer 1 id" } ] } } failure responses when the caterers query fails because you do not have permission to access the caterer location associated with the uuid provided you can expect the response payload to look like response { "data" { "caterers" \[] } }