UPSFreightRates Bean
Properties Methods Events Configuration Settings Errors
Provides UPS Freight Rates service.
Syntax
InShip.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 bean 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 bean 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 bean 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 bean with short descriptions. Click on the links for further details.
RawRequest | Contains the complete request sent to the Server. |
RawResponse | Contains the complete response returned by the Server. |
XPath | Used to retrieve data at any place within the response. |
Warning | Warning message returned by the server. |
UseSOAP | Whether or not to use UPS' webservices. |
PickupOptions | Value-Added Freight Pickup Services. |
DeliveryOptions | Value-Added Freight Delivery Services. |
PiecesToSort | The number of pieces to sort and segregate. |
CurrencyCode | The currency code associated with the monetary values present in the request. |
WeightUnit | Weight unit. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowIdenticalRedirectURL | Allow redirects to the same URL. |
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. |
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. |
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. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
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. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
UserAgent | Information about the user agent (browser). |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
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). |
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. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
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 TCP 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. |
RecordLength | The length of received data records. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
UseIPv6 | Whether to use IPv6. |
TcpNoDelay | Whether or not to delay when sending packets. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
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. |
CodePage | The system code page used for Unicode to Multibyte translations. |