4D Shipping SDK 2020 .NET Edition
4D Shipping SDK 2020 .NET Edition
Questions / Feedback?

UPSRates Component

Properties   Methods   Events   Configuration Settings   Errors  

Provides domestic or international rates based on weight, service, and origin/destination information.




Rates component provides automated online access to domestic and international rate information and is capable also of rating shipments containing multiple packages. Based on the shipment's input characteristics (origin, destination, shipment weight, special services, etc.), the component provides a list of all applicable UPS services and their respective published rates.

For all shipments inside or between the U.S. and Puerto Rico:

The request that is sent to UPS Server must provide details at the package level. For shipments consisting of only one package, the component identifies all the available UPS domestic and international services and returns shipping rates based on the package's specifications. If the shipment consists of two or more packages, the component will return a separate rate for each package and the rate for the total shipment. The total shipment rate will be a sum of the rates for all packages.

For all shipments outside the U.S. and Puerto Rico:

The request must provide details at the shipment level. For shipments consisting of one or more packages, the component will return one rate for all packages at the shipment level (not at the package level).

To retrieve a list of rates for all services applicable to your shipment, the RequestedService must be set to 0 (stUnspecified) when calling GetRates method. To get a rate for a specified service, the RequestedService must be set to the corresponding value of the UPS service to be rated (other than 0: stUnspecified).

In either scenario, UPS server response will contain negotiated rate(s) only for the qualified AccountNumbers. Eligibility is determined using the combination of UserId and AccountNumber. If the user is authorized for negotiated rates, and if negotiated rates apply to the particular service, UPS returns those rates along with the published rates in its response. Otherwise, a warning message might be returned that indicates ineligibility and only the published rates are returned in the response. For more information on negotiated rates, including authorization to receive them, please check with your UPS account representative.

Please note that shipping rates retrieved by this component are estimates based on the information supplied. Other shipping charges may apply and the final shipping charge may differ depending upon your UPS Account Number and how the package is tendered to UPS.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

AccountAddressIdentifies the UPS account holder's address, if different from the sender's address.
CODTotalAmountThe total amount to be collected on shipment level.
CODTypeThe code that indicates the type of funds that will be used for the COD payment.
CustomerTypeCustomer classification code.
DisclaimerDisclaimer text.
DutyTypeAuto duty type applicable for requests outside the US.
FirewallA set of properties related to firewall access.
PackagesA collection of packages contained in the shipment.
PackageServiceIndexThe service index in the list of available services returned.
PickupTypePickup type used for the shipment that rate is requested for.
ProxyA set of properties related to proxy access.
RecipientAddressIdentifies the recipient's address.
RecipientCandidateAggregateString representing the list of destination address candidates (if any).
RequestedServiceService type for which the shipping rate is requested.
SenderAddressIdentifies the sender's address from which the shipment is originating.
SenderCandidateAggregateString representing the list of origin address candidates (if any).
ServicesCollection of available services returned.
ShipDateThe date the user requests UPS to pickup the package from the origin.
ShipmentSpecialServicesContains the collection of special services offered by UPS on shipment level.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TimeoutA timeout for the component.
TotalValueMonetary value of shipment contents.
TotalWeightTotal shipment's weight.
UPSAccountLogin information for UPS.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting .
GetRatesReturns rate information for a specified or all available UPS RequestedService s.
GetShippingTimeProvides the average estimated time to ship a package from an origin to a destination address.
ResetResets the internal state of the component and all properties to their default values.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.
NotificationNotification returned by the server upon successful request (if applicable).
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.

RawRequestContains the complete request sent to the Server.
RawResponseContains the complete response returned by the Server.
XPathUsed to set the XPath within the response from the server.
HasXPathDetermines whether a specific element exists in the document.
XParentThe parent of the current element.
XElementThe name of the current element.
XTextThe text of the current element.
XChildCountThe number of records in the XChild arrays.
XChildElement[i]The name of the indexed child element.
XChildText[i]The text of the indexed child element.
XAttrCountThe number of records in the XAttr arrays.
XAttrName[i]The name of the indexed attribute.
XAttrValue[i]The value of the indexed attribute.
WarningWarning message returned by the server.
AlternateDeliveryAddressUsed to specify an XML or SOAP aggregate for Hold for Pickup or Delivery at UPS Access Points.
IncludeNegotiatedRatesWhether to include the NegotiatedRatesIndicator in the request.
ShipmentIndicationTypeWhether shipment is Hold For Pickup or Delivery at UPS Access Points.
NotificationLanguageUsed to specify the language for Alternate Delivery Location notifications and UAP Shipper notifications.
NotificationDialectUsed to specify the dialect for Alternate Delivery Location notifications and UAP Shipper notifications.
ItemizedChargesCountThe count of itemized charges.
ItemizedChargesCode[i]The Accesorial/Surcharge code of the itemized charge.
ItemizedChargesCurrencyCode[i]The currency used for the charge.
ItemizedChargesMonetaryValue[i]The amount being charged.
ItemizedChargesSubType[i]The subtype of the itemized charge.
SubVersionUPS SubVersion.
TaxInformationIndicatorControls whether to send a TaxInformationIndicator.
UseSOAPWhether or not to use UPS' webservices.
ReturnFreightPricesWhen true, UPS will use applicable freight pricing for shipments.
FRSCommodityCountNumber of commodities in the shipment.
FRSCommodityFreightClass[i]The freight class of the commodity at the index.
FRSCommodityFreightNMFC[i]The National Motor Freight Classification numbers for the commodity at the index.
FRSCommodityFreightNMFCSub[i]The sub-code of National Motor Freight Classification numbers for the commodity at the index.
FRSPaymentTypeMethod of payment for the shipment.
FRSPaymentDescriptionDescription for the Ground Freight Pricing payment type.
FRSPaymentAccountNumberThe UPS account number for the payor.
FRSPaymentPostalCodeThe postal code of the payor for the Ground Freight Pricing shipment.
FRSPaymentCountryCodeThe country code of the payor for the Ground Freight Pricing shipment.
PackageDeclaredValueType[i]The type of declared value (corresponding to the package at index i).
EPRAIndicatorIndicates that a Package Release Code is requested for this shipment.
ImportControlCodeCode for type of ImportControl label.
ImportControlDescriptionDescription for ImportControl.
RateCurrencyThe currency of the returned rates.
RatesWarningRated shipment warning message.
ReturnServiceCodeThe code for the request return service.
CurrencyCodeThe currency code associated with the monetary values present in the request.
DocumentsWhether the shipment contains only documents.
MaxRecordsMaximum number of candidates the user wishes to receive in the response.
RecipientCountryNameCountry name to which the shipment is destined.
RecipientTownTown name to where the shipment is destined (applicable to non-US addresses only).
SenderCountryNameCountry name from which the shipment is originating.
SenderTownTown name from which the shipment is originating (applicable to non-US addresses only).
WeightUnitWeight unit.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
TcpNoDelayWhether or not to delay when sending packets.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
GUIAvailableTells the component whether or not a message loop is available for processing events.
UseBackgroundThreadWhether threads created by the component are background threads.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2019 4D Payments Inc. - All rights reserved.
4D Shipping SDK 2020 .NET Edition - Version 20.0 [Build 7233]