SchedulePickup Method

This method schedules a courier pickup.

Syntax

fedexfreightship.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:

• ApprovedByCompany (optional)
• ApprovedByEmail (optional)
• ApprovedByFax (optional)
• ApprovedByFirstName (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• ApprovedByLastName (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• ApprovedByMiddleInitial (optional)
• ApprovedByPhone (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• BookingNumber (required when ServiceType is set to stFedEx1DayFreight, stFedExInternationalPriorityFreight, or stFedExInternationalEconomyFreight)
• CarrierType (required, should be set to ctFXFR only if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority, otherwise should be set to ctFDXE.)
• CommodityFreightPackagingType (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• CommodityWeight (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• CommodityHandlingUnits (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• CommodityPONumber (optional, only applies if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• CompanyCloseTime (required)
• PackageLocation (required)
• Packages (optional)
• PackageCount (required if Packages are not provided)
• PickupPaymentType (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• RecipientAddress1 (optional)
• RecipientAddress2 (optional)
• RecipientCity(required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• RecipientState(required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• RecipientZipCode(required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• RecipientCountryCode (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• 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)
• ServiceType (required)
• ShipDate (required)
• ShipTime (optional)
• SpecialInstructions (optional)
• SubmittedByCompany (optional)
• SubmittedByEmail (optional)
• SubmittedByFax (optional)
• SubmittedByFirstName (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• SubmittedByLastName (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• SubmittedByMiddleInitial (optional)
• SubmittedByPhone (required if ServiceType is set to stFedExFreightEconomy or stFedExFreightPriority)
• TotalWeight (required)
• TruckType (required when ServiceType is set to an Express Freight type, such as stFedEx1DayFreight, stFedEx2DayFreight, stFedEx3DayFreight, stFedExFirstFreight, stFedExInternationalPriorityFreight, or stFedExInternationalEconomyFreight)
• TrailerSize (required when ServiceType is set to an Express Freight type, such as stFedEx1DayFreight, stFedEx2DayFreight, stFedEx3DayFreight, stFedExFirstFreight, stFedExInternationalPriorityFreight, or stFedExInternationalEconomyFreight)
• 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.