Machinable Property

Indicates if the package being shipped is classified as machinable.

Syntax

 uspsrates.getMachinable([callback])
 uspsrates.setMachinable( machinable, [callback])

Default Value

TRUE

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 getMachinable([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 setMachinable([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 value of this property is optional to be provided when GetRates is called.

This property applies only to Parcel Post and First Class Mail. (Machinable criteria do not apply to Priority Mail, Express Mail, Bound Printed Matter, Library Mail, or Media Mail). The size, content, and weight of a Parcel Post package determine whether it is machinable or non-machinable. Characteristics of machinable mail are listed below:

A parcel is machinable when it:

• Not less than 6" long, 3" high, 0.25" thick, and 6 ounces in weight.
• Not more than 34" long, 17" high, 17" thick, or 35 lbs in weight. For books or other printed matter, the maximum weight is 25 lbs.

A letter-sized piece is not machinable if it has one or more of the following characteristics:

• Has an aspect ratio (length divided by height) of less than 1.3 or more than 2.5.
• Is polybagged, polywrapped, or enclosed in any plastic material.
• Has clasps, strings, buttons, or similar closure devices.
• Contains items such as pens, pencils, or loose keys or coins that cause the thickness of the mailpiece to be uneven.
• Is too rigid (does not bend easily when subjected to a transport belt tension of 40 lbs around an 11" diameter turn).
• For pieces more than 4.25" high or 6" long, the thickness is less than 0.009".
• Has a delivery address parallel to the shorter dimension of the mailpiece.
• Is a self-mailer with a folded edge perpendicular to the address.
• Booklet-type pieces with the bound edge (spine) along the shorter dimension of the piece or at the top.

A flat (large envelope) is always machinable so long as it meets the criteria for being a flat. (See the PackageType property for more information).

This property can also be specified on service type "ALL", but it will only apply to the Parcel Post rate. Even if Machinable is True, if the weight or dimension requirements exceed the limitations above, USPS will automatically return rates that include the non-machinable surcharge.

Data Type

Boolean