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.

Authentication

For your account to be set, you require an API key. Please make sure to keep this key secured and never embed in client-side code. Without API key the APIs will not execute.

Test URL:

  https://sandbox.dellyman.com/api/v1.0/Authentication

Live URL:

  https://dellyman.com/api/v1.0/Authentication
Attribute Type Description
APIID integer Mandatory
APISecret string Mandatory

Example Request

    {

        "APIID": 2,

        "APISecret": "KIRA"

    }

Example Response

   
    {                       

        "authentication_token":"gjpynrke7w9v68furig5dz49ymoxo1mwi8ayq8",
        
        "ResponseCode": 100

    }

NOTE: "authentication_token" generated from the response will be the Bearer Token which needs to be passed in the header in all APIs

CustomerRegister

This is the API for creating new customer for delivering/receiving the goods.

Test URL:

  https://sandbox.dellyman.com/api/v1.0/CustomerRegister

Live URL:

  https://dellyman.com/api/v1.0/CustomerRegister
Attribute Type Description
Name string Mandatory
Email string Mandatory
Password string Mandatory
PhoneNumber string Mandatory

Example Request 

    {

        "Name": "Mark",

        "Email": "Mark@bytesflow.com",

        "Password": "123456",
        
        "PhoneNumber": "7010830432"
    
    }

Example Response

     {
     
         "ResponseCode": 100,
         
         "ResponseMessage": "User registered successfully.",
         
         "CustomerID": 106,
         
         "Email": "Mark@bytesflow.com",
         
         "Name": "Mark",
         
         "PhoneNumber": "7010830432",
        
         "IsActive": 0,
         
         "Currency": "NGN"
    
    }

CustomerValidation

After successful signup of customer, for login and validating the customer this API is used.

Test URL:

  https://sandbox.dellyman.com/api/v1.0/CustomerValidation

Live URL:

  https://dellyman.com/api/v1.0/CustomerValidation
Attribute Type Description
Email string Mandatory
Password string Mandatory

Example Request 

    {

        "Email": "mark@bytesflow.com",

        "Password": "123456"

    }

Example Response

    {

        "ResponseCode": 100,

        "ResponseMessage": "Valid user",

        "CustomerID": 106,

        "Email": "Mark@bytesflow.com",

        "Name": "Mark Wood",

        "PhoneNumber": "9840358848",
         
        "IsActive": 0,
         
        "Currency": "NGN",
            
        "CustomerAuth": "MmT6VIaHiLW0mtLRPr9nbZOP9vBL7lZb"

    }

CustomerUpdateProfile

This is an API for updating the customer details.

Test URL:

  https://sandbox.dellyman.com/api/v1.0/CustomerUpdateProfile

Live URL:

  https://dellyman.com/api/v1.0/CustomerUpdateProfile
Attribute Type Description
CustomerID integer Mandatory
CustomerAuth string Mandatory(Unique Authentication Code For Each Customer)
Name string Mandatory
Address string Mandatory
PhoneNumber string Mandatory

Example Request

    {

        "CustomerID": 106,

        "CustomerAuth": {{customer_auth}},

        "Name": "Mark Wood",

        "Address": "55/26 Akbar Sahib Street 2nd Lane Triplicane",

        "PhoneNumber": "9840358848"

   }

Example Response

   {
    
        "ResponseCode": 100,
        
        "ResponseMessage": "Profile changed successfully"
   
   }

CustomerChangePassword

This is the API for changing the customer password.

Test URL:

  https://sandbox.dellyman.com/api/v1.0/CustomerChangePassword

Live URL:

  https://dellyman.com/api/v1.0/CustomerChangePassword
Attribute Type Description
CustomerID integer Mandatory
CustomerAuth string Mandatory(Unique Authentication Code For Each Customer)
CurrentPassword string Mandatory
NewPassword string Mandatory

Example Request

   {

        "CustomerID": 106,

        "CustomerAuth": {{customer_auth}},

        "CurrentPassword": "123456",

        "NewPassword": "1234567"

    }

Example Response

   {
    
        "ResponseCode": 100,
        
        "ResponseMessage": "Password changed successfully"
   
   }

CustomerForgotPassword

