UPSFreightRates Class
Properties Methods Events Configuration Settings Errors
Provides UPS Freight Rates service.
Syntax
inship.upsfreightrates()
Remarks
The UPSFreightRates class provides a way to retrieve rates for freight shipments. To use the class 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.UPSServer = "https://wwwcie.ups.com/webservices/FreightRate"
component.UPSAccessKey = "Your Access Key"
component.UPSUserId = "User Id"
component.UPSPassword = "Password"
component.UPSAccountNumber = "000000"
component.SenderName = "Developer Test 1"
component.SenderAddress1 = "101 Developer Way"
component.SenderCity = "Richmond"
component.SenderState = "VA"
component.SenderZipCode = "23224"
component.SenderCountryCode = "US"
component.RecipientName = "Consignee Test 1"
component.RecipientAddress1 = "1000 Consignee Street"
component.RecipientCity = "Allanton"
component.RecipientState = "MO"
component.RecipientZipCode = "63001"
component.RecipientCountryCode = "US"
component.PayorType = ptSender
component.HandlingUnit = "SKD:1"
component.CommodityCount = 1
component.CommodityDescription(0) = "LCD TVS"
component.CommodityFreightClass(0) = "77.5"
component.CommodityWeight(0) = "200"
component.CommodityFreightNMFC(0) = "132680"
component.CommodityFreightNMFCSub(0) = "02"
component.CommodityNumberOfPieces(0) = 20
component.CommodityValue(0) = "100"
component.GetRates
Debug.Print ("Total Charge: " & component.TotalCharge)
Debug.Print ("Billable Weight: " & component.BillableWeight)
Debug.Print ("Dimensional Weight: " & component.DimensionalWeight)
Dim i As Integer
For i = 0 To component.ChargeCount - 1
Debug.Print (component.ChargeType(0) & ": " & component.ChargeValue())
Next i
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| BillableWeight | Represents the billable weight associated with the shipment. |
| ChargeCount | The number of records in the Charge arrays. |
| ChargeType | Indicates the type of the charge. |
| ChargeDescription | The description of the rate. |
| ChargeValue | The value of the charge type specified by ChargeType . |
| 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. |
| CommodityCount | The number of records in the Commodity arrays. |
| CommodityDescription | Complete and accurate description of this commodity line item. |
| CommodityFreightClass | Indicates the freight class of the commodity. |
| CommodityFreightIsHazardous | Identifies if the Commodity item is hazardous. |
| CommodityFreightNMFC | Identifies the National Motor Freight Classification numbers. |
| CommodityFreightNMFCSub | Identifies the sub code of National Motor Freight Classification numbers. |
| CommodityFreightPackagingType | Identifies the Commodity item's packaging type. |
| CommodityNumberOfPieces | The total number of packages, cartons, or containers for the commodity line item. |
| CommodityValue | The value of an individual item being shipped. |
| CommodityWeight | The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code. |
| DimensionalWeight | Represents the dimensional weight associated with the shipment. |
| FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallType | This property determines the type of firewall to connect through. |
| FirewallHost | This property contains the name or IP address of firewall (optional). |
| FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
| FirewallPort | This property contains the TCP port for the firewall Host . |
| FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
| HandlingUnit | Describe the Handling Units (Movable Pieces) in this Shipment. |
| OverSeasLegHeight | The height of the shipment. |
| OverSeasLegLength | The length of the shipment. |
| OverSeasLegPricePerCubicFoot | The price per CubicFoot. |
| OverSeasLegPricePerCWT | Price per Hundredweight. |
| OverSeasLegTotalCubicFeet | Total cubic weight of the shipment, obtained by multiplying width by height by depth. |
| OverSeasLegWidth | The width of the shipment. |
| PayorAddress1 | Street name. |
| PayorAddress2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
| PayorCity | Name of city, town, etc. |
| PayorCountryCode | The country code for the payor of the shipment, or duties and taxes. |
| PayorName | Identifies the payor's name. |
| PayorType | Method of payment for shipment, or duties and taxes. |
| PayorState | State or province code. |
| PayorZipCode | Payor's postal code (if applicable). |
| ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
| ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
| ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
| ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
| ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| ProxySSL | This property determines when to use SSL for the connection to the proxy. |
| ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
| RecipientAddress1 | Street name. |
| RecipientAddress2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
| RecipientAddressFlags | Various flags that denote information about the address. |
| RecipientCity | Name of city, town, etc. |
| RecipientCountryCode | Country code. |
| RecipientState | State or province code. |
| RecipientZipCode | Postal code. |
| RecipientName | Identifies the recipient's name or company name. |
| RequestedService | The service selected for the shipment. |
| SenderAddress1 | Street name. |
| SenderAddress2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
| SenderCity | Name of city, town, etc. |
| SenderCountryCode | Country code. |
| SenderState | State or province code. |
| SenderZipCode | Postal code. |
| SenderName | Identifies the sender's locations name or company name. |
| SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertStore | The name of the certificate store for the client certificate. |
| SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
| SSLCertStoreType | The type of certificate store for this certificate. |
| SSLCertSubject | The subject of the certificate used for client authentication. |
| SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
| Timeout | A timeout for the component. |
| TotalCharge | Represents the total shipment charge. |
| UPSAccessKey | An identifier required to connect to a UPS server. |
| UPSAccountNumber | The shipper's UPS account number. |
| UPSPassword | Password to use for logging in to a UPS Server . |
| UPSServer | URL for the UPS server where the requests are sent. |
| UPSUserId | User Id for logging in to UPS. |
Method List
The following is the full list of the methods of the class 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 class 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 class 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. |