Page Comparison

This method returns a list of vendors to Komet Sales. 

Request

URL: 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 ID.

• name (optional)(string:200): name of the vendor.

• code (optional)(string:10): code of the vendor.

• portOrigin (optional)(string:4): code of the origin port (MIA, BOG, MDE, etc).

• includeInactive (optional)(boolean): true or false. If it's true it will also return vendors that have been deactivated. 

curl

https://api.kometsales.com/api/vendor.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.

• vendors: array of vendors

  • id (integer:20): Komet Sales internal vendor ID.

  • name (string:200): name of the vendor.

  • code (string:10): code of the vendor.

  • portOrigin(string:4): code of the origin port (MIA, BOG, MDE, etc).

  • cargoMasterCode (string: 20): vendor code set up for the Cargo Master integration. This field will be available only if the company has the Integration with Cargo Master enabled.

  • active (boolean:1): 1 if the vendor is active, 0 if the vendor is not active.

Sample Response

{
    "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
        }
    ]
}