Delivery User

File Name : deliveryuser.js File Path : /server/routes/deliveryuser.js This route contains various routes handling Delivery User's CRUD operations. For Example: Getting a particular delivery user using its _id, Creating a new delivery user, Updating Image for the delivery user, Getting list of all delivery users, Checking for present delivery user with same phone number, Removing a particular delivery user, Removing all delivery users, Setting availability of delivery user, Setting trip status of the delivery user, Updating information of the delivery user.

Get

GET /api/deliveryUser/:Id

Path Parameters

Name	Type	Description
id	string	Delivery User ID

200

{
    success: true,
    message: "Delivery User found",
    data: { deliveryUser: req.user }
}

List

GET /api/deliveryUser/list

Query Parameters

Name	Type	Description
Skip	number	Number of users to skip from starting
Limit	number	Number of users to list

200

users 

or

{
        success: false,
        message: "error in listing delivery user"
}

Create

POST /api/deliveryUser/create

Request Body

Name	Type	Description
vehicleVerificationImage	string	Image of vehicle's documents
vehicleDetails	object	Vehicle Details
bankDetails	object	Bank Details
fullName	string	Full Name
dob	string	Date of Birth
gender	string	Gender
firstName	string	First Name
lastName	string	Last Name
address	string	Address
deviceInfo	object	Delivery User's Device Information
gpsLocation	array	GPS location of delivery user
savedAddresses	array	Addresses saved by delivery user
isLoggedIn	boolean	To check Delivery User is logged in or not
phoneNumber	number	Phone Number
email	string	Email
verificationDetails	object	Verification details of delivery guy
profileImage	string	Profile Image of delivery user
verificationImage	string	Image of documents for verification

200

{
        success: true,
        message: "Delivery user created",
        data: { jwtAccessToken: `JWT ${token}`, user }
}

or

{
        success: false,
        message: "error in saving delivery user"
}

Check

POST /api/deliveryUser/check

To check any user exists with same phone number or not.

Request Body

Name	Type	Description
phoneNumber	string	Phone Number

200

{
          success: true,
          message: "Delivery user found",
          data: { user }
}

or

{
          success: false,
          message: "Delivery user not found",
          data: { user }
}

Update Imgae

PUT /api/deliveryUser/updateImage

Request Body

Name	Type	Description
imageData	string	Image Data

200

{
            success: true,
            message: "Image updated",
            data: { url: results.secure_url }
}

or

{
            success: false,
            message: "Image not updated"
}

Change Availability

PUT /api/deliveryUser/setAvailable

Headers

Name	Type	Description
jwtAccessToken	string	Authorization

Request Body

Name	Type	Description
set	boolean	Value to set for availability

200

Change Trip Status

PUT /api/deliveryUser/setTripStatus

Headers

Name	Type	Description
jwtAccessToken	string	Authorization

Request Body

Name	Type	Description
set	string	Value to set for tripStatus

200

Update

PUT /api/deliveryUser/update

Headers

Name	Type	Description
jwtAccessToken	string	Authorization

Request Body

Name	Type	Description
verificationDetails	object
vehicleDetails	object
fullName	string
dob	string
gender	string
address	string
isLoggedIn	boolean
gpsLocation	array
savedAddresses	string
email	string
profileImage	string
verificationImage	string
vehicleType	string
vehicleNumber	number
bankDetails	object	Bank Details

200

{
        success: true,
        message: "Delivery user updated",
        data: savedUser
}

or

{
        success: false,
        message: "error in updating delivery user"
}

Remove

DELETE /api/deliveryUser/remove/:id

Path Parameters

Name	Type	Description
id	string	Delivery User Id

200

deleted_user

or

{
        success: false,
        message: "error in removing user"
}

Remove All

DELETE /api/deliveryUser/removeAll

200

deleted_user_count

or

{
        success: false,
        message: "error in removing all delivery user"
}