Dellyman API

We are a travels and transport logistics technology provider, aggregating logistics companies and their assets into a single platform where customers and logistics companies can transact business. Our main purpose is to solve the problems of under-capacity and non-availability of logistics assets, security, timeliness and efficiency of last mile deliveries.

We've designed the Dellyman API such that consumption for the team will as easy as possible.

1. Login Api:

This is an API for Customer Login

Method: POST

Demo URL:

  https://dev.dellyman.com/api/v2.0/Login

Live URL:

  https://dellyman.com/api/v2.0/Login
Attribute Type Required Description
Email string Mandatory Registered email
Password string Mandatory Password

Sample Request

                                    { 
                                        "Email": "[email protected]", 
                                        "Password": "123456"
                                    } 
                                

Sample Response


                                    { 
                                        "ResponseCode": 100, 
                                        "ResponseMessage": "You are logged in sucessfully", 
                                        "CustomerID": 2, 
                                        "Email": "[email protected]", 
                                        "Name": "Dellybot", 
                                        "PhoneNumber": "1234567890", 
                                        "IsActive": 1, 
                                        "Currency": "N", 
                                        "CustomerAuth": "0MV8zed5THoVXPo1Y1M3Ucg0agLUFLf5"
                                    } 
                                

2. GetQuotes API

This api is used to get available companies details for booking your order.

Method: Post

Demo URL:

  https://dev.dellyman.com/api/v2.0/GetQuotes

Live URL:

  https://dellyman.com/api/v2.0/GeQuotes
Attribute Type Required Description
CustomerID Integer Mandatory Customer id
CustomerAuth String Mandatory Customer auth token you got while login
PaymentMode String Mandatory It must be pickup or delivery
VehicleID Integer Mandatory select vehicle id you need
PickupRequestedTime String Mandatory Give the Preferred Time Slot For pickup
PickupRequestedDate String Mandatory Give the Preferred Date Slot For Pickup
PickupAddress String Mandatory Select The Proper Address Detail For the Pickup
DeliveryAddress String Mandatory Select The Proper Address Detail For the delivery
ProductAmount String Mandatory Enter product amount
PackageWeight String Mandatory package weight
IsProductOrder Integer Mandatory
IsProductInsurance Integer Mandatory Does your product have insurance?
InsuranceAmount Integer Mandatory Insurance Amount
IsInstantDelivery Integer Mandatory If you need an instant delivery

Sample Request

                                    { 
                                        "CustomerID": 2, 
                                        "CustomerAuth": "0MV8zed5THoVXPo1Y1M3Ucg0agLUFLf5", 
                                        "PaymentMode": "pickup", 
                                        "VehicleID": 1, 
                                        "PickupRequestedTime": "06 AM to 09 PM", 
                                        "PickupRequestedDate": "07/04/2021", 
                                        "PickupAddress": "1 Allen Avenue, Ikeja, Nigeria", 
                                        "DeliveryAddress": [ 
                                        "100 Allen Avenue, Ikeja, Nigeria"
                                        ], 
                                        "ProductAmount": [], 
                                        "PackageWeight": [], 
                                        "IsProductOrder": 0, 
                                        "IsProductInsurance": 0, 
                                        "InsuranceAmount": 0, 
                                        "IsInstantDelivery": 0
                                    } 
                                

Sample Response

                                    { 
                                        "ResponseCode": 100, 
                                        "ResponseMessage": "Success", 
                                        "Companies": [ 
                                        { 
                                        "CompanyID": 762, 
                                        "Name": "Dellyman", 
                                        "TotalPrice": 2000, 
                                        "OriginalPrice": 2000, 
                                        "SavedPrice": 0, 
                                        "PayablePrice": 2000, 
                                        "DeductablePrice": 0, 
                                        "AvgRating": 0, 
                                        "NumberOfOrders": 0, 
                                        "NumberOfRating": 0
                                        } 
                                        ], 
                                        "RejectedCompanies": {}, 
                                        "Products": {}, 
                                        "Distance": 2
                                    } 
                                

3.Vehicle API:

This is an API for get vehicle list.

Method: Get

