| Excerpt | ||
|---|---|---|
Use this method to get a list of Company Locations associated with a Customer.
|
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Request
URL: https://api.kometsales.com/api/company.location.list
Method: GET
Content-Type: URL Parameters
Header
X-SALES-CHANNEL (required) (string: 20)
The sales channel.
Valid values: "WEB_APP", "MOBILE_APP", "K2K" , "ECOMMERCE_LITE".
X-ACCOUNT (required)(integer:20)
Company ID that is using the API.
Please ask the Komet Sales team for this ID.
authenticationToken (required) (string:50)
Komet Sales security token.
Input parameters
customerId (required) (Integer 10)
The Customer ID.
| Code Block | ||
|---|---|---|
| ||
https://api.kometsales.com/api/company.location.list? customerId=98982 -H authenticationToken=token_info_goes_here |
Response
locations (array)
An array containing the Locations associated with the Customer.
id (integer 10)
The Location ID.
name (String)
Location name.
shortName (String)
The Location’s short name.
code (String)
Location code.
active (boolean)
If the Location is active.
| Code Block |
|---|
{
"locations": [
{
"id": 18,
"name": "California",
"shortName": null,
"code": "30",
"active": true
},
{
"id": 2,
"name": "Richmond",
"shortName": Rich,
"code": "36",
"active": true
}
]} |