InventoryLocations
This entity describes an Autotask Inventory location, that is, a physical or virtual place where your company stores or assigns inventory items. For example, an Inventory location can be an actual warehouse or retail outlet, or a virtual holding place such as "Lost Items" or "Returned Items." Every Inventory Item must be associated with an Inventory location. You assign a location to Inventory Items when you add the items to inventory or to a purchase order.
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: | InventoryLocations |
Entity Path: |
/atservicesrest/v1.0/InventoryLocations |
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: |
Conditions and requirements
General
- Inventory Manage Locations permission is required to create, update, or query an Inventory location.
- To query, you must have View permission and Inventory access (site installed module access and security level feature or section access)
- To create or update, you must have View and Create permission and Inventory access (site installed module access and security level feature or section access)
Special field attributes
Field | Conditions and Requirements |
---|---|
InventoryLocation | The InventoryLocation where isDefault = True cannot be inactivated. |
locationName | locationName must be unique. |
resourceID | If resourceID has a value, isDefault cannot = True. |
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:
- The entityInformation REST API call
- Making basic query calls to the REST API
- Advanced query features of the REST API
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 | ||||
impersonatorCreatorResourceID | integer | Resources |
|
||
isActive | boolean | ||||
isDefault | boolean | ||||
locationName | string (50) | ||||
resourceID | integer | Resources |