ChangePickup Method

Changes requested data in your original Pickup Schedule request and schedules a new pickup.

Syntax

uspsship.changePickup(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, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

When the ChangePickup method is called, the exact data from the original SchedulePickup request must be entered, with whatever changes you wish to enter. It is recommended that you first send a PickupInquiry to fill all the properties, edit the property you wish to change, and then submit a ChangePickup request.

At the minimum, you must enter the pickup address information, number of packages for the service requested, estimated weight, package location, weight, special pickup instructions and confirmation number. The confirmation number alone cannot be used to cancel or change a scheduled pickup.

The name and phone number of the sender can be changed, along with the number and types of package services, weight, and the location of the pickup.

Address data and the confirmation number cannot be changed and must be identical to the original SchedulePickup request (supplied to and returned by SchedulePickup method when first called).

After a successful call, this method fills the following properties:

ConfirmationNumber (required)
SenderFirstName (required)
SenderLastName (required)
SenderCompany (optional)
SenderAddress1 (required)
SenderAddress2 (optional)
SenderCity (required)
SenderState (required)
SenderZipCode(required)
SenderPhone (optional)
TotalWeight (required - value may be changed from the original request)
CountExpress (optional if CountPriority is provided - value may be changed from the original request)
CountPriority (optional if CountExpress is provided - value may be changed from the original request)
CountInternational (optional - value may be changed from the original request)
CountOther (optional - value may be changed from the original request)
PackageLocation (required - value may be changed from the original request)
SpecialInstructions (optional - value may be changed from the original request)

To verify the accuracy of your data, you can call the PickupInquiry method. However, the confirmation number cannot be retrieved online. If you need to change or cancel your Carrier Pickup request, please leave notification (at the Package Location you indicated in your Carrier Pickup request) that provides details of your Carrier Pickup change or cancellation.

If the information entered is valid (matches the existing record and is within the time frames available for pickup change), this method will return the Status of the request and fill the sender's information and pickup address (properties listed above), and also the following properties:

You may submit your changes to your pickup request anytime before 2:00 AM CST on the day of pickup to take effect. Otherwise, your Carrier Pickup request cannot be changed online.