Demo URL:

  https://dev.dellyman.com/api/v2.0/Vehicles

Live URL:

  https://dellyman.com/api/v2.0/Vehicles

Sample Response

                                    [ 
                                        { 
                                        "VehicleID": "1", 
                                        "Name": "Bike"
                                        }, 
                                        { 
                                        "VehicleID": "2", 
                                        "Name": "Tricycle"
                                        }, 
                                        { 
                                        "VehicleID": "3", 
                                        "Name": "Mini Van"
                                        }, 
                                        { 
                                        "VehicleID": "4", 
                                        "Name": "Vans/Buses"
                                        }, 
                                        { 
                                        "VehicleID": "5", 
                                        "Name": "Cars"
                                        } 
                                    ] 

                                

4.Logout API:

This is an API for customer logout.

Method: Post

Demo URL:

  https://dev.dellyman.com/api/v2.0/Logout

Live URL:

  https://dellyman.com/api/v2.0/Logout
Attribute Type Required Description
CustomerID Integer Mandatory CustomerID
CustomerAuth String Mandatory Customer auth token you got while login

Sample Request

                                    { 
                                        "CustomerID": 2, 
                                        "CustomerAuth":"0MV8zed5THoVXPo1Y1M3Ucg0agLUFLf5"
                                    } 
                                

Sample Response

                                    { 
                                        "ResponseCode": 100, 
                                        "ResponseMessage": "Customer logged out sucessfully."
                                    }  
                                

5.BookOrder API:

This is an API to book your order towards the company you selected.

Method: Post

Demo URL:

  https://dev.dellyman.com/api/v2.0/BookOrder

Live URL:

  https://dellyman.com/api/v2.0/BookOrder
Attribute Type Required Description
CustomerID Integer Mandatory Customer id
CustomerAuth String Mandatory Customer auth token you got while login
CompanyID Integer Mandatory Company ID
PaymentMode String Mandatory It must be pickup or delivery
Vehicle Integer Mandatory Vehicle id you selected
PickUpContactName String Mandatory Give The Pickup Contact Name
PickUpContactNumber String Mandatory Give The Appropriate Pickup Contact Number
PickUpGooglePlaceAddress String Mandatory Select the proper Address Detail For the Pickup
PickUpLandmark String Optional If you want to give landmark
IsInstantDelivery integer Mandatory If yes 1 for instant delivery
PickUpRequestedDate String Optional If you need any preferd date
PickUpRequestedTime String Optional If you need preferred time
DeliveryRequestedTime String Optional Your preferred delivery time
Packages Array Mandatory Give package information inside this
PackageDescription String Mandatory Package description in detail
DeliveryContactName String Mandatory Give The Appropriate delivery Contact Name
DeliveryContactNumber String Mandatory Give The Appropriate delivery Contact Number
DeliveryGooglePlaceAddress String Mandatory Select The Proper Address Detail For the delivery
DeliveryLandmark String Optional Landmark near your location

Sample Request

                                    { 
                                        "CustomerID": 2, 
                                        "CustomerAuth": "dfSVhQ8jQh0trncHkdELvwHgskI1Rj0w", 
                                        "CompanyID": 762, 
                                        "PaymentMode": "pickup", 
                                        "Vehicle": "Bike", 
                                        "PickUpContactName": "Administrator", 
                                        "PickUpContactNumber": "07068937300", 
                                        "PickUpGooglePlaceAddress": "3 Allen Avenue Lagos Lagos", 
                                        "PickUpLandmark": " ", 
                                        "IsInstantDelivery": 1, 
                                        "PickUpRequestedDate": "", 
                                        "PickUpRequestedTime": "", 
                                        "DeliveryRequestedTime": "", 
                                        "Packages": [ 
                                            { 
                                                "PackageDescription": "Allen/OUT/00024", 
                                                "DeliveryContactName": "Babatope Ajepe", 
                                                "DeliveryContactNumber": "07055667789", 
                                                "DeliveryGooglePlaceAddress": "73 Allen Avenue Ikeja Lagos", 
                                                "DeliveryLandmark": ""
                                            } 
                                        ] 
                                    }
                                

