ProductVendors

This entity describes a Vendor type Company 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.

NOTE  You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.

Entity details

Entity Name: ProductVendors

Entity Path:

/atservicesrest/v1.0/ProductVendors

Parent Entity:

Products

Can Create:
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:  

Conditions and requirements

General

The REST API productVendor entity displays the following behaviors.

  • To query, you must have View permission and (Admin > Products OR Inventory module access (site installed module access only))
  • To create or 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.isActive 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 fields for this entity. Refer to the following articles for more information about working with these fields:

To learn how to query picklist endpoints, refer to Understanding picklists.

Notes

  • For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.
  • If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
  • You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
Field Name Datatype Read-Only Is Required Reference Name Picklist
id long    
isActive boolean      
isDefault boolean      
productID integer Products  
vendorCost decimal        
vendorID integer   Companies  
vendorPartNumber string (50)        

Additional resources