CancelPickup Method

Cancels a scheduled Carrier Pickup request.

Syntax

uspsship.cancelPickup(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 CancelPickup method is called, the exact data from the original SchedulePickup request must be entered.

You must enter the following information:

• ConfirmationNumber (required)
• SenderCompany (optional)
• SenderAddress1 (required)
• SenderAddress2 (optional)
• SenderCity (required)
• SenderState (required)
• SenderZipCode(required)

The confirmation number alone cannot be used to cancel or change a scheduled pickup. You must also supply address information that is identical to what was originally entered when the pickup was scheduled with SchedulePickup.

If the information entered is valid (matches the existing record and is within the time frames available for cancellation), this method fills the original pickup address and tracking number as well as the Status property.

You may submit your cancellation 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 canceled online.

If you miss the deadline for canceling your pickup, or if you did not save the ConfirmationNumber or address information, you should put a note at the PackageLocation you specified in the original SchedulePickup request explaining that you wish to cancel the pickup.

The return value for this method is a string containing the status of the cancellation.