CData BizTalk Adapter for FedEx 2019 - Online Help
Questions / Feedback?

SchedulePickup

CData BizTalk Adapter for FedEx 2019 - Build 19.0.7354

Schedules a courier pickup from a specified sender's location. Input information will, at a minimum, be gathered from the Senders and Packages tables. Depending on user input, the procedure may fetch information from the Recipients and Commodities tables as well. While the ConfirmationNumber and Location are displayed immediately, these two values will be inserted alongside other pertinent values in the Pickups table automatically.

Procedure Specific Information

The stored procedure will examine the following tables for input:

  • Senders
  • Packages
  • Recipients (Freight only)
  • Commodities (Freight only)

The stored procedure will add its output as records to the following table:

  • Pickups

Execute

In order to execute this procedure, one must specify SenderId, and PackageId. See the example below:

EXECUTE SchedulePickup SenderId = 3, PackageId = '9,13,17'

Input

Name Type Description
IsExpress Boolean Whether a standard pickup will use the express service.

The default value is true.

PackageId String Comma-separated list of PackedgeIds to be picked up.
PackagingType String Type of package as enumerated. The specified type will be applied to all Packages in the shipment.

The allowed values are LETTER, PAK, BOX, 10KGBOX, 25KGBOX, TUBE, YOURPACKAGING, SMALLBOX, MEDIUMBOX, LARGEBOX, VERYLARGEBOX.

The default value is LETTER.

ShipDate Date Date when package will be tendered. This value should be in the format (yyyy-MM-dd).
ShipTime Time Time when package will be tendered. This value should be in the format (hh:mm:ss).
SenderId Integer Identifier for the Sender requesting pickup.
SpecialInstructions String Special instructions for the pickup.
CompanyCloseTime Time Time in which the sender's company closes. This value should be in the format (hh:mm:ss).
ServiceType String Type of service for the shipment as enumerated. Required as one of the Freight values for freight pickups.

The allowed values are Unspecified, Priority_Overnight, Standard_Overnight, First_Overnight, FedEx_2_Day, Express_Saver, FedEx_Ground, FedEx_Ground_Home_Delivery, FedEx_1_Day_Freight, FedEx_2_Day_Freight, FedEx_3_Day_Freight, International_Priority, FedEx_2_Day_AM, International_Economy, First_Freight, International_First, International_Priority_Freight, International_Economy_Freight, Smart_Post, Europe_First_International_Priority, International_Ground, Freight_Economy, Freight_Priority.

RecipeintId Integer Identifier for the Recipient to receive packages. Required for freight only if ServiceType is Freight_Economy or Freight_Priority.
ApprovedById Integer Identifier for the party who approved the pickup (among SenderIds). Required for freight only if ServiceType is Freight_Economy or Freight_Priority.
SubmittedById Integer Identifier for the party who submitted the pickup (among SenderIds). Required for freight only if ServiceType is Freight_Economy or Freight_Priority.
CommodityId String Comma-separated list of CommodityIds that are to be handled. Required for freight only if ServiceType is Freight_Economy or Freight_Priority.
IsConsignee Boolean Whether the party submitting the transaction is a consignee.
TotalLength Integer Total length of shipment. Required for freight only if ServiceType is set to one of the following: FedEx_1_Day_Freight, FedEx_2_Day_Freight, FedEx_3_Day_Freight, First_Freight, International_Priority_Freight, International_Economy_Freight
TotalWidth Integer Total width of shipment. Required for freight only if ServiceType is set to one of the following: FedEx_1_Day_Freight, FedEx_2_Day_Freight, FedEx_3_Day_Freight, First_Freight, International_Priority_Freight, International_Economy_Freight
TotalLength Integer Total height of shipment. Required for freight only if ServiceType is set to one of the following: FedEx_1_Day_Freight, FedEx_2_Day_Freight, FedEx_3_Day_Freight, First_Freight, International_Priority_Freight, International_Economy_Freight
TruckType String Type of truck as enumerated.

The allowed values are DropTrailerAgreement, LiftGate, TractorTrailerAccess.

TrailerSize String Trailer size as enumerated.

The allowed values are 28ft, 48ft, 53ft.

BookingNumber String Booking confirmation number. Required for freight only if ServiceType is International_Priority_Freight or International_Economy_Freight.
PaymentType String Payment type for pickup as enumerated.

The allowed values are Sender, Recipient, ThirdParty, Collect, Account, Cash, CreditCard.

Result Set Columns

Name Type Description
PickupId Integer Identifier for the pickup request.
ConfirmationNumber String Confirmation number for the pickup request.
Location String Identifier of the FedEx location to pick up the package.
CompanyCloseTime String The closing time for your company.
CarrierType String Carrier type as enumerated.
SenderId String Identifier of the sender requesting the pickup.
ShipDate Datetime Date that the package will be tendered to FedEx.
SpecialInstructions String Any additional remarks or instructions.

 
 
Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 19.0.7354.0