Order Details
7 min
Viewing Order Details
After using Subscription Create 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 Subscription Create for more details.
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
{
"orderId": "your-ezcater-order-id",
"types": ["ADJUSTMENT","DELIVERY_FEE","DISCOUNT","MISC_FEE"]
}Arguments
Argument Name | Description |
|---|---|
orderId: ID! | The ezCater order UUID that was provided in the Order subscription notification payload. |
types: [FeeOrDiscountType!] | A list of FeeOrDiscountType enums used to filter fees and discounts on an order. |
shouldUseSearchAddress: Boolean | Includes the address the customer searched for (relevant for takeout orders) |
perspective: OrderTypePerspective | |
Return Type
Returns an Order.
Success Response
When the order query succeeds you can expect the response payload to look like:
{
"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:
{
"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
}
}