CancelPickup Method

Cancels a scheduled Carrier Pickup request.

Syntax

fedexship.cancelPickup(confirmationNumber, reason, [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:

• PickupServiceType (required)
• ConfirmationNumber (required)
• ShipDate (required)
• Location (required for canceling an express pickup)
• SpecialInstructions (required for canceling ground pickup)

Valid PickupServiceType values are FDXG (FedEx Ground) or FDXE (FedEx Express).

If the information entered is valid (matches the existing record and is within the time frames available for cancellation), this method will return with no error. The return value for this method is a string containing a message from FedEx about the request to cancel the pickup, if one exists.