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

Stored Procedures

CData BizTalk Adapter for FedEx 2019 - Build 19.0.7354

Stored procedures are available to complement the data available from the Data Model. It may be necessary to update data available from a view using a stored procedure because the data does not provide for direct, table-like, two-way updates. In these situations, the retrieval of the data is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures take a list of parameters and return back a dataset that contains the collection of tuples that constitute the response.

CData BizTalk Adapter for FedEx 2019 Stored Procedures

Name Description
CalculateRates Returns rate information for a specified service or all services. This table will, at a minimum, take pertinent input information from the Shipments, Senders, Recipients, and Packages tables. The information it fetches from these tables will depend on the provided ShipmentId. The output will be a result set of individual services that will all be automatically inserted into the RateHistory table.
CancelPackage Cancels an individual package, as specified by its tracking number. This procedure also has the side effect of deleting the corresponding record from the LabelHistory table.
CancelPickup Cancels a requested pickup. The pickup in question is specified by its ConfirmationNumber. Other input information that is related to the pickup will be fetched from the corresponding record in the Pickups table. A side effect of this procedure is that the pertinent record will be deleted from the Pickups table.
CancelShipment Cancels an entire multi-package shipment, as specified by the master tracking number. This procedure also has the side effect of deleting the corresponding records from the LabelHistory table.
FaxProofOfDelivery Faxes SPOD to the appropriate notification target. The notification target's information will be acquired from the Contacts table as input, specified by the ContactId. The SPOD will apply to the specified tracking number.
GenerateLabels Generates a shipping label for each package in a given shipment. This table will, at a minimum, take pertinent input information from the Shipments, Senders, Recipients, and Packages tables. Depending on the ShipmentId provided, the Payors, Brokers, CommercialInvoices, and Commodities tables may be examined as well. The output will be a result set of pertinent label information across multiple records. Each record will be automatically inserted into the LabelHistory table.
GenerateReturnLabels Generates a shipping label for each package in a given shipment. This table will, at a minimum, take pertinent input information from the Shipments, Senders, Recipients, and Packages tables. Depending on the ShipmentId provided, the Payors, Brokers, CommercialInvoices, and Commodities tables may be examined as well. The output will be a result set of pertinent label information across multiple records. Each record will be automatically inserted into the LabelHistory table. Unlike GenerateLabels, this procedure will reverse the Sender and Recipient when creating the label.
PickupAvailability Checks availability for courier dispatch service for an address. This should be used prior to executing SchedulePickup in order to ensure the service will be available. The output values are not stored internally.
RequestEmailNotification Requests email notification for a list of recipient contacts regarding a shipment's events. The shipment in question is specified by TrackingNumber.
SaveProofOfDelivery Save SPOD to a specified file location. The SPOD will apply to the specified tracking number.
SchedulePickup 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.
TrackShipment Returns tracking data for requested idValue of IdentifierType type. This procedure does not need to fetch input from your tables. Its output is a result set containing track event records. Each record will automatically be inserted into the TrackHistory table.

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