This is pre-release documentation for an API in public beta and is subject to change.
To update information about a vendor, call the UpdateVendor endpoint with a Vendor object containing properties you want to update.
To update multiple vendors at once, call the BulkUpdateVendors endpoint. When you call BulkUpdateVendors, you specify whatever properties that need to be changed in a vendor object and specify that vendor in the map, as the input, with the vendor's ID as the key.
After creating a vendor without specifying any contact, you can call UpdateVendor to add a contact to the vendor. You can also call this endpoint to update an existing contact of the vendor.
Link to section
Request: Add a vendor's contact information
The following example shows how to add a new contact to a vendor, as referenced by the 7HRKHFRCOI4U7XDW ID:
When adding a contact to an existing vendor, do not specify the ID for the new contact. The ID of the new contact is returned when it is added to the vendor.
When updating an existing contact, you must specify the contact ID in the input.
When specifying a contact on the input, you must set an ordinal value that is unique across all contacts of the vendor.
You must specify the current version of the vendor when updating any information of the vendor. You can call the RetrieveVendor endpoint to find out the current version of the vendor.
Link to section
Response: Add or update a vendor's contact information
The successful response returns a payload similar to the following:
Note that the UpdateVendor (or BulkUpdateVendors) endpoint uses the so-called sparse update, where only affected attributes need to be specified in the input to the update request. Unspecified attributes remain unchanged by the update operation.
Link to section
Add or update multiple vendor addresses
When you want to add or update addresses for multiple vendors, you can call BulkUpdateVendors to get the addresses added or updated all at once.
Link to section
Request: Add or update multiple vendor addresses
The following example adds or updates two vendor addresses:
To update a vendor's name and note, call UpdateVendor while specifying a new name and a new note for a specified vendor.
Link to section
Request: Update a vendor's name and note
Suppose you reactivated a vendor and the vendor has rebranded itself. Now you want to change the vendor's name and update the vendor note accordingly. The following example shows how to call UpdateVendor to accomplish these tasks:
Make sure to use the most recent version numbers in the input to the request. You might want to call BulkRetrieveVendors first to obtain the most recent version numbers of the specified vendors.
Link to section
Response: Deactivate multiple vendors
The successful response returns a payload similar to the following: