Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
...
This method returns a list of locations ordered by the location name.
Request
URL: 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.
name (optional)(string:200): name of the location.
code (optional)(string:10): code of the location.
| Info |
|---|
|
...
|
...
|
curl
| Code Block | ||
|---|---|---|
| ||
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.
Sample Response
| Code Block |
|---|
...
|
...
| |
{ |
...
"status": "1", |
...
"message": "OK", |
...
"locations": [
|
...
{
|
...
"id": "1", |
...
"name": "Locations I", |
...
|
...
"code": "LI"
|
...
} |
...
,
|
...
{ |
...
"id": "2",
|
...
"name": "Locations II",
|
...
"code": "LII" |
...
} |
...
]
} |
| Panel | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|