This is the API, if a customer forgets the password link will be generated to registered email id.

Test URL:

  https://sandbox.dellyman.com/api/v1.0/CustomerForgotPassword

Live URL:

  https://dellyman.com/api/v1.0/CustomerForgotPassword
Attribute Type Description
Email string Mandatory

Example Request

    {

         "Email": "mark@bytesflow.com"
   
    }

Example Response

   {
    
        "ResponseCode": 100,
        
        "ResponseMessage": "Password reset link sent to your email  address."
       
   }

Logout

For once the account is set once the business user wants to logout of the session this API is used, once Logout is called we need to call once again Authentication API needs to be invoked for carrying out further APIs.

Test URL:

  https://sandbox.dellyman.com/api/v1.0/Logout

Live URL:

  https://dellyman.com/api/v1.0/Logout
Attribute Type Description
APIID integer Mandatory
APISecret integer Mandatory

Example Response

   {
    
        "ResponseCode": 100,
        "ResponseMessage": Logout Successfully
   
   }

CustomerTrackOrder

It is the API for customer to track the order details, with reference to OrderID.

Test URL:

  https://sandbox.dellyman.com/api/v1.0/CustomerTrackOrder

Live URL:

  https://dellyman.com/api/v1.0/CustomerTrackOrder
Attribute Type Description
CustomerID integer Mandatory
CustomerAuth string Mandatory
OrderID integer Mandatory

Example Request

   {

       "CustomerID": 106,
       
       "CustomerAuth": {{customer_auth}},
       
       "OrderID": 66
   
    }

Example Response

   {
    
        "ResponseCode": 100,
        
        "ResponseMessage": "Order Details",
        
        "OrderID": 66,
        
        "OrderCode": "ORD80",
        
        "OrderDate": "23 Oct, 2018",
        
        "PickUpLatitude": "13.0826802",
        
        "PickUpLongitude": "80.2707184",
        
        "DeliveryGooglePlaceID": "ChIJM5YYsYLFADsRMzn2ZHJbldw",
        
        "DeliveryGooglePlaceAddress": "Madurai, Tamil Nadu, India",
        
        "DeliveryCode": "TBERW",
        
        "Latitude": "12.9834941",
        
        "Longitude": "80.2192974",
        
        "DeliveryLatitude": "0.00",
        
        "DeliveryLongitude": "0.00"
   
   }

CustomerPendingOrders

It is the API for fetching the pending orders, here pending orders mean orders which are not picked up by any delivery guy.

Test URL:

  https://sandbox.dellyman.com/api/v1.0/CustomerPendingOrders

Live URL:

  https://dellyman.com/api/v1.0/CustomerPendingOrders
Attribute Type Description
CustomerID integer Mandatory
CustomerAuth string Mandatory

Example Request

   {

       "CustomerID": 106,
       
       "CustomerAuth": {{customer_auth}},
       
   }

Example Response

   {
    
        "PendingOrders": [],
        
        "ResponseCode": 100,
        
        "ResponseMessage": "Pending List"

   }

CustomerIntransitOrders

It is the API for fetching the intransit orders, here intransit orders mean orders which are picked up by delivery guy on course for delivery.

Test URL:

  https://sandbox.dellyman.com/api/v1.0/CustomerIntransitOrders

Live URL:

  https://dellyman.com/api/v1.0/CustomerIntransitOrders
Attribute Type Description
CustomerID integer Mandatory
CustomerAuth string Mandatory

Example Request

   {

       "CustomerID": 106,
       
       "CustomerAuth": {{customer_auth}},
   
    }

Example Response

   {
    
        {  

            "IntransitOrders": 

                [

                    {
                        
                        "OrderID": 66,
                        
                        "OrderCode": "ORD80",
                        
                        "OrderDate": "2018-10-23",
                        
                        "DeliveryContactName": "Lawliet",
                        
                        "DeliveryContactNumber": "92283746277",
                        
                        "DeliveryGooglePlaceID": "ChIJM5YYsYLFADsRMzn2ZHJbldw",
                        
                        "DeliveryGooglePlaceAddress": "Madurai, Tamil Nadu, India",
                        
                        "PackageDescription": "Notebook",
                        
                        "DeliveryCode": "0",
                        
                        "CompanyName": "Orphonix",
                        
                        "CompanyUseName": "Dr Azmuth",
                        
                        "CompanyUserPhoneNumber": "99118284"
                   
                    }
    
                ],
    
            "ResponseCode": 100,
            
            "ResponseMessage": "Intransit List"
        }

    }

