Overview

Returns a list of locations ordered by the location name.

Request

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

Input parameters:

• authenticationToken (required): Komet Sales security token.
• id: Komet Sales internal location id. This field is very useful in other methods.
• code: Location code.
• name: Location name.

You can send other parameters such as the id, code and name in order to filter the results. Filtering by id and code uses an exact match. Filtering by name uses a "LIKE" expression. Filters are not case sensitive.

Response

Output:

• status
• message
• locations: array of locations
  • id
  • name
  • code
    
    

{
    "status": "1",
    "message": "OK",
    "locations": [
        {
            "id": "1",
            "name": "Locations I",
            "code": "LI"
        }
        ,
        {
            "id": "2",
            "name": "Locations II",
            "code": "LII"
        }
    ]
}