Overview

This method returns a list of customers.

Request

https://api.kometsales.com/api/customer.list

Method: GET
Content-Type: URL Params.

Input parameters:

authenticationToken (required)(string:50): Komet Sales security token.
id (optional)(integer:20): Komet Sales internal customer ID.
name (optional)(string:200): name of the customer.
code (optional)(string:10): code of the customer.
salesPersonId (optional)(integer:20): Komet Sales internal salesperson ID.
includeInactive (optional)(boolean): true or false. If it's true it will also return customers that have been deactivated.
locationId (optional)(integer:20): location Komet Sales internal ID. You can obtain this value from the location.list API method.

You can send other parameters such as the ID, code and name in order to filter the results. Filtering by ID and code uses an exact match. Filtering by name uses a "LIKE" expression. Filters are not case sensitive.

Sample

 https://api.kometsales.com/api/customer.list?authenticationToken=token_info_goes_here

Response

Output:

status (integer:1): transaction status. 1 for success or 0 for failure.
message (string:500): description of the status of the transaction.
customers: array of customers
- id (integer:20): Komet Sales internal customer ID.
- name (string:200): name of the customer.
- code (string:10): code of the customer.
- active (boolean:1): 1 if the customer is active, 0 if the customer is not active.
- salesPerson (string:200): sales person name.
- salesPersonId (integer:20): sales person ID.
- customerType (string:200): customer type. e.g.: Retailer, Wholesaler, etc.

Sample

{
    "status": "1",
    "message": "OK",
    "customers": 
    [
        {
            "id": "23423",
            "name": "ABC Wholesale",
            "code": "ABC",
            "active": "1",
            "salesPerson": "Jhon Doe",
            "salesPersonId": 23423,
            "customerType": "Wholesaler"
        }
        ,
        {
            "id": "25555",
            "name": "DEF Retailer Best",
            "code": "DEF",
            "active": "1",
            "salesPerson": "Jhon Doe",
            "salesPersonId": 23423,
            "customerType": "Retailer"
        }
    ]
}