Get a Vendor list

Use this method to get a list of Vendors in Komet Sales.

Valid Tokens: Company.

Take the following statements into account when using parameters to filter results:

  • Filtering by id and code uses an exact match.

  • Filtering by name uses a "LIKE" expression.

  • Filters are not case-sensitive.


Related Articles

Request


URL: https://api.kometsales.com/api/vendor.list

Method: GET

Content-Type: URL Parameters


Input parameters

authenticationToken (required)(string:50)

Komet Sales security token.


id (optional)(integer:20)

Komet Sales internal Vendor ID.


name (optional)(string:200)

Vendor name.


code (optional)(string:10)

Vendor code.


portOrigin (optional)(string:4)

Port of Origin code.


includeInactive (optional)(boolean)

Include inactive Vendors.

Valid values: True | False


https://api.kometsales.com/api/vendor.list? authenticationToken=token_info_goes_here

Response


status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure


message (string:500)

Transaction status description.


vendors (array)

An array containing Vendors.


id (integer:20)

Komet Sales internal Vendor ID.


name (string:200)

Vendor name.


code (string:10)

Vendor code.


portOrigin(string:4)

Port of Origin code.


cargoMasterCode (string: 20)

Cargo Master code of the Cargo Master Integration.

The system will only return this field if the company has the Integration with Cargo Master enabled.


active (boolean:1)

Vendor status.

Valid values: 1 = Active | 0 = Inactive


{ "status": "1", "message": "OK", "vendors": [ { "id": "1", "name": "Vendor I", "code": "VI", "cargoMasterCode": "CMVI", "active": 1 }, { "id": "2", "name": "Vendor II", "code": "GII", "cargoMasterCode": "CMVII", "active": 1 } ] }
Peacock