Overview

This method returns a list of customers associated to a company. Keep in mind that this method only works with user's tokens. 

Request

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

  • Method: GET
  • Content-Type: URL Params.

Header

  • X-SALES-CHANNEL (string: 20): Valid values: "WEB_APP", "MOBILE_APP", "K2K" , "ECOMMERCE_LITE". 
  • X-ACCOUNT (required) (integer:20): Company ID that is using the API. Please ask Komet Sales team to have this ID. 

Input parameters:

  • authenticationToken (required)(string:50): Komet Sales security token.
  • showSalespersonCustomers (optional) (Boolean): true/false. Indicates whether only the customers associated to the logged on user should be displayed.

 

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

Response

Output:

  • customerResult (array): array of Customers
    • customerId (integer 10): The ID of the customer
    • customerName (String): the name of the customer
Sample
{
    "customerResult": [
        {
            "customerId": 29675,
            "customerName": "10 DOWNING ST"
        },
        {
            "customerId": 7359,
            "customerName": "2-14 ENTERPRISES BRIDAL CAKES"
        },
        {
            "customerId": 29623,
            "customerName": "A NEW LEAF OF WI,LLC"
        },
        {
            "customerId": 29671,
            "customerName": "a TRIO JEWELRY & DESIGN LLC"
        }
        ]
}