Sample Response

                                    { 
                                        "ResponseCode": 100, 
                                        "ResponseMessage": "Success", 
                                        "OrderID": 50378, 
                                        "Reference": "ORD44914"
                                    } 
                                

6.GetOrder API:

This is an API to get the status of your order based on the order ID.

Method: Post

Demo URL:

  https://dev.dellyman.com/api/v2.0/GetOrder

Live URL:

  https://dellyman.com/api/v2.0/GetOrder
Attribute Type Required Description
CustomerID Integer Mandatory Customer id
CustomerAuth String Mandatory Customer auth token you got while login
OrderID Integer Mandatory Order ID you need to check status

Sample Request

                                    { 
                                        "CustomerID": 2, 
                                        "CustomerAuth":"dfSVhQ8jQh0trncHkdELvwHgskI1Rj0w", 
                                        "OrderID": 50378
                                    } 
                                

Sample Response

                                    { 
                                        "OrderID": 50378, 
                                        "OrderCode": "ORD44914", 
                                        "OrderStatus": "PENDING", 
                                        "OrderPrice": 2000, 
                                        "FixedDeliveryCharge": null, 
                                        "PayAt": "1", 
                                        "IsProductOrder": 0, 
                                        "BankCode": null, 
                                        "BankName": null, 
                                        "AccountNumber": null, 
                                        "OrderedAt": "2021-09-28 09:10:53", 
                                        "AssignedAt": null, 
                                        "PickedUpAt": null, 
                                        "DeliveredAt": null, 
                                        "CancelledAt": null, 
                                        "RejectedAt": null, 
                                        "Packages": [ 
                                            { 
                                                "PackageID": 51770, 
                                                "IsDelivered": 0, 
                                                "PackageDescription": "Allen/out/00024", 
                                                "PackageDistance": 2, 
                                                "PackageWeight": 0, 
                                                "ProductAmount": null, 
                                                "PickUpContactName": "Administrator", 
                                                "PickUpContactNumber": "07068937300", 
                                                "PickUpGooglePlaceAddress": "3 Allen Avenue Lagos Lagos", 
                                                "PickUpLandmark": " ", 
                                                "PickUpLatitude": 6.5996672, 
                                                "PickUpLongitude": 3.3535716, 
                                                "PickUpExpectedAt": "2021-09-28 09:10:00", 
                                                "DeliveryContactName": "Babatope Ajepe", 
                                                "DeliveryContactNumber": "07055667789", 
                                                "DeliveryGooglePlaceAddress": "73 Allen Avenue Ikeja Lagos", 
                                                "DeliveryLandmark": "", 
                                                "DeliveryLatitude": 6.6029869, 
                                                "DeliveryLongitude": 3.3509942, 
                                                "DeliveryExpectedAt": "2021-09-28 10:10:00", 
                                                "DeliveryCode": 71819
                                            } 
                                        ] 
                                    } 

                                

7.Fetch Order API:

This is an API for fetching list of order placed by a customer.

Method: Post

Demo URL:

  https://dev.dellyman.com/api/v2.0/FetchOrders

Live URL:

  https://dellyman.com/api/v2.0/FetchOrders
Attribute Type Required Description
CustomerID Integer Mandatory Customer id
CustomerAuth String Mandatory Customer auth token you got while login
Status String Mandatory Select any you want to filter
FilterFrom Date Optional Start date
FilterTo Date Optional End date

Sample Request

                                    { 
                                        "CustomerID": 2, 
                                        "CustomerAuth":"dfSVhQ8jQh0trncHkdELvwHgskI1Rj0w", 
                                        "Status": "PENDING,ASSIGNED,INTRANSIT,COMPLETED,CANCELLED", 
                                        "FilterFrom": null, 
                                        "FilterTo": null
                                    } 
                                

