OverSeasLegWidth Property

The width of the shipment.

Syntax

 upsfreightrates.getOverSeasLegWidth([callback])
 upsfreightrates.setOverSeasLegWidth( overSeasLegWidth, [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 getOverSeasLegWidth([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 setOverSeasLegWidth([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 width 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