Reject assignment (Driver)

Driver rejects the pending assignment request.

Requirements:

Must be the pending driver for this order

Side Effects:

Clears pendingDriver from the order

Sends socket event "order:assignment-rejected" to coordinators

Order returns to available pool for reassignment

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Body Params application/json

Example

{
    "reason": "Too far from my location"
}

Responses

🟢200OK

application/json

Assignment rejected

Body

Example

{
    "status": "success",
    "message": "Assignment rejected",
    "data": {
        "order": {
            "_id": "string",
            "orderNumber": 0,
            "user": {
                "_id": "string",
                "name": "string",
                "phone": "string"
            },
            "vendor": {
                "_id": "string",
                "name": "string",
                "phone": "string",
                "location": {}
            },
            "assignedDriver": "string",
            "pendingDriver": "string",
            "items": [
                {
                    "item": {
                        "_id": "string",
                        "name": "string",
                        "description": "string",
                        "imagePath": "string",
                        "optionName": "string",
                        "category": {
                            "_id": "string",
                            "name": "string"
                        }
                    },
                    "optionId": "string",
                    "optionValue": "string",
                    "quantity": 0,
                    "unitPrice": 0,
                    "totalPrice": 0
                }
            ],
            "address": {
                "street": "string",
                "city": "string",
                "buildingNumber": "string",
                "floor": "string",
                "apartmentNumber": "string",
                "phone": "string"
            },
            "status": "pending",
            "total": 0,
            "subtotal": 0,
            "deliveryFee": 0,
            "discount": 0,
            "paymentMethod": "string",
            "isPickup": true,
            "notes": "string",
            "rejectionReason": "string",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z"
        }
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠404Not Found