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
Product Summary

Summary of product sale quantity.

URL

sales/route_productsummary

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

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
details Array M Details pf sale quantity
itemcode Integer 1 M 1 Itemcode of the product.
itemname String 1 M CHAPATHI Name of the Item
qty Decimal M 250.00 Quantity
sales Decimal M 0.00 Sale quantity
retrn Decimal M 0.00 Return quantity
bal Decimal M 250.00 Balance quantity

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq"
}
Sample Success Response
{
    "details": [
        {
            "itemcode": "1",
            "itemname": "CHAPATHI",
            "qty": "250.00",
            "sales": "0.00",
            "retrn": "0.00",
            "bal": "250.00"
        }
    ],
    "e": 200,
    "msg": "Success"
}
Sample Failure Responses
{
    "e": 400,
    "msg": "Bad Request."
}
{
    "e": 401,
    "msg": "Invalid authentication credentials."
}