4D Shipping SDK 2020 .NET Edition
4D Shipping SDK 2020 .NET Edition
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

DPayments.DShipping.Uspsrates

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 Weight, ZipCode, ZipCode, and Size. Then simply call GetRates.

You may also optionally supply dimensions of the package with Length, Width, and Height, and filter the results returned by ServiceType and PackagingType.

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 ListNetCharge, ServiceType, and ServiceTypeDescription fields. The number of PostalZones between the ZipCode and ZipCode 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 Weight, PackagingType, and CountryCode, 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.

Postage Provider Notes

ppNone

When using USPS as the PostageProvider (i.e. ppNone) you will need to...

  • Set PostageProvider to ppNone (default).
  • Set UserId to the UserId provided by USPS.
  • Set Password to the password provided by USPS.
  • Set Server to either the test or production server.
ppEndicia

When using Endicia as the PostageProvider there are different instructions for Production and Testing.

Production

Endicia will provide you with a production account number and password. To use your account with the components...

Testing

The components come with a built in sandbox account for your use. To use that account with the components...

In all cases the component will send requests to the correct server without setting Server.

ppStamps

When using Stamps.com as the PostageProvider you will need to...

  • Set PostageProvider to ppStamps.
  • Set UserId to the sandbox or production user provided by Stamps.com.
  • Set AccountNumber to the sandbox or production account number provided by Stamps.com.
  • Set Password to the sandbox or production password provided by Stamps.com.
  • Set Server to either the test or production server.

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 .
FirewallA set of properties related to firewall access.
MachinableIndicates if the package being shipped is classified as machinable.
ObservationsAdditional mailing information based on country of destination.
PackagesA collection of packages contained in the shipment.
PostageProviderThe postage provider to use. If a postage-paid label is required either ppEndicia or ppStamps must be used.
PostalZoneIndicates the number of postal rate zones between the origin and destination zip codes.
ProhibitionsList of items prohibited from mailing to the destination country.
ProxyA set of properties related to proxy access.
RecipientAddressIdentifies the recipient's address.
RequestedServiceService type for which the shipping rate is requested.
RestrictionsRestrictions on items being shipped.
SenderAddressIdentifies the sender's address from which the shipment is originating.
ServicesCollection of all mail services available, as returned by USPS Server .
ShipmentSpecialServicesContains the collection of special services offered by USPS 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.
TotalValueTotal value of the items inside the package.
USPSAccountLogin information for USPS.

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 the Server.
RawResponseContains the complete response returned by the Server.
XPathUsed to set the XPath within the response from the server.
HasXPathDetermines whether a specific element exists in the document.
XParentThe parent of the current element.
XElementThe name of the current element.
XTextThe text of the current element.
XChildCountThe number of records in the XChild arrays.
XChildElement[i]The name of the indexed child element.
XChildText[i]The text of the indexed child element.
XAttrCountThe number of records in the XAttr arrays.
XAttrName[i]The name of the indexed attribute.
XAttrValue[i]The value of the indexed attribute.
RegisteredMailValueThe value of registered mail sent in the request.
StampsTestModeControls whether requests are test requests or live requests.
StampsAPIVersionControls the API version used for 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.
MultipleRatesIndicates that the component should request rates for multiple packages.
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.
AddOnTypeDescription[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.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
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.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
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.
TransferredDataThe contents of the last response from the server.
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.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
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).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
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 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.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
TcpNoDelayWhether or not to delay when sending packets.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
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.
GUIAvailableTells the component whether or not a message loop is available for processing events.
UseBackgroundThreadWhether threads created by the component are background threads.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2019 4D Payments Inc. - All rights reserved.
4D Shipping SDK 2020 .NET Edition - Version 20.0 [Build 7233]