Input Object Types | ezCater Restaurant Partner Help Center

For: Developers

AcceptDeliveryInput

This is an "Input object" type

Autogenerated input type of AcceptDelivery

{
  "clientMutationId": "String",
  "deliveryId": "ID",
  "padding": "Int"
}

Input Fields

Name	Required	Type	Description
`clientMutationId`	false	String	A unique identifier for the client performing the mutation.
`deliveryId`	true	ID	ID of the delivery
`padding`	false	Int	The time padding in minutes before the event time when the food will be picked up

AssignDriverInput

This is an "Input object" type

Autogenerated input type of AssignDriver

{
  "clientMutationId": "String",
  "allowMultipleDrivers": "Boolean",
  "deliveryId": "ID",
  "driverId": "ID",
  "maskedPhoneNumber": "Phone"
}

Input Fields

Name	Required	Type	Description
`clientMutationId`	false	String	A unique identifier for the client performing the mutation.
`allowMultipleDrivers`	false	Boolean	When true, the provided driverId will be added to the delivery's existing assigned drivers without removing any current assignments. When false or omitted, any pre-existing driver assignments for the delivery will be replaced by the provided driverId.
`deliveryId`	true	ID	ID of the delivery to be assigned to
`driverId`	true	ID	External ID of the driver being assigned
`maskedPhoneNumber`	false	Phone	Optional phone number that masks the driver's real phone number

CoordinateInput

This is an "Input object" type

Latitude and longitude coordinates

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

Input Fields

Name	Required	Type	Description
`latitude`	true	Float	Latitude as a float
`longitude`	true	Float	Longitude as a float

CreateDriverInput

This is an "Input object" type

Autogenerated input type of CreateDriver

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

Input Fields

Name	Required	Type	Description
`clientMutationId`	false	String	A unique identifier for the client performing the mutation.
`driver`	true	DriverInput	Input object for creating a driver

CreateDriverTrackingEventInput

This is an "Input object" type

Autogenerated input type of CreateDriverTrackingEvent

{
  "clientMutationId": "String",
  "coordinate": "CoordinateInput",
  "deliveryId": "ID",
  "driverId": "ID",
  "timestamp": "ISO8601DateTime"
}

Input Fields

Name	Required	Type	Description
`clientMutationId`	false	String	A unique identifier for the client performing the mutation.
`coordinate`	true	CoordinateInput	Latitude and longitude of the driver's location.
`deliveryId`	true	ID	ID of the delivery.
`driverId`	false	ID	ID of the driver that created the event. Accepts your externalId value or an ezCater driverId. PLEASE NOTE: This input is optional now, but it will become required after all API partners have updated their integrations. Until then the argument is only required if there's multiple drivers assigned to the delivery.
`timestamp`	true	ISO8601DateTime	Timestamp of event in ISO 8601 format. Provided value must be in the UTC timezone.

DriverAssignmentInput

This is an "Input object" type

The input fields for a delivery driver assignment

{
  "id": "ID",
  "maskedPhoneNumber": "Phone"
}

Input Fields

Name	Required	Type	Description
`id`	true	ID	ID of the driver being assigned. Accepts your externalId value or an ezCater driverId.
`maskedPhoneNumber`	false	Phone	An optional masked phone number for the driver. This number will be used for communication related to the delivery, protecting the driver's personal phone number.

DriverDeliveryEventCreateInput

This is an "Input object" type

Autogenerated input type of DriverDeliveryEventCreate

{
  "clientMutationId": "String",
  "coordinate": "CoordinateInput",
  "deliveryId": "ID",
  "driverId": "ID",
  "eventType": "DriverDeliveryEvent",
  "timestamp": "ISO8601DateTime"
}

Input Fields

Name	Required	Type	Description
`clientMutationId`	false	String	A unique identifier for the client performing the mutation.
`coordinate`	false	CoordinateInput	Latitude and longitude of the driver's location.
`deliveryId`	true	ID	ID of the delivery.
`driverId`	true	ID	ID of the driver that created the event. Accepts your externalId value or an ezCater driverId.
`eventType`	true	DriverDeliveryEvent	The event types expected to be passed by our delivery partners
`timestamp`	true	ISO8601DateTime	Timestamp of event in ISO 8601 format. Provided value must be in the UTC timezone.

DriverDropoffVerificationCreateInput

This is an "Input object" type

