Order Details

viewing order details after using docid\ ywds1a gxebjwkne8v90s to create subscription notifications for the evententity of order , you will begin to receive order notifications the payload for these notifications will include the uuid of the order which can be used to retrieves the details of the order information will only be available for orders you have been granted access to from within partner portal, this may be limited by location, depending on your brand's structure we recommend subscribing to all notification eventkey for the evententity of order to assist in keeping up to date with order information please see docid\ ywds1a gxebjwkne8v90s for more details query query query order( $orderid id! $types \[feeordiscounttype!] ) { order(id $orderid) { deliveryid uuid caterer { address { city deliveryinstructions name state statename street street2 street3 zip } live name storenumber uuid } caterercart { feesanddiscounts(types $types) { cost { currency subunits subunitsv2 } name } orderitems { customizations { customizationid customizationtypeid customizationtypename name poscustomizationid quantity } labelfor menuitemsizeid menuitemsizename name notetocaterer positemid quantity specialinstructions totalinsubunits { currency subunits subunitsv2 } uuid } tableware { specialinstructions tablewarechoices { choiceuuid isincluded itemcount name } } totals { caterertotaldue } } event { address { city deliveryinstructions name state statename street street2 street3 zip } catererhandofffoodtime contact { name phone } customerprovidedname headcount ordertype thirdpartydeliverypartner timezoneidentifier timezoneoffset timestamp } istaxexempt lifecycle { orderiscurrently } ordercustomer { firstname fullname lastname } ordernumber ordersourcetype taxableaddress { city deliveryinstructions name state statename street street2 street3 zip } totals { customertotaldue { currency subunits subunitsv2 } pointofsaleintegrationfee { currency subunits subunitsv2 } salestax { currency subunits subunitsv2 } salestaxremittance { currency subunits subunitsv2 } subtotal { currency subunits subunitsv2 } tip { currency subunits subunitsv2 } } } } variables variables { "orderid" "your ezcater order id", "types" \["adjustment","delivery fee","discount","misc fee"] } arguments argument name description orderid docid\ u2uigsyo0gfpxj 5tuif0 the ezcater order uuid that was provided in the order subscription notification payload types docid\ u2uigsyo0gfpxj 5tuif0 a list of feeordiscounttype enums used to filter fees and discounts on an order shouldusesearchaddress docid\ u2uigsyo0gfpxj 5tuif0 includes the address the customer searched for (relevant for takeout orders) perspective docid\ u2uigsyo0gfpxj 5tuif0 return type returns an docid\ u2uigsyo0gfpxj 5tuif0 success response when the order query succeeds you can expect the response payload to look like response { "data" { "order" { "deliveryid" "3593ce70 7227 4fd4 8a78 9591083d0674", "uuid" "your ezcater order id", "caterer" { "address" { "city" "boston", "deliveryinstructions" "ask for jane at front desk", "name" "", "state" "ma", "statename" "massachusetts", "street" "12345 restaurant avenue", "street2" null, "street3" null, "zip" "54321" }, "live" true, "name" "my caterer name", "storenumber" "00001", "uuid" "ezcater caterer id" }, "caterercart" { "feesanddiscounts" \[ { "cost" { "currency" "usd", "subunits" 2999, "subunitsv2" "2999" }, "name" "delivery fee" }, { "cost" { "currency" "usd", "subunits" 1199, "subunitsv2" " 1199" }, "name" "preferred caterer program" }, { "cost" { "currency" "usd", "subunits" 1199, "subunitsv2" " 1199" }, "name" "rewards promo" } ], "orderitems" \[ { "customizations" \[ { "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 } ], "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" { "currency" "usd", "subunits" 16750, "subunitsv2" "16750" }, "uuid" "83ec5c82 fa68 437c 90d7 ad861a2c151b" }, { "customizations" \[ { "customizationid" "ezcater menu version customization brand name soda choice id", "customizationtypeid" "ezcater menu version customization type soda option id", "customizationtypename" "soda", "name" "select soda", "poscustomizationid" "brand name soda choice id", "quantity" 10 } ], "labelfor" null, "menuitemsizeid" "ezcater menu version size assorted sodas item selection id", "menuitemsizename" "2ltr soda", "name" "assorted sodas", "notetocaterer" "2ltr brand name sodas from fridge", "positemid" "assorted sodas item selection id", "quantity" 10, "specialinstructions" "please bring cold soda if possible", "totalinsubunits" { "currency" "usd", "subunits" 2750, "subunitsv2" "2750" }, "uuid" "c00e766f e733 476a 939c 9aba59b4e93c" } ], "tableware" { "specialinstructions" null, "tablewarechoices" \[ { "choiceuuid" "7acc72ed 2240 4b9f a903 f7873b94ba60", "isincluded" true, "itemcount" 10, "name" "napkins" }, { "choiceuuid" "e8cb95f8 c2de 412d a0de d01e1879db83", "isincluded" true, "itemcount" 10, "name" "plates" }, { "choiceuuid" "b73832f4 f8d8 4317 b93e 5788e926ab2c", "isincluded" true, "itemcount" 10, "name" "cups" } ] }, "totals" { "caterertotaldue" 171 02 } }, "event" { "address" { "city" "boston", "deliveryinstructions" "ask for jane at front desk", "name" "my office", "state" "ma", "statename" "massachusetts", "street" "2345 business boulevard", "street2" null, "street3" null, "zip" "23456" }, "catererhandofffoodtime" "2025 03 27t16 15 00z", "contact" { "name" "jane doe", "phone" "5555555555" }, "customerprovidedname" "team building event", "headcount" 10, "ordertype" "delivery", "thirdpartydeliverypartner" null, "timezoneidentifier" "america/new york", "timezoneoffset" " 04 00", "timestamp" "2025 03 27t16 30 00z" }, "istaxexempt" false, "lifecycle" { "orderiscurrently" "accepted" }, "ordercustomer" { "firstname" "jane", "fullname" "jane doe", "lastname" "doe" }, "ordernumber" "o1o1o1", "ordersourcetype" "marketplace", "taxableaddress" { "city" "boston", "deliveryinstructions" "ask for jane at front desk", "name" "", "state" "ma", "statename" "massachusetts", "street" "2345 business boulevard", "street2" null, "street3" null, "zip" "23456" }, "totals" { "customertotaldue" { "currency" "usd", "subunits" 23864, "subunitsv2" "23864" }, "pointofsaleintegrationfee" { "currency" "usd", "subunits" 0, "subunitsv2" "0" }, "salestax" { "currency" "usd", "subunits" 1365, "subunitsv2" "1365" }, "salestaxremittance" { "currency" "usd", "subunits" 0, "subunitsv2" "0" }, "subtotal" { "currency" "usd", "subunits" 19500, "subunitsv2" "19500" }, "tip" { "currency" "usd", "subunits" 0, "subunitsv2" "0" } } } } } failure response when the order query fails because you do not have permission to access the order associated with the uuid provided you can expect the response payload to look like response { "errors" \[ { "message" "you are not authorized to access this data", "path" \[ "order" ], "extensions" { "servicename" "management public", "code" "downstream service error", "exception" { "message" "you are not authorized to access this data", "locations" \[ { "line" 1, "column" 99 } ], "path" \[ "order" ], "type" "request", "statuscode" 403 } } } ], "data" { "order" null } }