Determines domestic and international postage rates based on weight, size, class of mail, and origin/destination information.
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.
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.
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 NotesppNone
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.
When using Endicia as the PostageProvider there are different instructions for Production and Testing.
Endicia will provide you with a production account number and password. To use your account with the components...
- Set PostageProvider to ppEndicia.
- Set AccountNumber to your production account number (provided by Endicia).
- Set Password to your production password (provided by Endicia).
The components come with a built in sandbox account for your use. To use that account with the components...Server.
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.
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
|AreasServed||Areas where the PackagingType service is available when shipped to CountryCode .|
|CustomsForms||Customs forms required to mail to CountryCode .|
|Days||Estimated time for delivery.|
|ExpressMailInfo||Express Mail information when shipping to CountryCode .|
|Firewall||A set of properties related to firewall access.|
|Machinable||Indicates if the package being shipped is classified as machinable.|
|Observations||Additional mailing information based on country of destination.|
|Packages||A collection of packages contained in the shipment.|
|PostageProvider||The postage provider to use. If a postage-paid label is required either ppEndicia or ppStamps must be used.|
|PostalZone||Indicates the number of postal rate zones between the origin and destination zip codes.|
|Prohibitions||List of items prohibited from mailing to the destination country.|
|Proxy||A set of properties related to proxy access.|
|RecipientAddress||Identifies the recipient's address.|
|RequestedService||Service type for which the shipping rate is requested.|
|Restrictions||Restrictions on items being shipped.|
|SenderAddress||Identifies the sender's address from which the shipment is originating.|
|Services||Collection of all mail services available, as returned by USPS Server .|
|ShipmentSpecialServices||Contains the collection of special services offered by USPS on shipment level.|
|SSLAcceptServerCert||Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.|
|SSLCert||The certificate to be used during SSL negotiation.|
|SSLServerCert||The server certificate for the last established connection.|
|Timeout||A timeout for the component.|
|TotalValue||Total value of the items inside the package.|
|USPSAccount||Login information for USPS.|
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
|Config||Sets or retrieves a configuration setting.|
|GetRates||Calculates postage rates to ship a package via the RequestedService .|
|GetShippingTime||Returns the estimated time to ship a package from ZipCode to ZipCode .|
|Reset||Resets the internal state of the component and all properties to their default values.|
The following is the full list of the events fired by the component 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.|
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
|AddOnAggregate[i]||Indicates the AddOn raw XML.|
|AddOnAmount[i]||Indicates the AddOn amount.|
|AddOnCount||Total number of AddOns.|
|AddOnType[i]||Indicates the AddOn type.|
|AddOnTypeDescription[i]||Indicates the AddOn description.|
|CommercialRate||Contains the commercial postage rate for the indicated package.|
|DimensionalWeight[i]||The dimensional weight of the package at the indicated index.|
|EndiciaInsuranceType||The Insurance type when using Endicia.|
|EndiciaInsuredMail||Used to request Endicia mailpiece insurance.|
|EntryFacility||Postal facility where mail is entered.|
|HasXPath||Determines whether a specific element exists in the document.|
|IntlAcceptanceDateTime||Acceptance Date Time for getting a Guaranteed Delivery Date with Priority Mail Express International.|
|IntlDestinationPostalCode||Destination Postal Code for getting a Guaranteed Delivery Date with Priority Mail Express International.|
|IntlOriginZip||US origin ZIP Code used to obtain non-Flat Rate pricing and availability for Canada destinations using Priority Mail International.|
|MultipleRates||Indicates that the component should request rates for multiple packages.|
|RatesSpecialServices||Rates Special Services when requesting rates.|
|RateType||Indicates the rate type to be returned by Endicia.|
|RawRequest||Contains the complete request sent to the Server.|
|RawResponse||Contains the complete response returned by the Server.|
|RectangularShaped||Whether the package has a rectangular shape.|
|RegisteredMailValue||The value of registered mail sent in the request.|
|Restrictions[i]||The restrictions returned by USPS.|
|RestrictionsCount||The number of restrictions returned by USPS.|
|ServiceClassId[i]||ClassId for the service specified by the index i.|
|ServiceIndex||Services returned by USPS.|
|ShipDate||Date package will be mailed.|
|SortType||Sort level for applicable mail classes.|
|StampsAPIVersion||Controls the API version used for requests.|
|StampsTestMode||Controls whether requests are test requests or live requests.|
|UseDimensionalWeight||Determines whether to use the dimensional weight or not.|
|XAttrCount||The number of records in the XAttr arrays.|
|XAttrName[i]||The name of the indexed attribute.|
|XAttrValue[i]||The value of the indexed attribute.|
|XChildCount||The 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.|
|XElement||The name of the current element.|
|XParent||The parent of the current element.|
|XPath||Used to set the XPath within the response from the server.|
|XText||The text of the current element.|
|AcceptEncoding||Used to tell the server which types of content encodings the client supports.|
|AllowHTTPCompression||This property enables HTTP compression for receiving data.|
|AllowHTTPFallback||Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.|
|AllowNTLMFallback||Whether to allow fallback from Negotiate to NTLM when authenticating.|
|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.|
|ChunkSize||Specifies the chunk size in bytes when using chunked encoding.|
|CompressHTTPRequest||Set to true to compress the body of a PUT or POST request.|
|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.|
|HTTP2HeadersWithoutIndexing||HTTP2 headers that should not update the dynamic header table with incremental indexing.|
|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.|
|KerberosSPN||The Service Principal Name for the Kerberos Domain Controller.|
|LogLevel||The level of detail that is logged.|
|MaxHeaders||Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.|
|MaxHTTPCookies||Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.|
|MaxRedirectAttempts||Limits the number of redirects that are followed in a request.|
|NegotiatedHTTPVersion||The negotiated HTTP version.|
|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.|
|SentHeaders||The full set of headers as sent by the client.|
|StatusLine||The first line of the last response from the server.|
|TransferredData||The contents of the last response from the server.|
|TransferredDataLimit||The maximum number of incoming bytes to be stored by the component.|
|TransferredHeaders||The full set of headers as received from the server.|
|TransferredRequest||The full request as sent by the client.|
|UseChunkedEncoding||Enables or Disables HTTP chunked encoding for transfers.|
|UseIDNs||Whether to encode hostnames to internationalized domain names.|
|UsePlatformDeflate||Whether to use the platform implementation to decompress compressed responses.|
|UsePlatformHTTPClient||Whether or not to use the platform HTTP client.|
|UserAgent||Information about the user agent (browser).|
|CloseStreamAfterTransfer||If true, the component will close the upload or download stream after the transfer.|
|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).|
|FirewallListener||If true, the component binds to a SOCKS firewall as a server (IPPort only).|
|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.|
|KeepAliveInterval||The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.|
|KeepAliveTime||The inactivity time in milliseconds before a TCP keep-alive packet is sent.|
|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 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.|
|ProxyExceptionsList||A semicolon separated list of hosts and IPs to bypass when using a proxy.|
|TCPKeepAlive||Determines whether or not the keep alive socket option is enabled.|
|TcpNoDelay||Whether or not to delay when sending packets.|
|UseIPv6||Whether to use IPv6.|
|UseNTLMv2||Whether to use NTLM V2.|
|CACertFilePaths||The paths to CA certificate files when using Mono on Unix/Linux.|
|LogSSLPackets||Controls whether SSL packets are logged when using the internal security API.|
|ReuseSSLSession||Determines if the SSL session is reused.|
|SSLCACerts||A newline separated list of CA certificate to use during SSL client authentication.|
|SSLCheckCRL||Whether to check the Certificate Revocation List for the server certificate.|
|SSLCipherStrength||The minimum cipher strength used for bulk encryption.|
|SSLEnabledCipherSuites||The cipher suite to be used in an SSL negotiation.|
|SSLEnabledProtocols||Used to enable/disable the supported security protocols.|
|SSLEnableRenegotiation||Whether the renegotiation_info SSL extension is supported.|
|SSLIncludeCertChain||Whether the entire certificate chain is included in the SSLServerAuthentication event.|
|SSLProvider||The name of the security provider to use.|
|SSLSecurityFlags||Flags that control certificate verification.|
|SSLServerCACerts||A newline separated list of CA certificate to use during SSL server certificate validation.|
|TLS12SignatureAlgorithms||Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.|
|TLS12SupportedGroups||The supported groups for ECC.|
|TLS13KeyShareGroups||The groups for which to pregenerate key shares.|
|TLS13SignatureAlgorithms||The allowed certificate signature algorithms.|
|TLS13SupportedGroups||The supported groups for (EC)DHE key exchange.|
|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.|
|BuildInfo||Information about the product's build.|
|GUIAvailable||Tells the component whether or not a message loop is available for processing events.|
|LicenseInfo||Information about the current license.|
|UseInternalSecurityAPI||Tells the component whether or not to use the system security libraries or an internal implementation.|