REST Object Definitions Inventory Related Objects Inventory Transfer Object

The inventory transfer object contains details related to transferring of inventory between two storage locations. The object identifies both the source and destination inventory storage locations, the product items and quantities transferred and any required serial numbers or batch numbers.

Each inventory transfer transaction is a one-way process, meaning inventory moves from one storage location to another. If two technicians would like to exchange multiple items between them, it will require two separate transactions.

Through the use of Flex Attributes it is possible to collect additional information or data inputs during the transfer process.

On this page:

Object Properties

Related pages:

Inventory Transfer Object Formats

JSON Format

{
    "FromStorageLocation": "", 
    "Items": [
        {
            "BatchNum": "", 
            "ProdNum": "", 
            "Qty": 0.0, 
            "SerialNum": ""
        }
    ],
    "FlexAttrs": {
        "${FlexFormID}" : {
            "${FlexAttrID}" : [
                "",
                ""
            ]
        }
    },
    "ToStorageLocation": "",
	"TransferTech": {
		"UserID": "",
		"FirstName": "",
		"LastName": ""
	}
    "TransferType": "",  
    "TransferUTC": "2013-01-01T12:00:00Z",  
    "UserID" : "",
    "ValidationCode": {
		"PublicCode": "",
		"PrivateCode": ""
	}
}

Inventory Transfer Object Properties

Required properties are in bold.

Property

Type

Description

FromStorageLocation

string

Identifies the inventory storage location where the inventory will be transferred from.

Items

collection

Identifies the list of items that were transferred.

FlexAttrs

collection

This property contains the FlexAttr values that were entered.

FlexAttrs are always associated with a FlexForm
FlexAttrs values can be pre-populated from the backend

Property

Type

Description

${FlexFormID}

object

Identifies the FlexForm

Property	Type	Description
${FlexAttrID}	array	Contains an collection of values entered for the FlexAttr field identified by ${FlexAttrID}.

ToStorageLocation

string

Identifies the inventory storage location where the inventory will be transferred to.

TransferTech

object

Identifies the other tech involved in the inventory transfer

Property	Type	Description
UserID	string	The system user id of the other tech
FirstName	string	The first name of the other tech
LastName	string	The last name of the other tech

TransferType

string

Identified the type of inventory transfer (Inbound or Outbound)

See: REST System Categories Inventory Transfer Types

TransferUTC

datetime

Identifies the date and time, in UTC format, when the inventory transfer took place.

UserID

string

Identifies the user who completed this portion of the inventory transfer process.

ValidationCode

object

Identifies the validation code that the application calculated during the inventory transfer process. This validation code is used to ensure that both parties in the transfer have entered the correct product numbers, quantities, serial numbers and batch numbers.

During the transfer half of the code is provided to the user transferring the inventory out while the other half is displayed to the user receiving the inventory. Each party must provide their half of the code to the other. Once a device has both halves the process can be completed.

Property	Type	Description
PublicCode	string	This value must be given to the other tech for validation
PrivateCode	string	The other tech's PublicCode must match this code