SchedulePickup Method

Schedules a Carrier Pickup and provides the user a confirmation number for the scheduled pickup.

Syntax

 char* SchedulePickup();

Remarks

This method allows users to make a Carrier Pickup request.

The SchedulePickup method requires the values for the following properties:

• SenderFirstName (required)
• SenderLastName (required)
• SenderCompany (optional)
• SenderAddress1 (required)
• SenderAddress2 (optional)
• SenderCity (required)
• SenderState (required)
• SenderZipCode(required)
• SenderPhone (required)
• TotalWeight (required)
• CountExpress (optional if CountPriority is provided)
• CountPriority (optional if CountExpress is provided)
• CountInternational (optional)
• CountOther (optional)
• PackageLocation (required)
• SpecialInstructions (optional)

After a successful request, the above properties will show a standardized address, as returned from the USPS server. If the Carrier Pickup service is available to the supplied address, the following properties will also be returned. These properties indicate the earliest available pickup date and the carrier route that will be picking up your

• ShipDate
• CarrierRoute

Prior to making a SchedulePickup call, it is recommended to first call the PickupAvailability method to confirm that the pickup service is available.

There must be at least one Express Mail Package or Priority Mail package to make this call a valid request. Either one of the CountPriority, CountExpress, CountInternational or CountOther properties are required for a valid request.

The Confirmation Number will be returned after a successful request.