Products

This entity describes an instance of hardware, software, or a material item in Autotask that a company sells or supports for customers. You can "install" Products to customer Companies and once installed, users can support Products through Service Desk tickets, bill for products, and manage the products through the customer Company. With the Autotask Inventory module, Products can be added to inventory as Inventory Items.

In Autotask, Administrators manage Products through the Admin module: Products and Services > Products > Products. If the Inventory module is enabled, users with the correct permission can manage Products through Inventory > Manage Products.

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: Products

Entity Path:

/atservicesrest/v1.0/Products
Can Create:
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:

IMPORTANT  Requests to this entity require special handling. Refer to the Entity URLs and relationships section of this article for details.

Parent None
Children ProductNotes ProductTiers, ProductVendors
URLs Products​/query (GET, POST)
Products​/{id} (GET)
Products​/query​/count (GET, POST)
Products (PUT, POST, PATCH)
Products​/entityInformation (GET)
Products​/entityInformation​/fields (GET)
Products​/entityInformation​/userDefinedFields (GET)

Conditions and requirements

General

  • The Product entity can have no more than 100 UDFs. Refer to UserDefinedFieldDefinitions.
  • System products cannot be updated.
  • 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 Inventory module access (site installed module access only))

Special field attributes

Field Conditions and Requirements

billingType

 

  • If no value is provided, this field will default to Standard.

  • You cannot create more than 100 products with a billing type of "Per Contact" or 100 products with a billing type of "Per Asset."
  • periodType must be Monthly if supplying a billingType not equal to Standard.
  • priceCostMethod must be equal to Standard (Flat) if the billingType is equal to Standard.

doesNotRequireProcurement

 
  • The default value for doesNotRequireProcurement = False.
  • doesNotRequireProcurement must be equal to true if billingType is not equal to standard.
isSerialized

  • isSerialized must be equal to false if billingType is not equal to Standard.

  • The API will return an error if it receives a request to change this value when there is existing inventory.

priceCostMethod

 
  • If no value is provided, this field will default to Standard.
  • If the product's Price/Cost Method is Standard, Product Tiers cannot be created.

unitCost

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.
unitCost, unitPrice, mSRP, and markupRate The unitCost, unitPrice, mSRP, and markupRate fields will only be updated if the priceCostMethod = Standard. Otherwise, they will be null.

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
billingType integer    
chargeBillingCodeID integer     BillingCodes  
createdByResourceID integer   Resources  
createdTime datetime      

defaultInstalledProductCategoryID

integer

 

 

ConfigurationItemCategories

 
defaultVendorID integer     Companies  
description string (8000)        
doesNotRequireProcurement boolean        
externalProductID string (50)        
id long    
impersonatorCreatorResourceID integer   Resources

 
InternalProductID string (50)        
isActive boolean      

isEligibleForRma

boolean

 

 

 

 
isSerialized boolean      
link string (500)        
manufacturerName string (100)        
manufacturerProductName string (50)        
markupRate decimal      
mSRP decimal        
name string (1000)      
periodType integer      
priceCostMethod integer    
productBillingCodeID integer   BillingCodes  
productCategory integer      
sKU string (50)        
unitCost decimal        
unitPrice decimal        
vendorProductNumber string (50)        

Additional resources