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

USPSRates Component

Properties   Methods   Events   Configuration Settings   Errors  

Determines domestic and international postage rates based on weight, size, class of mail, and origin/destination information.

Syntax

TibxUSPSRates

Remarks

This component provides automated online access to domestic and international rate information. These domestic rates are for: Express Mail, First-Class Mail, and Priority Mail, as well as single-piece rates for all four Package Services: Parcel Post, Bound Printed Matter, Library Mail, and Media Mail. The international rates are for International Priority Mail, International Express Mail (EMS), and International First Class Mail, along with service standards for each class of service.

To use this component to receive rate information for domestic shipments, simply set the PackageWeight, SenderZipCode, RecipientZipCode, and PackageSize. Then simply call GetRates.

You may also optionally supply dimensions of the package with PackageLength, PackageWidth, and PackageHeight, and filter the results returned by ServiceType and PackageType.

In response to this request, the USPS Server will return a list of postage services available for mailing your package. You can access these services through the ServiceListNetCharge, ServiceType, and ServiceTypeDescription properties. The number of PostalZones between the SenderZipCode and RecipientZipCode will also be returned, along with any Restrictions for mailing to APO/FPO addresses.

To use this component to receive rate information for international shipments, simply set the PackageWeight, PackageType, and RecipientCountryCode, and then call GetRates.

For International rates, the following properties may be returned:

Please note that in most cases international packages may need a Customs Declaration form, and packages may also be subject to mailing restrictions unique to the destination country. To assist you with this important information, the International Rates component will return all the necessary mailing Restrictions, Prohibitions, and Observations, names of required CustomsForms, as well as delivery AreasServed.

To use this component, you must have a USPS account. You should also have already obtained a USPSUserId and USPSPassword uniquely assigned to your account by USPS.

This component also includes Endicia support to obtain rates through their web services. To use this service, you must have an Endicia USPSAccountNumber. You should also have already obtained a USPSUserId and USPSPassword uniquely assigned to your account by Endicia. The PostageProvider property must be set to ppEndicia to tell the component to use the Endicia protocol.

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

AreasServedAreas where the PackagingType service is available when shipped to CountryCode .
CustomsFormsCustoms forms required to mail to CountryCode .
DaysEstimated time for delivery.
ExpressMailInfoExpress Mail information when shipping to CountryCode .
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.
MachinableIndicates if the package being shipped is classified as machinable.
ObservationsAdditional mailing information based on country of destination.
PackageCountThe number of records in the Package arrays.
PackageGirthMeasurement around the widest part of the package, perpendicular to the Length .
PackageHeightThe height of the package to be shipped.
PackageLengthThe length of the package to be shipped.
PackageTypeThe packaging type of the package being rated and/or shipped.
PackageSizeSize of the package being mailed.
PackageWeightWeight of this package.
PackageWidthThe width of the package to be shipped.
PostageProviderThe postage provider to use.
PostalZoneIndicates the number of postal rate zones between the origin and destination zip codes.
ProhibitionsList of items prohibited from mailing to the destination country.
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.
RecipientCountryCodeCountry code.
RecipientZipCodePostal code.
RequestedServiceService type for which the shipping rate is requested.
RestrictionsRestrictions on items being shipped.
SenderZipCodePostal code.
ServiceCountThe number of records in the Service arrays.
ServiceCommitmentsService commitments for the PackagingType when shipping to CountryCode .
ServiceIndemnityCoverageIndicates the indemnity coverage available for this service.
ServiceInsuranceCommentExplains why no InsuranceCost was returned in the response.
ServiceInsuranceCostInsurance fee.
ServiceListNetChargeNet charge amount applied to a ServiceType .
ServiceMaxDimensionsMaximum dimensions of a package allowed when sending to the CountryCode .
ServiceMaxWeightMaximum weight of package allowed when sending to the CountryCode .
ServicePackagingTypeThe mail service type when shipping to CountryCode .
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.
ShipmentSpecialServicesContains the collection of special services offered by USPS 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.
TotalValueTotal value of the items inside the package.
USPSAccountNumberThe shipper's Endicia account number.
USPSPasswordPassword to use for logging in to the USPS Server .
USPSServerURL for the USPS server where the requests are sent.
USPSUserIdUser Id for logging in to the USPS Server .

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 .
GetRatesCalculates postage rates to ship a package via the RequestedService .
GetShippingTimeReturns the estimated time to ship a package from ZipCode to ZipCode .
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 USPS.
RawResponseContains the complete response returned by the USPS server.
XPathUsed to retrieve data at any place within the response.
RequesterIdThe Requester Id to be used for Endicia requests.
CommercialRateContains the commercial postage rate for the indicated package.
DimensionalWeight[i]The dimensional weight of the package at the indicated index.
UseDimensionalWeightDetermines whether to use the dimensional weight or not.
EntryFacilityPostal facility where mail is entered.
EndiciaInsuranceTypeThe Insurance type when using Endicia.
EndiciaInsuredMailUsed to request Endicia mailpiece insurance.
ServiceClassId[i]ClassId for the service specified by the index i.
RateTypeIndicates the rate type to be returned by Endicia.
RatesSpecialServicesRates Special Services when requesting rates.
RestrictionsCountThe number of restrictions returned by USPS.
Restrictions[i]The restrictions returned by USPS.
SortTypeSort level for applicable mail classes.
ShipDateDate package will be mailed.
ServiceIndexServices returned by USPS.
AddOnCountTotal number of AddOns.
AddOnType[i]Indicates the AddOn type.
AddOnDescription[i]Indicates the AddOn description.
AddOnAmount[i]Indicates the AddOn amount.
AddOnAggregate[i]Indicates the AddOn raw XML.
RectangularShapedWhether the package has a rectangular shape.
IntlOriginZipUS origin ZIP Code used to obtain non-Flat Rate pricing and availability for Canada destinations using Priority Mail International.
IntlDestinationPostalCodeDestination Postal Code for getting a Guaranteed Delivery Date with Priority Mail Express International.
IntlAcceptanceDateTimeAcceptance Date Time for getting a Guaranteed Delivery Date with Priority Mail Express International.
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