CustomerCompletedOrders

It is the API for fetching the completed orders for a specific customer.

Test URL:

  https://sandbox.dellyman.com/api/v1.0/CustomerCompletedOrders

Live URL:

  https://dellyman.com/api/v1.0/CustomerCompletedOrders
Attribute Type Description
CustomerID integer Mandatory
CustomerAuth string Mandatory

Example Request

   {

       "CustomerID": 106,
       
       "CustomerAuth": {{customer_auth}},
   
   }

Example Response

   {
    
       "CompletedOrders": [],
       
       "ResponseCode": 100,
       
       "ResponseMessage": "Pending List"

   }

CustomerCalculateAmount

It is the API for getting price list of various available to us based on the distance given in KM

Test URL:

  https://sandbox.dellyman.com/api/v1.0/CustomerCalculateAmount

Live URL:

  https://dellyman.com/api/v1.0/CustomerCalculateAmount
Attribute Type Description
Distance Float Mandatory(Only Numbers Allowed)

Example Request

   {

        "Distance": 100
   
   }

Example Response

   {

        "Quotes": 

            [
    
                {
                    "CompanyID": 28,
                    
                    "Name": "John Inc",
                    
                    "Distance": 1,
                    
                    "TotalPrice": 10,
                    
                    "AvgRating": 2.8,
                    
                    "NumberOfOrders": 6,
                    
                    "NumberOfRating": 5
                },
        
                {

                    "CompanyID": 59,
                    
                    "Name": "HHIK",
                    
                    "Distance": 1,
                    
                    "TotalPrice": 20,
                    
                    "AvgRating": 0,
                    
                    "NumberOfOrders": 0,
                    
                    "NumberOfRating": 0

                }
            ],
    
        "ResponseCode": 100,
    
        "ResponseMessage": "Success"

   }

CustomerInvoice

This is the API for generating the Invoice for a specific package whenever the customer needs it.

Test URL:

  https://sandbox.dellyman.com/api/v1.0/CustomerInvoice

Live URL:

  https://dellyman.com/api/v1.0/CustomerInvoice
Attribute Type Description
CustomerID integer Mandatory
CustomerAuth string Mandatory
OrderID integer Mandatory

Example Request

   {

        "CustomerID": 106,
        
        "CustomerAuth": {{customer_auth}},
        
        "OrderID": 91

   }

Example Response

   { 

        "ResponseCode": 100,
        
        "ResponseMessage": "Invoice details",
        
        "InvoiceID": 23,
        
        "TransactionID": "61560050",
        
        "InvoiceNumber": "15",
        
        "OrderCode": "ORD103",
        
        "TotalPrice": 32440,
        
        "DeliveryCode": "32329",
        
        "Items": 
            [ 
            
                {

                    "SerialNumber": 1,

                    "ItemDescription": "Notebook",   
                     
                     "TotalPrice": 32440
                 }
            ]

    }

CustomerGetFeedback

It is API for a customer to get list of feedbacks for a company before opting for its services.

Test URL:

  https://sandbox.dellyman.com/api/v1.0/CustomerGetFeedback

Live URL:

  https://dellyman.com/api/v1.0/CustomerGetFeedback
Attribute Type Description
CompanyID integer Mandatory

Example Request

                            {
                            
                                "CompanyID": 24
                            
                            }

Example Response

    {

        "Feedback": 
            [
                                    
                {       
                    "CustomerName": "Light Yagami",
                    
                    "NumberOfStars": 5,
                    
                    "Remarks": "Okay",
                    
                    "IsDeliverySpeed": 0,
                    
                    "IsPackageSafety": 0,
                    
                    "IsPrice": 0,
                    
                    "Date": "23 November, 2018" 
                },
                                                
                {
                    
                    "CustomerName": "Light Yagami",
                    
                    "NumberOfStars": 4,
                    
                    "Remarks": "Okay",
                    
                    "IsDeliverySpeed": 0,
                    
                    "IsPackageSafety": 0,
                    
                    "IsPrice": 0,
                    
                    "Date": "23 November, 2018"
                
                },
                                                
                {
                   
                    "CustomerName": "Light Yagami",
                    
                    "NumberOfStars": 3,
                    
                    "Remarks": "Okay",
                    
                    "IsDeliverySpeed": 0,
                    
                    "IsPackageSafety": 0,
                    
                    "IsPrice": 0,
                    
                    "Date": "23 November, 2018"
                
                }
           ]
            
    }

