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
General Information

This Document describes the details Of Codelayer API, its functionalities And usage.

All calls To the API Is done Using JSON HTTPs POST, unless otherwise specified In the corresponding section. There are two parts For the URL first part Is the API location eg: https : //wats.api.codelayer.co.in/ This part should be configurable by the End user And this only changes When the hosting Of the API Is changed. The Second part Is the actual location In the API And Is described In this documentation. This part Is fixed And will only change When there Is a major change In the API functionality.

Example : If the fixed part Is https://wats.api.codelayer.co.in/ And URL of Authentication As per document Is system/auth so the full URL For Estate Authentication will be https://wats.api.codelayer.co.in/system/auth

General Guidelines

The Key field should be always present In all the API calls except For Authentication, which generates the key. The key will expire On inactivity And should be re-obtained In such cases With re-authentication.

Fields e And msg will be always present In all responses, And any response from the API without these two fields should be treated As Error.

There can be multiple failure responses, but only one Is shown In current version Of document.

Description of Terms used
Min
  • String: Minimum length of the string.
  • Integer: Minimum value.
Max
  • String: Maximum length of the string.
  • Integer: Maximum value.
Mandatory Response Fields
  • e : Status Code. Status code 200 Is success.
  • msg : Response status description.

Details Of status code And description can be found In the Response Codes section.