Delivery
Retrieve a delivery by its unique id
Request Arguments
Name | Required | Type | Description |
| true | ID | ID of the delivery |
Response Type
Type | Null |
Delivery | false |
Variables
{
"id": "ID",
}
Example
query delivery($id: ID!) {
delivery(id: $id) {
cancelled
catererPickupVerification
deliverySetup
distance
driverAskFor
drivers
dropoffAddress
dropoffContacts
eventAt
id
order
pickupAddress
pickupInstructions
priority
requestedPickupAt
status
timeZoneIdentifier
}
}
Example response
{
"data": {
"delivery": {
"cancelled": "Boolean",
"catererPickupVerification": {
"readyForPickupImageUrl": "Uri"
},
"deliverySetup": "DeliverySetup",
"distance": "String",
"driverAskFor": "String",
"drivers": [
{
"externalId": "ID",
"firstName": "String",
"id": "ID",
"lastName": "String",
"phone": "Phone",
"vehicle": "Vehicle"
}
],
"dropoffAddress": {
"city": "String",
"coordinate": "Coordinate",
"id": "ID",
"instructions": "Instructions",
"locationName": "String",
"phone": "Phone",
"postalCode": "String",
"state": "String",
"street1": "String",
"street2": "String",
"street3": "String"
},
"dropoffContacts": [
{
"name": "String",
"phone": "String",
"phoneExtension": "String"
}
],
"eventAt": "ISO8601DateTime",
"id": "ID",
"order": {
"forRelish": "Boolean",
"itemCount": "Int",
"orderItems": "OrderItem",
"orderNumber": "String",
"subtotal": "Float",
"tip": "Float"
},
"pickupAddress": {
"city": "String",
"coordinate": "Coordinate",
"id": "ID",
"instructions": "Instructions",
"locationName": "String",
"phone": "Phone",
"postalCode": "String",
"state": "String",
"street1": "String",
"street2": "String",
"street3": "String"
},
"pickupInstructions": "String",
"priority": "DeliveryPriority",
"requestedPickupAt": "ISO8601DateTime",
"status": "DeliveryStatus",
"timeZoneIdentifier": "String"
}
}
}Driver
Retrieve information for a specific driver.
Request Arguments
Name | Required | Type | Description |
| true | ID | External ID of the driver |
Response Type
Type | Null |
Driver | false |
Variables
{
"id": "ID",
}
Example
query driver($id: ID!) {
driver(id: $id) {
externalId
firstName
id
lastName
phone
vehicle
}
}
Example response
{
"data": {
"driver": {
"externalId": "ID",
"firstName": "String",
"id": "ID",
"lastName": "String",
"phone": "Phone",
"vehicle": {
"color": "String",
"make": "String",
"model": "String"
}
}
}
}