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 Save

Save the Sales form

URL

sales/route_save

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 bKJYLQX8nAqVuQt5Z0AJP5VwhZVl2DF9 Key obtained from authentiaction.
latitude Decimal -90 90 M 8.50472669182539 Latitude of the place in Decimal degrees (DD) format. Reference: Google Maps Help.
gp_fyear String 4 15 M 4_19 The response from Route Details
custcode Integer 1 99999 M 359 Customer code from Route Customers
paymentmode Character M D Cash Received Mode C for Cash B for Cheque
cashreceived Decimal 99999 M 2500 Cash Received Figure
roff Decimal 9999 M 1 Round off amount
specialdisc Decimal 99999 M 1 Special discount amount
sales Array 1 M itemwise sales details
taxperc Decimal 99 M 0 Tax percentage from Route Products
itemcode Integer 1 9999 M 1 Itemcode from Route Products
qty Decimal 9999 M 2 Quantity entered by user
rate Decimal 99999 M 10 Rate from Route products
longitude Decimal -180 180 M 76.97219809387414 Longitude of the place in Decimal degrees (DD) format. Reference: Google Maps Help.
datetime String M 2021-01-03 07:06:08 Date time in Y-m-d H:i:s (PHP) format.
uid String 1 32 M d2974959e7bd40fd94269de2794ea70d Unique ID

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
status String 1 100 M Saved
slno Integer M 1
uid String 1 32 M d2974959e7bd40fd94269de2794ea70d Unique ID sent.

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq",
    "latitude": "8.50472669182539",
    "gp_fyear": "4_19",
    "custcode": "359",
    "paymentmode": "D",
    "cashreceived": "2500",
    "roff": "1",
    "specialdisc": "1",
    "sales": [
        {
            "taxperc": "0",
            "itemcode": "1",
            "qty": "2",
            "rate": "10"
        }
    ],
    "longitude": "76.97219809387414",
    "datetime": "2021-01-03 07:06:08",
    "uid": "d2974959e7bd40fd94269de2794ea70d"
}
Sample Success Response
{
    "status": "Saved",
    "slno": "1",
    "uid": "d2974959e7bd40fd94269de2794ea70d",
    "e": 200,
    "msg": "Success"
}