OverSeasLegLength Property

The length of the shipment.

Syntax

 upsfreightship.getOverSeasLegLength([callback])
 upsfreightship.setOverSeasLegLength( overSeasLegLength, [callback])

Default Value

0

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 getOverSeasLegLength([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 setOverSeasLegLength([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 length of the shipment. For shipments with destinations of Hawaii, Alaska or Puerto Rico, you must specify this property or the TotalShipmentCubicFeet before shipping.

Data Type

Integer