Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

UPSRates Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

nsoftware.InShip.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.

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 retrieve data at any place within the response.
WarningWarning message returned by the server.
UseSOAPWhether or not to use UPS' webservices.
PackageDeclaredValueType[i]The type of declared value (corresponding to the package at index i).
RateCurrencyThe currency of the returned rates.
RatesWarningRated shipment warning message.
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.
AllowIdenticalRedirectURLAllow redirects to the same URL.
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.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
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.
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.
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).
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 TCP 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.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
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.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0