Object Types | ezCater Restaurant Partner Help Center

For: Developers

AcceptDeliveryPayload

This is an "Object" type

Autogenerated return type of AcceptDelivery

{
  "clientMutationId": "String",
  "delivery": "Delivery"
}

Fields

Name	Null	Type	Description
`clientMutationId`	true	String	A unique identifier for the client performing the mutation.
`delivery`	true	Delivery	Delivery that was accepted

Address

This is an "Object" type

Delivery address object

{
  "city": "String",
  "coordinate": "Coordinate",
  "id": "ID",
  "instructions": "Instructions",
  "locationName": "String",
  "phone": "Phone",
  "postalCode": "String",
  "state": "String",
  "street1": "String",
  "street2": "String",
  "street3": "String"
}

Fields

Name	Null	Type	Description
`city`	false	String	City of the address
`coordinate`	false	Coordinate	Latitude and longitude of the address
`id`	false	ID	UUID of the address
`instructions`	true	Instructions	Delivery instructions for this address
`locationName`	true	String	Short name for the address ie. ezCater Office
`phone`	false	Phone	The contact's phone number
`postalCode`	false	String	Postal code of the address
`state`	false	String	Two-letter state abbreviation
`street1`	false	String	Street1 of the address
`street2`	true	String	Optional street2 of the address
`street3`	true	String	Optional extended address

AssignDriverPayload

This is an "Object" type

Autogenerated return type of AssignDriver

{
  "clientMutationId": "String",
  "delivery": "Delivery"
}

Fields

Name	Null	Type	Description
`clientMutationId`	true	String	A unique identifier for the client performing the mutation.
`delivery`	true	Delivery	Delivery that the driver was assigned to

CatererPickupVerification

This is an "Object" type

Verification from the caterer on the food that was prepared for a delivery before being pickup by the driver

{
  "readyForPickupImageUrl": "Uri"
}

Fields

Name	Null	Type	Description
`readyForPickupImageUrl`	false	Uri	URL of a photo showing the food items prepared by the caterer.

Coordinate

This is an "Object" type

A latitude/longitude coordinate

{
  "latitude": "Float",
  "longitude": "Float"
}

Fields

Name	Null	Type	Description
`latitude`	false	Float	Latitude as a float
`longitude`	false	Float	Longitude as a float

CreateDriverPayload

This is an "Object" type

Autogenerated return type of CreateDriver

{
  "clientMutationId": "String",
  "driver": "Driver"
}

Fields

Name	Null	Type	Description
`clientMutationId`	true	String	A unique identifier for the client performing the mutation.
`driver`	true	Driver	Driver that was just created

CreateDriverTrackingEventPayload

This is an "Object" type

Autogenerated return type of CreateDriverTrackingEvent

{
  "clientMutationId": "String",
  "success": "Boolean"
}

Fields

Name	Null	Type	Description
`clientMutationId`	true	String	A unique identifier for the client performing the mutation.
`success`	false	Boolean	Returns whether or not the event was consumed

Delivery

This is an "Object" type

Represents an ezCater delivery

{
  "cancelled": "Boolean",
  "catererPickupVerification": "CatererPickupVerification",
  "distance": "String",
  "driverAskFor": "String",
  "drivers": "Driver",
  "dropoffAddress": "Address",
  "dropoffContacts": "DropoffContact",
  "eventAt": "ISO8601DateTime",
  "id": "ID",
  "order": "Order",
  "pickupAddress": "Address",
  "pickupInstructions": "String",
  "priority": "DeliveryPriority",
  "requestedPickupAt": "ISO8601DateTime",
  "status": "DeliveryStatus",
  "timeZoneIdentifier": "String"
}

Fields

Name	Null	Type	Description
`cancelled`	false	Boolean	Boolean if the delivery has been cancelled
`catererPickupVerification`	true	CatererPickupVerification	Verification from the caterer on the food that was prepared for this delivery before being pickup by the driver.
`distance`	false	String	Distance in miles between addresses ie. '5.75 miles' or 'not calculated'
`driverAskFor`	true	String
`drivers`	false	Driver	Drivers assigned to the delivery
`dropoffAddress`	false	Address	Address to drop off the delivery at
`dropoffContacts`	true	DropoffContact	The drop-off point(s) of contact for the delivery, ordered by position of recommended contact details.
`eventAt`	false	ISO8601DateTime	Timestamp of the event in iso8601 format
`id`	false	ID	UUID of the delivery
`order`	false	Order	Order object of the delivery
`pickupAddress`	false	Address	Address to pick up the delivery from
`pickupInstructions`	true	String	Pickup instructions for delivery drivers, provided by the caterer.
`priority`	false	DeliveryPriority	The priority level of the delivery.
`requestedPickupAt`	true	ISO8601DateTime	Timestamp of when ezCater requests the delivery be picked up in ISO 8601 format.
`status`	false	DeliveryStatus	State of the delivery
`timeZoneIdentifier`	false	String	Time zone of the eventAt timestamp

Driver

This is an "Object" type

Represents a delivery driver

