...
- authenticationToken (required)(string:50): Komet Sales security token.
- id (optional)(integer:20): Komet Sales internal customer idID.
- name (optional)(string:200): Name name of the customer.
- code (optional)(string:10): Code code of the customer.
You can send other parameters such as the idID, code and name in order to filter the results. Filtering by id 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 transaction status. 1 for success or 0 for failure.
- message (string:500): Description description of the status of the transaction.
- customers: array of customers
- id (integer:20): Komet Sales internal customer IdID.
- name (string:200): Name name of the customer.
- code (string:10): Code code of the customer.
- active (boolean:1): 1 if the customer is active, 0 if the customer is not active.
- salesPerson (string:200): Sales sales person name.
- customerType (string:200): Customer 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"
}
]
} |