UPSRates Component
Properties Methods Events Configuration Settings Errors
Provides domestic or international rates based on weight, service, and origin/destination information.
Syntax
DPayments.DShippingSDK.Upsrates
Remarks
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.
| AccountAddress | Identifies the UPS account holder's address, if different from the sender's address. |
| CODTotalAmount | The total amount to be collected on shipment level. |
| CODType | The code that indicates the type of funds that will be used for the COD payment. |
| CustomerType | Customer classification code. |
| Disclaimer | Disclaimer text. |
| DutyType | Auto duty type applicable for requests outside the US. |
| Firewall | A set of properties related to firewall access. |
| Packages | A collection of packages contained in the shipment. |
| PackageServiceIndex | The service index in the list of available services returned. |
| PickupType | Pickup type used for the shipment that rate is requested for. |
| Proxy | A set of properties related to proxy access. |
| RecipientAddress | Identifies the recipient's address. |
| RecipientCandidateAggregate | String representing the list of destination address candidates (if any). |
| RequestedService | Service type for which the shipping rate is requested. |
| SenderAddress | Identifies the sender's address from which the shipment is originating. |
| SenderCandidateAggregate | String representing the list of origin address candidates (if any). |
| Services | Collection of available services returned. |
| ShipDate | The date the user requests UPS to pickup the package from the origin. |
| ShipmentSpecialServices | Contains the collection of special services offered by UPS on shipment level. |
| SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to be used during SSL negotiation. |
| SSLServerCert | The server certificate for the last established connection. |
| Timeout | A timeout for the component. |
| TotalValue | Monetary value of shipment contents. |
| TotalWeight | Total shipment's weight. |
| UPSAccount | Login 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.
| Config | Sets or retrieves a configuration setting. |
| GetRates | Returns rate information for a specified or all available UPS RequestedService s. |
| GetShippingTime | Provides the average estimated time to ship a package from an origin to a destination address. |
| Reset | Resets 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.
| Error | Information about errors during data delivery. |
| Notification | Notification returned by the server upon successful request (if applicable). |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows 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.
| AlternateDeliveryAddress | Used to specify an XML or SOAP aggregate for Hold for Pickup or Delivery at UPS Access Points. |
| CurrencyCode | The currency code associated with the monetary values present in the request. |
| Documents | Whether the shipment contains only documents. |
| EPRAIndicator | Indicates that a Package Release Code is requested for this shipment. |
| FRSCommodityCount | Number 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. |
| FRSPaymentAccountNumber | The UPS account number for the payor. |
| FRSPaymentCountryCode | The country code of the payor for the Ground Freight Pricing shipment. |
| FRSPaymentDescription | Description for the Ground Freight Pricing payment type. |
| FRSPaymentPostalCode | The postal code of the payor for the Ground Freight Pricing shipment. |
| FRSPaymentType | Method of payment for the shipment. |
| HasXPath | Determines whether a specific element exists in the document. |
| ImportControlCode | Code for type of ImportControl label. |
| ImportControlDescription | Description for ImportControl. |
| IncludeNegotiatedRates | Whether to include the NegotiatedRatesIndicator in the request. |
| ItemizedChargesCode[i] | The Accesorial/Surcharge code of the itemized charge. |
| ItemizedChargesCount | The count of itemized charges. |
| ItemizedChargesCurrencyCode[i] | The currency used for the charge. |
| ItemizedChargesMonetaryValue[i] | The amount being charged. |
| ItemizedChargesSubType[i] | The subtype of the itemized charge. |
| MasterCartonIndicator | Determines whether to include the MasterCartonIndicator in the request. |
| MaxRecords | Maximum number of candidates the user wishes to receive in the response. |
| NotificationDialect | Used to specify the dialect for Alternate Delivery Location notifications and UAP Shipper notifications. |
| NotificationLanguage | Used to specify the language for Alternate Delivery Location notifications and UAP Shipper notifications. |
| PackageDeclaredValueType[i] | The type of declared value (corresponding to the package at index i). |
| RateCurrency | The currency of the returned rates. |
| RatesWarning | Rated shipment warning message. |
| RawRequest | Contains the complete request sent to the Server. |
| RawResponse | Contains the complete response returned by the Server. |
| RecipientCountryName | Country name to which the shipment is destined. |
| RecipientTown | Town name to where the shipment is destined (applicable to non-US addresses only). |
| ReturnFreightPrices | When true, UPS will use applicable freight pricing for shipments. |
| ReturnServiceCode | The code for the request return service. |
| SenderCountryName | Country name from which the shipment is originating. |
| SenderTown | Town name from which the shipment is originating (applicable to non-US addresses only). |
| ShipmentIndicationType | Whether shipment is Hold For Pickup or Delivery at UPS Access Points. |
| SimpleRateCode | Determines the box size for the UPS Simple Rate shipping option. |
| SubVersion | UPS SubVersion. |
| TaxInformationIndicator | Controls whether to send a TaxInformationIndicator. |
| UseSOAP | Whether or not to use UPS' webservices. |
| Warning | Warning message returned by the server. |
| WeightUnit | Weight unit. |
| WWEShipmentIndicator | Determines whether to include the WWEShipmentIndicator in the request. |
| XAttrCount | The number of records in the XAttr arrays. |
| XAttrName[i] | The name of the indexed attribute. |
| XAttrValue[i] | The value of the indexed attribute. |
| XChildCount | The 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. |
| XElement | The name of the current element. |
| XParent | The parent of the current element. |
| XPath | Used to set the XPath within the response from the server. |
| XText | The text of the current element. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| AllowNTLMFallback | Whether to allow fallback from Negotiate to NTLM when authenticating. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| HTTPVersion | The version of HTTP used by the component. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| LogLevel | The level of detail that is logged. |
| MaxHeaders | Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired. |
| MaxHTTPCookies | Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| NegotiatedHTTPVersion | The negotiated HTTP version. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| SentHeaders | The full set of headers as sent by the client. |
| StatusLine | The first line of the last response from the server. |
| TransferredData | The contents of the last response from the server. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| TransferredRequest | The full request as sent by the client. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| UseIDNs | Whether to encode hostnames to internationalized domain names. |
| UsePlatformDeflate | Whether to use the platform implementation to decompress compressed responses. |
| UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
| UserAgent | Information about the user agent (browser). |
| CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallListener | If true, the component binds to a SOCKS firewall as a server (IPPort only). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| UseNTLMv2 | Whether to use NTLM V2. |
| CACertFilePaths | The paths to CA certificate files when using Mono on Unix/Linux. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
| SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
| SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
| SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
| SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
| SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
| SSLNegotiatedVersion | Returns the negotiated protocol version. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| BuildInfo | Information about the product's build. |
| GUIAvailable | Tells the component whether or not a message loop is available for processing events. |
| LicenseInfo | Information about the current license. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |