Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
Excerpt |
---|
This method returns a list of vendors to Komet Sales. |
Request
https://api.kometsales.com/api/vendor.list
- Method: GET
- Content-Type: URL Params.
Input parameters:
- authenticationToken (required)(string:50): Komet Sales security token.
- id (optional)(integer:20): Komet Sales internal vendor idID.
- name (optional)(string:200): Name name of the vendor.
- code (optional)(string:10): Code code of the vendor.
You can send other parameters such as the idID, code and name in order to filter the results. Filtering by id ID and code uses an exact match. Filtering by name uses a "LIKE" expression. Filters are not case sensitive.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
https://api.kometsales.com/api/vendor.list?authenticationToken=token_info_goes_here |
Response
Output:
- status (integer:1): Transaction transaction status. 1 for success or 0 for failure.
- message (string:500): Description description of the status of the transaction.
- vendors: array of vendors
- id (integer:20): Komet Sales internal vendor IdID.
- name (string:200): Name name of the vendor.
- code (string:10): Code code of the vendor.
- active (boolean:1): 1 if the vendor is active, 0 if the vendor is not active.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "status": "1", "message": "OK", "vendors": [ { "id": "1", "name": "Vendor I", "code": "VI" }, { "id": "2", "name": "Vendor II", "code": "GII" } ] } |