Codelayer API Documentation

  • Introduction

    • General
  • API Reference

    • System

      • License request
      • Register Device
      • Authentication
    • Sales

      • Add Customer
      • Check Customer
      • Device Location
      • Master Place
      • Master Routes
      • Product Summary
      • Return details
      • Route Customers
      • Route Details
      • Route Path
      • Route Products
      • Route Products Return
      • Route Report
      • Route Return
      • Route Salesmen
      • Route Save
      • Route Save With Remarks
      • Route Shops
      • Sales Closing
      • Stock Transfer
      • Update Device Token
    • Response Codes
Codelayer API Documentation
Route Details

On User Login, When Sales page is opened, Route details will be given

URL

sales/route_details

Method

POST

Request Media type

application/json

Response Media type

application/json

Request Parameters
Parameter Data Type Min Max M/O Sample Value Comments
key String 32 32 M KjCrcSP3T2S3F5Px9ar7QAGYjYvWPtCi Key obtained from authentiaction.

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
details Array M Details of Vehicle the Login User is travelling.
gp_fyear String 4 15 M 4_19 Combination of Gatepass Out number and Financial Year
vehicle String 1 150 M KL24R 119 Vehicle Name
routename String 1 150 M ALAMCHEARY Route name
salesman String 1 150 M SANDHYA Salesman
driver String 1 150 M BIBIN DAS Driver
shoptoappdistance Integer M 100 Shop to Mobile app Distance in Metre

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq"
}
Sample Success Response
{
    "details": [
        {
            "gp_fyear": "4_19",
            "vehicle": "KL24R 119",
            "routename": "ALAMCHEARY",
            "salesman": "SANDHYA",
            "driver": "BIBIN DAS",
            "shoptoappdistance": "100"
        }
    ],
    "e": 200,
    "msg": "Success"
}
Sample Failure Responses
{
    "e": 400,
    "msg": "Bad Request."
}