Unassigning a Courier
In the event that you previously had a courier assigned to a delivery but no longer do, you can use our courierUnassign mutation to let us know that no courier is currently assigned to the delivery.
Mutation
Mutation
mutation CourierUnassign($input: CourierUnassignInput!) {
courierUnassign(input: $input) {
clientMutationId
delivery {
id
}
userErrors {
... on DeliveryValidationError {
message
path
}
}
}
}
Variables
Variables
{
"input": {
"clientMutationId": "your-mutation-id",
"courier": {
"id": "your-courier-id",
"firstName": "Test",
"lastName": "Courier",
"phone": "+15555555555",
"vehicle": {
"make": "Your Vehicle Make",
"model": "Your Vehicle Model",
"color": "Your Vehicle Color"
}
},
"deliveryId": "ezcater-delivery-id"
}
}
Arguments
Argument Name | Description |
| The Input object for unassigning a courier. |
Return Type
Returns a CourierUnassignPayload.
Success Response
When the courierUnassign mutation succeeds you can expect the response payload to look like:
Response
{
"data": {
"courierUnassign": {
"clientMutationId": "your-mutation-id",
"delivery": {
"id": "8eb96ea0-2018-4f6a-9b00-75b169aaebd9"
},
"userErrors": []
}
}
}