HandlingUnit Property

Describe the Handling Units (Movable Pieces) in this Shipment.

Syntax

 upsfreightship.getHandlingUnit([callback])
 upsfreightship.setHandlingUnit( handlingUnit, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getHandlingUnit([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setHandlingUnit([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The first 4 codes are valid for handling unit one and the last two are valid for handling unit two. The type and value pair(s) should be entered as a string in this format: 'type1:value1; type2:value2'. For example: SKID:1; OTHER:1'.

Data Type

String