{
  "externalId": "ID",
  "firstName": "String",
  "id": "ID",
  "lastName": "String",
  "phone": "Phone",
  "vehicle": "Vehicle"
}

Fields

Name	Null	Type	Description
`externalId`	true	ID	An ID that you have associated with the driver
`firstName`	true	String	Driver's first name
`id`	false	ID	UUID of the driver
`lastName`	true	String	Driver's last name
`phone`	false	Phone	Driver's unique phone number
`vehicle`	true	Vehicle	Object for the driver's vehicle

DriverDeliveryEventCreatePayload

This is an "Object" type

Autogenerated return type of DriverDeliveryEventCreate

{
  "clientMutationId": "String",
  "delivery": "Delivery",
  "errors": "String"
}

Fields

Name	Null	Type	Description
`clientMutationId`	true	String	A unique identifier for the client performing the mutation.
`delivery`	true	Delivery	Delivery that the event was created for
`errors`	true	String	Returns an array containing error messages if any exist

DriverDropoffVerificationCreatePayload

This is an "Object" type

Autogenerated return type of DriverDropoffVerificationCreate

{
  "clientMutationId": "String",
  "errors": "String",
  "success": "Boolean"
}

Fields

Name	Null	Type	Description
`clientMutationId`	true	String	A unique identifier for the client performing the mutation.
`errors`	false	String	Returns an array containing error messages if any exist
`success`	false	Boolean	Returns whether or not the request was successful

DriverPickupVerificationCreatePayload

This is an "Object" type

Autogenerated return type of DriverPickupVerificationCreate

{
  "clientMutationId": "String",
  "errors": "String",
  "success": "Boolean"
}

Fields

Name	Null	Type	Description
`clientMutationId`	true	String	A unique identifier for the client performing the mutation.
`errors`	false	String	Returns an array containing error messages if any exist
`success`	false	Boolean	Returns whether or not the request was successful

DriversAssignPayload

This is an "Object" type

Autogenerated return type of DriversAssign

{
  "clientMutationId": "String",
  "delivery": "Delivery"
}

Fields

Name	Null	Type	Description
`clientMutationId`	true	String	A unique identifier for the client performing the mutation.
`delivery`	true	Delivery	The delivery that has been updated with the new driver assignments.

DropoffContact

This is an "Object" type

{
  "name": "String",
  "phone": "String",
  "phoneExtenstion": "String"
}

Fields

Name	Null	Type	Description
`name`	true	String	The name the driver should ask for at the drop-off location.
`phone`	true	String	The contact's phone number. Formatted using E.164 Standard. For example +16175551236
`phoneExtension`	true	String	The contact's phone extension.

Instructions

This is an "Object" type

Additional instructional information for the address

{
  "text": "String"
}

Fields

Name	Null	Type	Description
`text`	true	String

Order

This is an "Object" type

Represents the delivery specific ezCater order information

{
  "forRelish": "Boolean",
  "itemCount": "Int",
  "orderItems": "OrderItem",
  "orderNumber": "String",
  "subtotal": "Float",
  "tip": "Float"
}

Fields

Name	Null	Type	Description
`forRelish`	false	Boolean	Indicates whether or not this is a Meal Program order
`itemCount`	false	Int	The number of items in the order
`orderItems`	false	OrderItem	List of items with name/count on the order
`orderNumber`	false	String	The ezCater order number ie. #ABC-123
`subtotal`	false	Float	The subtotal value of the order in dollars
`tip`	false	Float	The tip value in dollars

OrderItem

This is an "Object" type

Individual selections and quantities from the menu a customer purchased

{
  "name": "String",
  "quantity": "Int"
}

Fields

Name	Null	Type	Description
`name`	false	String	Name for this item in the cart
`quantity`	false	Int	Quantity for this item in the cart

RejectDeliveryPayload

This is an "Object" type

Autogenerated return type of RejectDelivery

{
  "clientMutationId": "String",
  "delivery": "Delivery"
}

Fields

Name	Null	Type	Description
`clientMutationId`	true	String	A unique identifier for the client performing the mutation.
`delivery`	true	Delivery	Delivery that was just rejected

UnassignDriverPayload

This is an "Object" type

Autogenerated return type of UnassignDriver

{
  "clientMutationId": "String",
  "delivery": "Delivery"
}

Fields

Name	Null	Type	Description
`clientMutationId`	true	String	A unique identifier for the client performing the mutation.
`delivery`	true	Delivery	Delivery that the driver was unassigned from

UpdateDriverPayload

This is an "Object" type

Autogenerated return type of UpdateDriver

{
  "clientMutationId": "String",
  "driver": "Driver"
}

Fields

Name	Null	Type	Description
`clientMutationId`	true	String	A unique identifier for the client performing the mutation.
`driver`	true	Driver	Driver that was updated

Vehicle

This is an "Object" type

Details for vehicles that drivers use

{
  "color": "String",
  "make": "String",
  "model": "String"
}

Fields

Name	Null	Type	Description
`color`	false	String	Color of the driver's vehicle
`make`	false	String	Make of the driver's vehicle
`model`	true	String	Model of the driver's vehicle