REST Object Definitions Inventory Related Objects Inventory Load Object

Inventory Load Object Formats

JSON Format

{
    "CreatedUTC": "2013-01-01 12:00:00Z", 
    "Description": "", 
	"DueDateUTC": "2013-01-01 12:00:00Z", 
    "Items": [
        {
            "BatchNum": "", 
            "OriginalQty": 1.0, 
            "ProdAttrs": {
                "IsBatch": false, 
                "IsInvCtrl" : false,
                "IsSerialized": false, 
                "Desc": ""
            }, 
            "ProdNum": "", 
            "Qty": 1.0, 
            "SerialNum": ""
        }, 
    ], 
    "ExpectedDeliveryUTC": "2013-01-01 12:00:00Z", 
    "LoadNum": "", 
    "LoadType": "", 
    "ModifiedUTC" : "2013-01-01 12:00:00Z",
    "Status": "", 
    "StorageLocationID": "", 
	"TechCreated": false,
    "XRef": ""
}

Inventory Load Object Properties

Required properties are in bold.

Property Type Description

CreatedUTC datetime The date and time, in UTC format, the load request was originally created.

Description string Detailed description of the load, possibly including the location of where the load is to be picked up.

DueDateUTC

datetime

The date and time, in UTC format, before which the mobile worker is required to accept/receive pending load.

3.41.0

ExpectedDeliveryUTC datetime The date and time, in UTC format, of when the load is expected to be delivered.

Items collection Identifies the product items and quantities that are in the load and to be added to the specified storage location's inventory.

LoadNum string The unique load number that identifies this load.

LoadType

string

Identifies the type of load.

Valid values are:

Value	Description
1001	Standard vehicle inventory load.
1002	Automatic inventory adjustment load. When a mobile device receives a load of this type the vehicle inventory inventory is automatically adjusted based on the values in the object - no technician intervention is required.
1003	Customer consignment load. This type of load is used to inform the technician of the inventory available at a customer location they are expected to visit.

ModifiedUTC datetime The date and time, in UTC format, when this object was last modified.

Status

string

The current status of the load.

Valid values are:

1001 - The load has not yet been received into inventory
1002 - The load has been received and the storage locations inventory adjusted

StorageLocationID string Identifies the storage location where the inventory load is to be applied to.

TechCreated

boolean

Specifies if the mobile worker created the load.

Valid values are:

false = Indicates that the load was created in the back office. This is the default value if this property is not specified.
true = The mobile worker created the load from the mobile application.

3.41.0

XRef string This property holds an optional Customer defined cross reference values. This property can be used to associate the load with another object withing the Customer's backend system.