Autogenerated input type of DriverDropoffVerificationCreate

{
  "clientMutationId": "String",
  "deliveryId": "ID",
  "driverId": "ID",
  "proofOfDropoffImageUrl": "Uri"
}

Input Fields

Name	Required	Type	Description
`clientMutationId`	false	String	A unique identifier for the client performing the mutation.
`deliveryId`	true	ID	ID of the delivery.
`driverId`	true	ID	ID of the driver assigned to the delivery. Accepts your externalId value or an ezCater driverId.
`proofOfDropoffImageUrl`	true	Uri	URL of a photo showing the food items picked up by the driver. The image should clearly display all items included in the delivery to verify order completeness. The image URL must respond to an HTTP HEAD request with a 2xx status code and an image Content-Type header.

DriverInput

This is an "Input object" type

The input fields for creating or updating a delivery driver

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

Input Fields

Name	Required	Type	Description
`externalId`	false	ID	Any ID that you want to associate with the driver
`firstName`	false	String	Driver's first name
`lastName`	true	String	Driver's last name
`phone`	true	Phone	Driver's unique phone number
`vehicle`	false	VehicleInput	Input object for the driver's vehicle

DriverPickupVerificationCreateInput

This is an "Input object" type

Autogenerated input type of DriverPickupVerificationCreate

{
  "clientMutationId": "String",
  "deliveryId": "ID",
  "driverId": "ID",
  "numberOfPackages": "Int",
  "proofOfPickupImageUrl": "Uri"
}

Input Fields

Name	Required	Type	Description
`clientMutationId`	false	String	A unique identifier for the client performing the mutation.
`deliveryId`	true	ID	ID of the delivery.
`driverId`	true	ID	ID of the driver assigned to the delivery. Accepts your externalId value or an ezCater driverId.
`numberOfPackages`	false	Int	The number of packages the driver received during pickup.
`proofOfPickupImageUrl`	true	Uri	URL of a photo showing the food items picked up by the driver. The image should clearly display all items included in the pickup to verify order completeness. The image URL must respond to an HTTP HEAD request with a 2xx status code and an image Content-Type header

DriversAssignInput

This is an "Input object" type

Autogenerated input type of DriversAssign

{
  "clientMutationId": "String",
  "deliveryId": "ID",
  "drivers": "DriverAssignmentInput"
}

Input Fields

Name	Required	Type	Description
`clientMutationId`	false	String	A unique identifier for the client performing the mutation.
`deliveryId`	true	ID	ID of the delivery.
`drivers`	true	DriverAssignmentInput	A list of drivers to be assigned to the delivery. Any existing assigned drivers will be replaced with this list. When a driver is present in both the existing assignments and this list then they can be updated with any new attributes. Providing an empty array will unassign all existing drivers from the delivery.

RejectDeliveryInput

This is an "Input object" type

Autogenerated input type of RejectDelivery

{
  "clientMutationId": "String",
  "deliveryId": "ID"
}

Input Fields

Name	Required	Type	Description
`clientMutationId`	false	String	A unique identifier for the client performing the mutation.
`deliveryId`	true	ID	ID of the delivery that is getting rejected

UnassignDriverInput

This is an "Input object" type

Autogenerated input type of UnassignDriver

{
  "clientMutationId": "String",
  "deliveryId": "ID",
  "driverId": "ID"
}

Input Fields

Name	Required	Type	Description
`clientMutationId`	false	String	A unique identifier for the client performing the mutation.
`deliveryId`	true	ID	ID of the delivery to unassign from
`driverId`	true	ID	ID of the driver to unassign. Accepts your externalId value or an ezCater driverId.

UpdateDriverInput

This is an "Input object" type

Autogenerated input type of UpdateDriver

{
  "clientMutationId": "String",
  "driver": "DriverInput",
  "driverId": "ID"
}

Input Fields

Name	Required	Type	Description
`clientMutationId`	false	String	A unique identifier for the client performing the mutation.
`driver`	true	DriverInput	Input object for updating a driver
`driverId`	true	ID	ID of the driver to update. Accepts your externalId value or an ezCater driverId.

VehicleInput

This is an "Input object" type

The input fields for specifying a delivery driver's vehicle

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

Input Fields

Name	Required	Type	Description
`color`	true	String	Color of the vehicle
`make`	true	String	Make of the vehicle
`model`	false	String	Model of the vehicle