ProductVendor

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will eventually be deactivated. At this time, there is no end-of-lifecycle date.

This entity describes a Vendor type Account that is associated with an Autotask Product. Products can be associated with more than one Product Vendor. A Product Vendor is not required unless the user intends to create an Inventory Item from the Product and add the Inventory Item to one or more purchase orders.

In Autotask, users associate Vendors with Products and manage the Product Vendors through the Add/Edit Product window accessed through the Product Search list in the Admin or Inventory modules.

Entity details

You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.

Entity Name: ProductVendor
Can Create:
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:  

Conditions and requirements

General

The Web Services API ProductVendor entity displays the following behaviors.

  • To query, you must have View permission and (Admin > Products OR Inventorymodule access (site installed module access only))
  • To create/update, you must have View and Create permission and (Admin > Products OR Inventorymodule access (site installed module access only))

Special field attributes

Field Conditions and Requirements
IsDefault On create(), if no default ProductVendor exists for the product, ProductVendor.IsDefault is set to True for the newly created ProductVendor. If multiple Product Vendors are created in a single batch, and no default ProductVendor exists, IsDefault is set to True for the first ProductVendor created via the batch.
ProductVendor

On create() and update(), the following conditions and requirements apply:

  • The ProductVendor cannot already be associated with the Product entity and, for batch creation, the batch cannot include duplicate ProductVendors.
  • The associated product must have at lease one active ProductVendor (if only one ProductVendor is associated with the product, ProductVendor.Active cannot equal false.)
  • A product cannot have more than one default ProductVendor.
  • A ProductVendor cannot be both the Default and Inactive.
VendorCost

If Multi-currency is enabled and the vendor is associated with a different currency, the VendorCost field will be assumed to be in the vendor currency.

This entity field will return no information if the user account making the query does not have sufficient privileges to view cost data in the Autotask UI. Additionally, if an update request does not have the necessary permissions, the API will ignore the call's values for the field even if they are blank or would be otherwise required.

Field definitions

The following table describes the standard Autotask field objects for this entity.

  • To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
  • For information on entity UDFs, use getUDFInfo().
  • For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.

For more information about fields marked as picklists, review our Understanding picklists article.

Field Name Label Datatype Read Only Is Required Reference Name Picklist
Active Is Active boolean      
id id long    
IsDefault Is Default boolean      
ProductID Product ID integer Product  
VendorCost Vendor Cost double        
VendorID Vendor Account ID integer   Account  
VendorPartNumber Vendor Part Number string (50)