Get a list of Locations
Use this method to get a list of Locations ordered by Location name.
Valid Tokens: Company.
You can send parameters such as id, code, and name to filter the results. When you use these filters, keep the following statements in mind:
Filtering by
idandcodeuses an exact match.Filtering by
nameuses a "LIKE" expression.Filters are not case-sensitive.
Related Articles
-
Delete a Prebook 1.0 (API)
-
-
-
Add Inventory (API)
-
Assign a Main Location to a Customer (Knowledge Base)
Request
URL: https://app.kometsales.com/api/location.list
Method: GET
Content-Type: URL Parameters
Input parameters
authenticationToken (required)(string:50)
Komet Sales security token.
id (optional)(integer:20)
Komet Sales internal Location ID.
name (optional)(string:200)
Location name.
code (optional)(string:10)
Location code.
https://api.kometsales.com/api/location.list?
authenticationToken=token_info_goes_hereResponse
status (integer:1)
Transaction status. 1 = Success | 0 = Failure
message (string:500)
Transaction status description.
locations (array)
An array of locations.
id (integer:20)
Komet Sales internal Location ID.
name (string:200)
Location name.
code (string:10)
Location code.
{
"status": "1",
"message": "OK",
"locations": [
{
"id": "1",
"name": "Locations I",
"code": "LI"
},
{
"id": "2",
"name": "Locations II",
"code": "LII"
}
]
}