With the Vendor API, you can retrieve either a list of Vendors or details about a single Vendor. Vendor IDs are unique.
Basic Attributes
The following attributes are returned by the API calls in this section.
Fields | Description | Data Type | Required? |
---|---|---|---|
1. id | FW Internal ID of the Vendor | integer | No |
2. mediaId | FW Internal ID of the media | integer | Yes |
3. name | Media name | string | Yes |
4. code | External Media code | string | No |
5. mediaOwner | Media Owner associated with the Vendor | string | No |
6. address | Vendor Work | Address fields | |
a. addressType | Address type of the Vendor (work) | string | Work |
b. line1 | Vendor address line 1 | string | No |
c. line2 | Vendor address line 2 | string | No |
d. zip | Vendor zip | string | No |
e. state | Vendor state | string | No |
f. city | Vendor city | string | No |
g. country | Vendor country | string | No |
7. InvoiceAddress | Vendor Invoice | Address fields | |
a. addressType | Address type of the Vendor (invoice) | string | Invoice |
b. line1 | Vendor address line 1 | string | No |
c. line2 | Vendor address line 2 | string | No |
d. zip | Vendor zip | string | No |
e. state | Vendor state | string | No |
f. city | Vendor city | string | No |
g. country | Vendor country | string | No |
8. TrafficAddress | Vendor Traffic | Address fields | |
a. addressType | Address type of the Vendor (Traffic) | string | Traffic |
b. line1 | Vendor address line 1 | string | No |
c. line2 | Vendor address line 2 | string | No |
d. zip | Vendor zip | string | No |
e. state | Vendor state | string | No |
f. city | Vendor city | string | No |
g. country | Vendor country | string | No |