PickupInquiry Method

Retrieves the data submitted in your original SchedulePickup request.

Syntax

uspsship.pickupInquiry(confirmationNumber, [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

This method requires: the exact pickup address and confirmation number returned in the SchedulePickup request (when the SchedulePickup method was called). This method will fill the following properties:

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

On valid request, returns the information that was originally entered in SchedulePickup call: the sender's information and pickup address (properties listed above) and also the following:

• TotalWeight
• CountExpress
• CountPriority
• CountInternational
• CountOther
• ShipDate
• ConfirmationNumber
• PackageLocation
• SpecialInstructions

The PickupInquiry method is very useful for the ChangePickup request. PickupInquiry will retrieve the data from your original request, and you can then change whatever properties you like and then call ChangePickup.