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 Customers

Customer List is given. Customers on the Route from Route Details will be listed

URL

sales/route_customers

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

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
details Array M Details of the customers in the given route. From User Login, Route of User is known. Customers coming under this route will be listed.
custname String 1 150 M AROMAL FOODS -KOLLAM Customer name
custcode Integer 1 99999 M 447 customer code
place String 1 150 M Anchal Customer's place
creditallowed Integer 1 M 0 Credit allowed or not
discounts Array M Discount per quantity for the customer for discount available items
itemcode Integer 1 M 602 Item code on the Item
discount Decimal M 3.00 Discount allowed per item
balance String M Balance
latitude Decimal -90 90 M 8.50472669182539 Latitude of the place in Decimal degrees (DD) format. Reference: Google Maps Help.
longitude Decimal -180 180 M 76.97219809387414 Longitude of the place in Decimal degrees (DD) format. Reference: Google Maps Help.
placeorder Integer M 1 Route Order

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq"
}
Sample Success Response
{
    "details": [
        {
            "custname": "AROMAL FOODS -KOLLAM",
            "custcode": "447",
            "place": "Anchal",
            "creditallowed": "0",
            "discounts": [
                {
                    "itemcode": "602",
                    "discount": "3.00"
                }
            ],
            "balance": "",
            "latitude": "8.50472669182539",
            "longitude": "76.97219809387414",
            "placeorder": "1"
        }
    ],
    "e": 200,
    "msg": "Success"
}
Sample Failure Responses
{
    "e": 400,
    "msg": "Bad Request."
}
{
    "e": 401,
    "msg": "Invalid authentication credentials."
}