PickupAvailability Method

Checks the availability of a Carrier Pickup service for the given address.

Syntax

uspsship.pickupAvailability([callback])

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 this 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 PickupAvailability method requires the values for the following properties:

• SenderCompany (optional)
• SenderAddress1 (required)
• SenderAddress2 (optional)
• SenderCity (required)
• SenderState (required)
• SenderZipCode (either the ZipCode or City and State are required)

After a successful request, the above properties will show a standardized address, as returned from the USPS server. If the Carrier Pickup service is available to the supplied address, the following properties will also be returned. These properties indicate the earliest available pickup date and the carrier route that will be picking up your packages:

• ShipDate
• CarrierRoute