Overview


This method returns a list of company locations associated to a customer.

 


Request

https://api.kometsales.com/api/company.location.list

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

Header

  • X-SALES-CHANNEL  (required) (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. 
  • authenticationToken (required) (string:50): Komet Sales security token.


Input parameters:

  • customerId (required) (Integer 10): The Id of the customer


Sample
https://api.kometsales.com/api/company.location.list?customerId=98982 -H authenticationToken=token_info_goes_here

Response

Output:

  • locations : array of locations associated to the customer
    • id (integer 10): the ID of the location.
    • name (String): the name of the location.
    • shortName (String): the short name of the location.
    • code (String): the code of the location.
    • active (Boolean): true/false.


Information

This method can be executed with tokens type company and vendor for users