REST Object Definitions Inventory Related Objects Storage Location Object

The Storage Location object contains managed inventory items. Storage locations are assigned to technician's and usually refer to their vehicle inventory. Storage locations can also be assigned to an account location which then allows for managing inventory at a customer location. A good example of customer managed inventory would be printer toner, air filters, water bottles, etc.

Once a storage location is initially created and assigned, this API should no longer be used to manage it. Instead is should be managed with the Inventory Load and Physical Inventory Count APIs. The reason is because this API represents a complete replacement of the storage location object and because a technician may have just consumed inventory which has not been upload to the system yet, replacing it could immediately cause the counts to be out of sync.

A storage location can only be assigned to a single technician or account location at a time.

On this page:

Storage Location Object Formats

JSON Format

 {
	"ModifiedUTC": "2013-01-01T12:00:00.000Z",
	"StorageLocationID": "",
	"StorageLocationType": "",
	"Address": {
		"AddrLine1": "",
		"AddrLine2": "",
		"AddrLine3": "",
		"AddrLine4": "",
		"AddrType": "",
		"City": "",
		"Country": "",
		"Intersection": "",
		"Lat": "",
		"Lon": "",
		"Region": "",
		"Zip": ""
	},
	"Contacts": [{
		"Email": "",
		"FirstName": "",
		"IsPrimary": true,
		"LastName": "",
		"Phones": [{
			"PhoneNum": "",
			"PhoneType": ""
		}]
	}],
	"Items": [{
		"ProdNum": "",
		"BatchNum": "",
		"DamagedQty": 0.0,
		"Deleted": false,
		"Qty": 0.0,
		"SerialNum": "",
		"ProdAttrs": {
			"Desc": "",
			"IsBatch": false,
			"IsInvCtrl": false,
			"IsSerialized": false
		}
	}],
	"Name": ""
}

Storage Location Object Properties

Required properties are in bold.

Property

Type

Description

Address

object

The address details for the warehouse (StorageLocationType = 1002). This is a required field when storage location is type of warehouse

See: REST Object Definitions Account Location Related Objects Address Object

Contacts

collection

A collection of contacts for the warehouse

See: REST Object Definitions Account Location Related Objects Contact Object

Name

string

Identifies the name of the warehouse. This is a required field when storage location is type of warehouse

Items

collection

A collection of items that are in the current storage location.

See: REST Object Definitions Inventory Related Objects Item Object

ModifiedUTC

datetime

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

StorageLocationType

string

Contains a Storage Location Type System Category value identifying the type of storage location.

Valid values are:

Codes

Activity Code

Reserved

Description

1001

Yes

Vehicle.

Identifies the storage location as a vehicle.

1002

Yes

Warehouse.

Identifies the storage location as a warehouse.

StorageLocationID

string

The unique storage location identifier.