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 Products

Product details available in the vehicle will be listed

URL

sales/route_products

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 uD5PYl2WjAbUa3RFBF3ocEDxZyoenCbL Key obtained from authentiaction.

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
products Array M Product list from the Gatepass Out details
itemcode Integer 1 9999 M 185 Itemcode of products
itemname String 1 150 M CHAPATHI COOKED -MRP-8 Name of Product
hsncode String 35 M 10001000 Hsncode of Product
taxpercentage Decimal 99 M 0.00 Tax percentage of product
qty Decimal 1 9999 M 50.00 Total quantity of product that is available at the begining
rate Decimal 1 99999 M 8.00 Rate of Product

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq"
}
Sample Success Response
{
    "products": [
        {
            "itemcode": "185",
            "itemname": "CHAPATHI COOKED -MRP-8",
            "hsncode": "10001000",
            "taxpercentage": "0.00",
            "qty": "50.00",
            "rate": "8.00"
        }
    ],
    "e": 200,
    "msg": "Success"
}
Sample Failure Responses
{
    "e": 400,
    "msg": "Bad Request."
}
{
    "e": 401,
    "msg": "Invalid authentication credentials."
}