SchedulePickup Method
This method schedules a courier pickup.
Syntax
fedexship.schedulePickup([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
Schedules a courier pickup and returns a confirmation number for the scheduled pickup.
The following properties are applicable:
- CarrierType (required, valid values are ctFDXG (FedEx Ground) or ctFDXE (FedEx Express))
- CompanyCloseTime
- Packages (required if PackageCount is not set)
- PackageLocation
- SenderAddress1 (required when UseAccountAddress is false)
- SenderAddress2 (optional)
- SenderCity (required when UseAccountAddress is false)
- SenderState (required when UseAccountAddress is false)
- SenderZipCode (required when UseAccountAddress is false)
- SenderCountryCode (required when UseAccountAddress is false)
- SenderCompany (required when UseAccountAddress is false)
- SenderEmail (optional)
- SenderFax (optional)
- SenderFirstName (required when UseAccountAddress is false)
- SenderLastName (required when UseAccountAddress is false)
- SenderMiddleInitial (optional)
- SenderPhone (required when UseAccountAddress is false)
- ShipDate
- ShipTime
- PackageCount (optional)
- TotalWeight (required)
- SpecialInstructions (optional)
- UseAccountAddress (optional)
If the courier pickup service is available for the supplied address, the confirmation number will be returned by this method. The Location property will also be populated.
Prior to making a SchedulePickup call, it is recommended to first call the PickupAvailability method to confirm that the pickup service is available.