GetRates Method

Returns rate information for a specified or all available UPS RequestedService s.

Syntax

[VB.NET]
Public Sub GetRates()

[C#]
public void GetRates();

Remarks

To get the courtesy rate quotes for UPS services, you can call the GetRates method. If rates are needed for a specific service type, you will have to set the RequestedService to the value you need the rates for (other than 0 : stUnspecified). The RequestedService identifies the UPS service for which you want to retrieve rate information.

If the rates are wanted for all available UPS services, you should set the RequestedService to 0 (stUnspecified). Following validation, the UPSRates identifies and rates all available services. The server response will include a list of services, their associated rate, and guaranteed delivery time, if available.

In either case, the following properties or config settings are sent in the request (if any of these have not been set, their default values will be used instead):

• Server (required)
• AccessKey (required)
• UserId (required)
• Password (required)
• AccountNumber (required only when requesting to receive negotiated rates; otherwise optional)
• RequestedService (required)
• PickupType (required)
• CustomerType (required)
• SenderAddress(required)
• RecipientAddress (required)
• Packages (required)
• WeightUnit (optional)
• CurrencyCode (optional)

Returned values upon a successful reply are:

• Services

If there is a problem with any of the input values within the request, the response will either raise an error (when it's an hard error) and transaction will fail, or give a warning (when it's a soft error), which can be accessed via Warning, and the transaction will go through.

For more details on errors codes and descriptions, please refer to the Error Messages section.