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

UPSRates Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

inship.upsrates()

Remarks

Rates class 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 class 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 class 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 class 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 class 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 UPSAccountNumbers. Eligibility is determined using the combination of UPSUserId and UPSAccountNumber. 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 class 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 class with short descriptions. Click on the links for further details.

AccountAddress1Street name.
AccountAddress2A specific detail on the address (such as building, suite, apartment, floor number etc.
AccountCityName of city, town, etc.
AccountCountryCodeCountry code.
AccountStateState or province code.
AccountZipCodePostal code.
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.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
PackageCountThe number of records in the Package arrays.
PackageBaseChargeBase charge applicable to this package.
PackageCODAmountThe COD monetary value for the package.
PackageCODTypeThe code that indicates the type of funds that will be used for the COD payment for this package.
PackageHeightThe height of the package to be shipped.
PackageInsuredValueAmount of insurance requested for this package.
PackageLengthThe length of the package to be shipped.
PackageNetChargeNet charge applicable to this package.
PackageTypeThe packaging type of the package being rated and/or shipped.
PackageRatingAggregateRating aggregate applicable to this package.
PackageSignatureTypeSpecifies one of the Delivery Signature Options requested for this package.
PackageSpecialServicesContains the collection of special services offered on the package level.
PackageTotalSurchargesTotal surcharges applicable to this package.
PackageWeightWeight of this package.
PackageWidthThe width of the package to be shipped.
PackageServiceIndexThe service index in the list of available services returned.
PickupTypePickup type used for the shipment that rate is requested for.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
RecipientAddress1Street name.
RecipientAddress2A specific detail on the address (such as building, suite, apartment, floor number etc.
RecipientAddressFlagsVarious flags that denote information about the address.
RecipientCityName of city, town, etc.
RecipientCountryCodeCountry code.
RecipientStateState or province code.
RecipientZipCodePostal code.
RecipientCandidateAggregateString representing the list of destination address candidates (if any).
RequestedServiceService type for which the shipping rate is requested.
SenderAddress1Street name.
SenderAddress2A specific detail on the address (such as building, suite, apartment, floor number etc.
SenderCityName of city, town, etc.
SenderCountryCodeCountry code.
SenderStateState or province code.
SenderZipCodePostal code.
SenderCandidateAggregateString representing the list of origin address candidates (if any).
ServiceCountThe number of records in the Service arrays.
ServiceAccountNetChargeNet charge amount applied to a ServiceType .
ServiceBusinessDaysNumber of business days from origin to destination location.
ServiceCustomerCenterCutoffTime the UPS Customer Service Center closes.
ServiceDelayDaysNumber of days the shipment is delayed in customs.
ServiceDeliveryDateThis indicates the shipment delivery date for the ServiceType .
ServiceDeliveryDayIndicates the day of the week the shipment can be delivered when using the ServiceType .
ServiceDeliveryTimeScheduled local delivery time.
ServiceGuaranteedDescriptionTextual description of a guaranteed delivery for a UPS service type in the list of available services returned.
ServiceHolidaysNumber of national holidays during transit.
ServiceListBaseChargeTransportation charges before surcharges and discounts applied to a ServiceType .
ServiceListNetChargeNet charge amount applied to a ServiceType .
ServiceListTotalSurchargeTotal surcharge amount for all additional services applied to a ServiceType .
ServiceRestDaysNumber of days the shipment is in rest due to non-business days.
ServiceTypeIndicates the service type in the list of available services returned.
ServiceTypeDescriptionIndicates the textual description of a service type in the list of available services returned.
ServiceShipDateDate UPS picks up the package from the origin.
ServiceShipTimeTime UPS picks up the package from the origin.
ServiceTransitTimeExpected number of days in transit from pickup to delivery for the ServiceType .
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.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf 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.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
TimeoutA timeout for the component.
TotalValueMonetary value of shipment contents.
TotalWeightTotal shipment's weight.
UPSAccessKeyAn identifier required to connect to a UPS server.
UPSAccountNumberThe shipper's UPS account number.
UPSPasswordPassword to use for logging in to a UPS Server .
UPSServerURL for the UPS server where the requests are sent.
UPSUserIdUser 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.

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 class 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 class 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