Overview

This method returns a list of customers ordered by the customer name.

Request

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

Input parameters:

• authenticationToken (required): Komet Sales security token.
• id: Komet Sales internal customer id. This field is very useful in other methods.
• code: Customer code.
• name: Customer name.

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.

Response

Output:

• status
• message
• customers: array of customers
  • id
  • name
  • code
  • salesPerson
  • customerType
  • active
    
    

{
    "status": "1",
    "message": "OK",
    "customers": [
        {
            "id": "1",
            "name": "Customer I",
            "code": "CI",
            "active": "1",
            "salesPerson": "Jhon Doe",
            "customerType": "Wholesaler"
        }
        ,
        {
            "id": "2",
            "name": "Customer II",
            "code": "CII",
            "active": "1",
            "salesPerson": "Jhon Doe",
            "customerType": "Retailer"
        }
    ]
}