CustomerPickupRequest

It is the API for picking up the order getting all the required details, when the customer fills out essential details for the product pickup.

Test URL:

  https://sandbox.dellyman.com/api/v1.0/CustomerPickupRequest

Live URL:

  https://dellyman.com/api/v1.0/CustomerPickupRequest
Attribute Type Description
CustomerID integer Mandatory
CompanyID integer Mandatory
CustomerAuth String Mandatory
PackageDescription String Mandatory(Describes the nature of product short/long)
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 Mandatory
PickUpRequestedTime String Mandatory(Give the Preferred Time Slot For Pickup )
DeliveryContactName String Mandatory(Give The Delivery Contact Name)
DeliveryContactNumber String Mandatory(Give The Delivery Contact Number)
DeliveryGooglePlaceAddress String Mandatory(Select The Proper Address Detail For the Delivery)
DeliveryLandmark String Mandatory
DeliveryRequestedTime String Mandatory(Give the Preferred Time Slot For Delivery )
PaymentCallbackURL String Mandatory(Give The Exact URL To Redirect on Successful Payment)

Example Request

    {
    
        "CustomerID": 108,
        
        "CompanyID": 28,
        
        "CustomerAuth": {{customer_auth}},
        
        "PackageDescription": "Note book",
        
        "PickUpContactName": "Light Yagami",
        
        "PickUpContactNumber": "9999999999",
        
        "PickUpGooglePlaceAddress": "Owerri, Nigeria",
        
        "PickUpLandmark": "Japan",
        
        "PickUpRequestedTime": "9PM - 12PM",
        
        "DeliveryContactName": "L Lawliet",
        
        "DeliveryContactNumber": "9999999999",
        
        "DeliveryGooglePlaceAddress": "Kano, Nigeria",
        
        "DeliveryLandmark": "Jap",
        
        "DeliveryRequestedTime": "12PM - 2PM",
        
        "PaymentCallbackURL":"http://dellyman.com"
    
    }

Example Response

    {
        "ResponseCode": 100,
        
        "ResponseMessage": "Order placed successfully.",
        
        "OrderID": 136,
        
        "OrderCode": "ORD157",
        
        "OrderPrice": 73510,
        
        "PaymentURL": "https://checkout.paystack.com/7v50vn3ulo1zbr5",
        
        "PaymentReference": "ORD157-1550581618"
                                    
    }

CustomerLogout

This is the API required to be called for customer logout of the application

Test URL:

  https://sandbox.dellyman.com/api/v1.0/CustomerLogout

Live URL:

  https://dellyman.com/api/v1.0/CustomerLogout
Attribute Type Description
CustomerID integer Mandatory
CustomerAuth String Mandatory

Example Request

    {
    
        "CustomerID": 106,
       
        "CustomerAuth": {{customer_auth}},
    
    }

Example Response

    {

        "ResponseCode": 100,
        
        "ResponseMessage": "Logged out successfully"

    }

CustomerVerifyPayment

This API is called when you need to verify that the payment made is successful or not.

Test URL:

  https://sandbox.dellyman.com/api/v1.0/CustomerVerifyPayment

Live URL:

  https://dellyman.com/api/v1.0/CustomerVerifyPayment
Attribute Type Description
OrderID integer Mandatory(Unique Id generated while calling CustomerPickUpRequest)
Reference String Mandatory(Give PaymentReference generated from the CustomerPickUpRequest)

Example Request

    {

        "OrderID ": 138,
      
        "Reference": "TSTORD161-1550585509"

    }

Example Response

    {
    
        "ResponseCode": 100,
        
        "ResponseMessage": "Payment verified successfully"

    }