Sample Response

                                    { 
                                        "ResponseCode": 100, 
                                        "ResponseMessage": "Success", 
                                        "Orders": { 
                                            "Pending": [ 
                                                { 
                                                    "OrderID": 50378, 
                                                    "OrderCode": "ORD44914", 
                                                    "OrderStatus": "PENDING", 
                                                    "CreatedThrough": "api", 
                                                    "OrderPrice": 2000, 
                                                    "FixedDeliveryCharge": null, 
                                                    "PayAt": 1, 
                                                    "IsPaid": null, 
                                                    "IsProductOrder": 0, 
                                                    "BankCode": null, 
                                                    "BankName": null, 
                                                    "AccountNumber": null, 
                                                    "OrderedAt": "2021-09-28 09:10:53", 
                                                    "AssignedAt": null, 
                                                    "PickedUpAt": null, 
                                                    "DeliveredAt": null, 
                                                    "CancelledAt": null, 
                                                    "RejectedAt": null, 
                                                    "Packages": [ 
                                                        { 
                                                            "PackageID": 51770, 
                                                            "PackageDistance": 2, 
                                                            "PackageWeight": 0, 
                                                            "PackageDescription": "Allen/out/00024", 
                                                            "IsDelivered": 0, 
                                                            "ProductAmount": null, 
                                                            "PickUpContactName": "Administrator", 
                                                            "PickUpContactNumber": "07068937300", 
                                                            "PickUpGooglePlaceAddress": "3 Allen Avenue Lagos Lagos", 
                                                            "PickUpLandmark": " ", 
                                                            "PickUpLatitude": "6.5996672", 
                                                            "PickUpLongitude": "3.3535716", 
                                                            "PickUpDate": null, 
                                                            "DeliveryContactName": "Babatope Ajepe", 
                                                            "DeliveryContactNumber": "07055667789", 
                                                            "DeliveryGooglePlaceAddress": "73 Allen Avenue Ikeja Lagos", 
                                                            "DeliveryLandmark": "", 
                                                            "DeliveryLatitude": "6.6029869", 
                                                            "DeliveryLongitude": "3.3509942", 
                                                            "DeliveryDate": null, 
                                                            "DeliveryCode": "71819" 
                                                        } 
                                                    ] 
                                                } 
                                            ], 
                                            "Assigned": [], 
                                            "Intransit": [ 
                                                { 
                                                    "OrderID": 21008, 
                                                    "OrderCode": "ORD18611", 
                                                    "OrderStatus": "INTRANSIT", 
                                                    "CreatedThrough": "web", 
                                                    "OrderPrice": 500, 
                                                    "FixedDeliveryCharge": null, 
                                                    "PayAt": 1, 
                                                    "IsPaid": "1", 
                                                    "IsProductOrder": 1, 
                                                    "BankCode": "057", 
                                                    "BankName": "ZENITH BANK", 
                                                    "AccountNumber": "1016622972", 
                                                    "OrderedAt": "2020-10-30 07:42:31", 
                                                    "AssignedAt": "2020-10-30 08:15:58", 
                                                    "PickedUpAt": "2020-10-30 08:17:18", 
                                                    "DeliveredAt": null, 
                                                    "CancelledAt": null, 
                                                    "RejectedAt": null, 
                                                    "Packages": [ 
                                                        { 
                                                        "PackageID": 20819, 
                                                        "PackageDistance": 2.5, 
                                                        "PackageWeight": 0, 
                                                        "PackageDescription": "Sample", 
                                                        "IsDelivered": 0, 
                                                        "ProductAmount": 2000, 
                                                        "PickUpContactName": "A", 
                                                        "PickUpContactNumber": "09999999999", 
                                                        "PickUpGooglePlaceAddress": "1 Allen Avenue, Ikeja, Nigeria", 
                                                        "PickUpLandmark": "", 
                                                        "PickUpLatitude": "6.601838", 
                                                        "PickUpLongitude": "3.3514863", 
                                                        "PickUpDate": null, 
                                                        "DeliveryContactName": "B", 
                                                        "DeliveryContactNumber": "08888888888", 
                                                        "DeliveryGooglePlaceAddress": "100 Allen Avenue, Ikeja, Nigeria", 
                                                        "DeliveryLandmark": "", 
                                                        "DeliveryLatitude": "6.6053397", 
                                                        "DeliveryLongitude": "3.3498556", 
                                                        "DeliveryDate": null, 
                                                        "DeliveryCode": "97136" 
                                                        } 
                                                    ] 
                                                } 
                                            ], 
                                            "Completed": [ 
                                                { 
                                                    "OrderID": 20992, 
                                                    "OrderCode": "ORD18595", 
                                                    "OrderStatus": "COMPLETED", 
                                                    "CreatedThrough": "web", 
                                                    "OrderPrice": 500, 
                                                    "FixedDeliveryCharge": null, 
                                                    "PayAt": 1, 
                                                    "IsPaid": "1", 
                                                    "IsProductOrder": 0, 
                                                    "BankCode": null, 
                                                    "BankName": null, 
                                                    "AccountNumber": null, 
                                                    "OrderedAt": "2020-10-29 18:19:54", 
                                                    "AssignedAt": "2020-10-29 18:30:33", 
                                                    "PickedUpAt": "2020-10-29 18:38:28", 
                                                    "DeliveredAt": "2020-10-29 18:40:10", 
                                                    "CancelledAt": null, 
                                                    "RejectedAt": null, 
                                                    "Packages": [ 
                                                        { 
                                                            "PackageID": 20803, 
                                                            "PackageDistance": 2.5, 
                                                            "PackageWeight": 0, 
                                                            "PackageDescription": "Sample", 
                                                            "IsDelivered": 1, 
                                                            "ProductAmount": null, 
                                                            "PickUpContactName": "A", 
                                                            "PickUpContactNumber": "09999999999", 
                                                            "PickUpGooglePlaceAddress": "1 Allen Avenue, Ikeja, Nigeria", 
                                                            "PickUpLandmark": "", 
                                                            "PickUpLatitude": "6.601838", 
                                                            "PickUpLongitude": "3.3514863", 
                                                            "PickUpDate": null, 
                                                            "DeliveryContactName": "B", 
                                                            "DeliveryContactNumber": "08888888888", 
                                                            "DeliveryGooglePlaceAddress": "100 Allen Avenue, Ikeja, Nigeria", 
                                                            "DeliveryLandmark": "", 
                                                            "DeliveryLatitude": "6.6053397", 
                                                            "DeliveryLongitude": "3.3498556", 
                                                            "DeliveryDate": "2020-10-29 18:40:10", 
                                                            "DeliveryCode": "72464" 
                                                        } 
                                                    ] 
                                                }, 
                                            ] 
                                        }, 
                                        ] 
                                        } 
                                        ] 
                                        } 
                                    }
                                

