Codelayer API Documentation

  • Introduction

    • General
  • API Reference

    • System

      • License request
      • Register Device
      • Authentication
    • Sales

      • Add Customer
      • Check Customer
      • Device Location
      • Master Place
      • Master Routes
      • Notification Details
      • Product Summary
      • Return details
      • Route Closing
      • 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
      • Sales Details
      • Shop Limit Override Request
      • Stock Transfer
      • Update Device Token
      • Update Notifications
    • 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 UyHWJlsLnzhcJ03sSUOZhDH2AZWZxRJA 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
applyReturnPercOnGPQty String M F
needReturnPercCheckingOnApp String M F
slmAcCode Integer M 0
drvShopCount Integer M 0
drvShopCountPrev Integer M 0
slmShopCount Integer M 0
slmShopCountPrev Integer M 0
rtShopCount Integer M 0
rtShopCountPrev String M 0
fcmToken String M
shopLimitWarn String M F
distToShopGpsValidation String M F
minShopCreateCount Integer M 0
upiId String M
companyName String M
rid Integer M 0
prdcnt String M 0
drvAcCode Integer M

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq"
}
Sample Success Response
{
    "details": [
        {
            "gp_fyear": "4_19",
            "vehicle": "KL24R 119",
            "routename": "ALAMCHEARY",
            "salesman": "SANDHYA",
            "driver": "BIBIN DAS",
            "shoptoappdistance": "100",
            "applyReturnPercOnGPQty": "F",
            "needReturnPercCheckingOnApp": "F",
            "slmAcCode": "0",
            "drvShopCount": "0",
            "drvShopCountPrev": "0",
            "slmShopCount": "0",
            "slmShopCountPrev": "0",
            "rtShopCount": "0",
            "rtShopCountPrev": "0",
            "fcmToken": "",
            "shopLimitWarn": "F",
            "distToShopGpsValidation": "F",
            "minShopCreateCount": "0",
            "upiId": "",
            "companyName": "",
            "rid": "0",
            "prdcnt": "0",
            "drvAcCode": ""
        }
    ],
    "e": 200,
    "msg": "Success"
}
Sample Failure Responses
{
    "e": 400,
    "msg": "Bad Request."
}