...
This method returns a list of customers ordered by the customer name.
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. This field is very useful in other methods
- name (optional)(string:200): Name of the customer.
- code : Customer code.name: Customer name(optional)(string:10): Code of the customer.
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.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
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.
- customerType
...
- (string:200): Customer type. e.g.: Retailer, Wholesaler, etc etc.
| Code Block | |||||
|---|---|---|---|---|---|
|
...
| |
{ "status": "1", "message": "OK", "customers": [ { "id": " |
...
23423", "name": " |
...
ABC |
...
Wholesale", "code": " |
...
ABC", "active": "1", "salesPerson": "Jhon Doe", "customerType": "Wholesaler" } , { "id": " |
...
25555", "name": " |
...
DEF Retailer |
...
Best", "code": " |
...
DEF", "active": "1", "salesPerson": "Jhon Doe", "customerType": "Retailer" } ] } |