Update a Vendor
- Andres Toledo
Use this method to update an existing Vendor in Komet Sales.
Valid Tokens: Company.
Related Articles
-
Delete a Prebook 1.0 (API)
-
-
Shipping Schedule by Vendor (Knowledge Base)
-
Vendors (Knowledge Base)
-
Vendor Options Setup (Knowledge Base)
Read before updating contacts:
When updating a vendor with existing contacts, you must send all contact information, both pre-existing and new, because the system will overwrite existing contacts with the information provided in this request.
Request
URL: https://api.kometsales.com/api/vendor.update
Method: POST
Content-Type: application/JSON
Input Parameters
authenticationToken (required)(string:50)
Komet Sales security token.
vendorId (integer:20)
Komet Sales internal Vendor ID.
vendorType (optional)(integer:1)
Vendor type.
Valid values: 1 = Fresh Cut | 2 = Freight & Handling | 3 = Hard Goods
name (optional)(string:200)
Vendor name.
status (optional)(boolean)
Vendor status.
Valid values: 1 = Active | 0 = Inactive
portOrigin (optional)(string:5)
Port of Origin code.
code (optional)(string:10)
Vendor code.
phone1 (optional)(string:20)
Phone number one.
phone2 (optional)(string:20)
Phone number two.
phone3 (optional)(string:20)
Phone number three.
fax (optional)(string:20)
Fax number.
webPage (optional)(string:50)
Vendor’s website address.
emailForPOs (optional)(string:200)
Email addresses where the system will send the Vendor’s Purchase Orders.
You can enter multiple email addresses separated by semicolons.
notes (optional)(string:200)
Additional notes or comments that you want to associate with the vendor.
street (optional)(string:200)
Vendor’s street address.
city (optional)(string:50)
Vendor’s city.
state (optional)(string:50)
Vendor’s state.
zipcode (optional)(string:10)
Vendor’s ZIP code.
country (optional)(string:50)
Vendor’s country.
contacts (optional)(array)
An array containing the contact person's information, you can add multiple contacts simultaneously.
companyLocationId (optional)(integer)
Location ID.
Required for Multi-location Companies.
name (required)(string)
Contact name.
phone (optional)(string)
Contact phone.
phoneExt (optional)(string)
Phone extension.
mobile (optional)(string)
Mobile phone.
email (required)(string)
Contact email address.
fax (optional)(string)
Fax number.
contactDescription (optional)(string)
Contact description.
isEmailPOs (optional)(boolean)
Suggest this contact when sending POs to the vendor.
isEmailQCc (optional)(boolean)
Suggest this contact when sending QC and credits to the vendor.
{
"authenticationToken": "token_info_goes_here",
"vendorId":"234234",
"name": "Flores ABC",
"status": "1",
"portOrigin": "BOG",
"code": "ABC",
"phone1": "054 474 3222",
"phone2": "054 474 3223",
"webpage":"www.floresabc.com",
"emailForPos": "sales@floresabc.com",
"contacts": [
{
"companyLocationId": 215,
"name": "Pablo",
"email": "pablo@mail.com"
}
}
Response
status (integer:1)
Transaction status.
Valid values: 1 = Success | 0 = Failure
message (string:500)
Transaction status description.
vendorId (integer:20)
Komet Sales internal Vendor ID.
{
"status": "1",
"message": "success",
"vendorId": 234234
}