SchedulePickup Method
Schedules a pickup.
Syntax
upsshipintl.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
When called, this will request an OnCall Pickup from UPS and return the Pickup Confirmation Number.
The valid properties when calling this method are as follows:
- PickupEarliestTime (Required)
- PickupLatestTime (Required)
- SenderFirstName (Optional, required if Company is not provided)
- SenderLastName (Optional, required if Company is not provided)
- SenderCompany (Optional, required if FirstName and/or LastName are not provided)
- SenderPhone (Required)
- SenderAddress1 (Required)
- PickupFloorNumber (Optional)
- PickupRoomNumber (Optional)
- SenderCity (Required)
- SenderState (Required, optional if outside US and Canada)
- SenderZipCode (Required)
- SenderCountryCode (Required)
- ShipDate (Required)
Please note that only SenderAddress1 is valid as the request only allows one address line.