8.Track Order API:

This is an API for tracking your order.

Method: Post

Demo URL:

  https://dev.dellyman.com/api/v2.0/TrackOrder

Live URL:

  https://dellyman.com/api/v2.0/TrackOrder
Attribute Type Required Description
CustomerID Integer Mandatory Customer id
CustomerAuth String Mandatory Customer auth token you got while login
OrderID Integer Mandatory Order ID you need to check status

Sample Request

                                    { 
                                        "CustomerID": 2, 
                                        "CustomerAuth":"dfSVhQ8jQh0trncHkdELvwHgskI1Rj0w", 
                                        "OrderID": 50378
                                    } 
                                

Sample Response

                                    { 
                                        "OrderID": 50378, 
                                        "OrderCode": "ORD44914", 
                                        "OrderStatus": "CANCEL-REQUEST", 
                                        "OrderedAt": "2021-09-28 09:10:53", 
                                        "AssignedAt": null, 
                                        "PickedUpAt": null, 
                                        "DeliveredAt": null, 
                                        "CancelledAt": null, 
                                        "RejectedAt": null, 
                                        "RiderName": "", 
                                        "RiderLatitude": null, 
                                        "RiderLongitude": null, 
                                        "Packages": [ 
                                            { 
                                                "PackageDescription": "Allen/out/00024", 
                                                "IsDelivered": 0, 
                                                "PickupLatitude": 6.5996672, 
                                                "PickUpLongitude": 3.3535716, 
                                                "DeliveryLatitude": 6.6029869, 
                                                "DeliveryLongitude": 3.3509942, 
                                                "Distance": 2
                                            } 
                                        ] 
                                    }