With the Vendor API, you can retrieve either a list of Vendors or details about a single Vendor. Vendor IDs are unique.

Basic Attributes

FieldsDescriptionData TypeRequired?
idFW Internal ID of the VendorintegerNo
mediaIdFW Internal ID of the mediaintegerYes
nameMedia namestringYes
codeExternal Media codestringNo
mediaOwnerMedia Owner associated with the VendorstringNo
addressVendor WorkAddress fields
addressTypeAddress type of the Vendor (work)stringWork
line1Vendor address line 1stringNo
line2Vendor address line 2stringNo
zipVendor zipstringNo
stateVendor statestringNo
cityVendor citystringNo
countryVendor countrystringNo
InvoiceAddressVendor InvoiceAddress fields
addressTypeAddress type of the Vendor
(invoice)
stringInvoice
line1Vendor address line 1stringNo
line2Vendor address line 2stringNo
zipVendor zipstringNo
stateVendor statestringNo
cityVendor citystringNo
countryVendor countrystringNo
TrafficAddressVendor TrafficAddress fields
addressTypeAddress type of the Vendor (Traffic)stringTraffic
line1Vendor address line 1stringNo
line2Vendor address line 2stringNo
zipVendor zipstringNo
stateVendor statestringNo
cityVendor citystringNo
countryVendor countrystringNo