InventoryItemSerialNumbers
This entity describes a serial number associated with an Inventory Item. It allows users to track and manage Inventory Items created from serialized Products, that is, Autotask Products that require a unique serial number. An InventoryItemSerialNumbers entity can be associated with only one InventoryItem.
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: | InventoryItemSerialNumbers |
Entity Path: |
/atservicesrest/v1.0/InventoryItemSerialNumbers |
Parent Entity: |
|
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: |
Conditions and requirements
General
- Inventory Add/Edit Items permission is required to create or update an InventoryItemSerialNumber.
- 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 |
---|---|
inventoryItemID | inventoryItemID must reference an InventoryItem based on a serialized Product; that is, InventoryItem.productID must reference a Product where isSerialized = True. |
serialNumber |
For create and update, serialNumber must be unique. serialNumber cannot be updated if the inventoryItemID is associated with an InventoryItem that has been picked or delivered/shipped. |
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 | ||||
inventoryItemID | integer | InventoryItems | |||
serialNumber | string (100) |