AddressServiceRequest Property

Indicates if an address service request is made.

Syntax

 uspsship.getAddressServiceRequest([callback])
 uspsship.setAddressServiceRequest( addressServiceRequest, [callback])

Default Value

FALSE

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 getAddressServiceRequest([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 setAddressServiceRequest([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. False is assumed if no value is entered.

By setting this property to True, you can request the USPS to alert you when a customer changes their address. This feature is especially useful to ensure correct billing. The words "Address Service Requested" will appear on the shipping label immediately below the return address.

By using this option, you will receive the following service with Priority Mail:

For 12 months after an address change, the mail piece is forwarded at no charge. However, a separate notice of the new address is returned to you and an address correction fee is charged.
For 13-18 months after an address change, the mail piece is returned with the new address attached at no charge.
After 18 months, or if undeliverable, the mail piece is returned with the reason for nondelivery attached at no charge.

This service is not available when LabelOption is set to 2 or 4.

Data Type

Boolean