MuleSoft Connector for UPS

Build 20.0.7587

Stored Procedures

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 MuleSoft Connector for UPS 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.
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, 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, 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.
GetShippingTime Provides the average estimated time to ship a package from an origin to a destination address. This table will, at a minimum, take pertinent input information from the Shipments, Senders, and Recipients 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 TimeHistory table.
SchedulePickup Schedules a courier pickup from a specified sender's location. Input information will, at a minimum, be gathered from the Senders table. While the ConfirmationNumber is displayed immediately, this value 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 20.0.7587