UPSFreightRates Component
Properties Methods Events Configuration Settings Errors
Provides UPS Freight Rates service.
Syntax
DPayments.DShippingSDK.Upsfreightrates
Remarks
The UPSFreightRates component provides a way to retrieve rates for freight shipments. To use the component first set RequestedService to the service for which rates will be retrieved. Then specify the sender, recipient, and shipment information and call GetRates. Upon response Charges, TotalCharge, BillableWeight, and DimensionalWeight will be populated. For instance:
component.UPSAccount.Server = "https://wwwcie.ups.com/webservices/FreightRate";
component.UPSAccount.AccessKey = "Your Access Key";
component.UPSAccount.UserId = "User Id";
component.UPSAccount.Password = "Password";
component.UPSAccount.AccountNumber = "000000";
component.SenderName = "Developer Test 1";
component.SenderAddress.Address1 = "101 Developer Way";
component.SenderAddress.City = "Richmond";
component.SenderAddress.State = "VA";
component.SenderAddress.ZipCode = "23224";
component.SenderAddress.CountryCode = "US";
component.RecipientName = "Consignee Test 1";
component.RecipientAddress.Address1 = "1000 Consignee Street";
component.RecipientAddress.City = "Allanton";
component.RecipientAddress.State = "MO";
component.RecipientAddress.ZipCode = "63001";
component.RecipientAddress.CountryCode = "US";
component.Payor.PayorType = TPayorTypes.ptSender;
component.HandlingUnit = "SKD:1";
CommodityDetail item = new CommodityDetail();
item.Description = "LCD TVS";
item.FreightClass = "77.5";
item.Weight = "200";
item.FreightNMFC = "132680";
item.FreightNMFCSub = "02";
item.NumberOfPieces = 20;
item.Value = "100";
component.Commodities.Add(item);
component.GetRates();
Console.WriteLine("Total Charge: " + component.TotalCharge);
Console.WriteLine("Billable Weight: " + component.BillableWeight);
Console.WriteLine("Dimensional Weight: " + component.DimensionalWeight);
for (int i = 0; i < component.Charges.Count; i++)
{
Console.WriteLine(component.Charges[i].ChargeType + ": " + component.Charges[i].Value);
}
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| BillableWeight | Represents the billable weight associated with the shipment. |
| Charges | Collection of shipment charges. |
| CODPayorType | The type of payment that will be used for the COD payment. |
| CODTotalAmount | The total amount of additional fees. |
| CODType | The code that indicates the type of funds that will be used for the COD payment. |
| Commodities | Collection of commodity items of the shipment. |
| DimensionalWeight | Represents the dimensional weight associated with the shipment. |
| Firewall | A set of properties related to firewall access. |
| HandlingUnit | Describe the Handling Units (Movable Pieces) in this Shipment. |
| OverSeasLeg | Identifies the OverSeasLeg detail. Required when origin or destination is Hawaii, Alaska, and Puerto Rico. |
| Payor | Identifies the payor of transportation charges for the shipment. |
| Proxy | A set of properties related to proxy access. |
| RecipientAddress | Identifies the recipient's address. |
| RecipientName | Identifies the recipient's name or company name. |
| RequestedService | The service selected for the shipment. |
| SenderAddress | Identifies the sender's address. |
| SenderName | Identifies the sender's locations name or company name. |
| 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. |
| TotalCharge | Represents the total shipment charge. |
| 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. |
| 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. |
| DeliveryOptions | Value-Added Freight Delivery Services. |
| HasXPath | Determines whether a specific element exists in the document. |
| 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. |
| 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. |
| PickupOptions | Value-Added Freight Pickup Services. |
| PiecesToSort | The number of pieces to sort and segregate. |
| RawRequest | Contains the complete request sent to the Server. |
| RawResponse | Contains the complete response returned by the Server. |
| ShipmentIndicationType | Whether shipment is Hold For Pickup or Delivery at UPS Access Points. |
| 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. |
| 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. |