Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

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

Input parameters:

  • authenticationToken (required)(string:50): Komet Sales security token.
  • id (optional)(integer:20): Komet Sales internal location id. This field is very useful in other methods
  • name (optional)(string:200): Name of the location.
  • code : Location code.name: Location name(optional)(string:10): Code of the location.

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.

Code Block
themeConfluence
languagejs
titleSample
https://api.kometsales.com/api/location.list?authenticationToken=token_info_goes_here

Response

Output:

  • status (integer:1): Transaction status. 1 for success or 0 for failure.
  • message (string:500): Description of the status of the transaction.
  • locations: array of locations
    • id (integer:20): Komet Sales internal location Id.
    • name (string:200): Name of the location.
    • code (string:10): Code of the location.
Code Block
true
themeFadeToGreyConfluence
titleOutput example
linenumberslanguagejs
{
    "status": "1",
    "message": "OK",
    "locations": [
        {
            "id": "1",
            "name": "Locations I",
            "code": "LI"
        }
        ,
        {
            "id": "2",
            "name": "Locations II",
            "code": "LII"
        }
    ]
}