4D Shipping SDK 2020 .NET Edition

Questions / Feedback?

EzRates Component

Properties   Methods   Events   Configuration Settings   Errors  

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




The EzRates component provides a standardized interface to all 3 supported carriers. This allows you to reduce the code needed to create an application supporting multiple carriers. For more fine grained control over settings specific to individual carriers you may wish to use the component that is specific to the carrier.

When providing origin, destination information, weight, and service, this component allows a user to obtain a rate quote for a specific service, or a list of available services with the respective rate quotes.

You can send a rate request by calling the GetRates method for:

  • a specific service (when RequestedService is specified). In this case, the component will return rates for packages based on a combination of origin, destination, service type, weight, and package type. This also checks if the requested service is available, checks your origin/destination pair and ship date to determine whether the service you requested is a valid service type.
  • all available services (when RequestedService is set to UNSPECIFIED, which is the default value) and a specified destination.

When requesting a rate quote, include as much detail as possible about your shipment. This information is important for calculating the correct shipping costs with surcharges.

Rating for a Multiple Package Shipment (MPS) is available for FedEx and UPS, but not USPS.

Please note that all rate quotes are estimates only and may differ from the actual invoiced amount.

To use this component, you must set the appropriate Account settings for the specified Provider.

Canada Post Setup and Required Properties

When retrieving rates via Canada Post, the following fields are required:

UserId The login username for your Canada Post account.
Password The login password for your Canada Post account.
AccountNumber The customer number of the owner of the mail (mailed on behalf of customer).
ZipCode Postal Code from which the parcel will be sent.
CountryCode The destination country code.
ZipCode The destination Postal Code. Required when shipping to CA or US. Not required for all other international shipments.
Weight The weight of the parcel in kilograms (e.g. 99.999).

You can optionally set the following fields when requesting rates:

Length Longest dimension (3.1 digits e.g. 999.9 pattern).
Width Second longest dimension (3.1 digits e.g. 999.9 pattern).
Height Shortest dimension (3.1 digits e.g. 999.9 pattern).
PackagingType Specify a specific packaging type (when applicable).
RequestedService A specific service to be rated. If no instances of service-code are included in the request, all services applicable to the shipment and destination will be rated and returned.

Note: Rates will only be retrieved for the first package within Packages, as multiple package shipments are not supported.

After a successful GetRates call, the following fields will be populated:

AccountBaseCharge Base cost of the shipment before taxes (numeric 99999.99).
AccountNetCharge Total cost of the shipment if sent using this service including the cost of selected or required options, surcharges, discounts and taxes.
AccountTotalDiscount Total amount of discounts.
AccountTotalSurcharge Total amount of surcharges.
ServiceType Service type for the mail service being quoted.
ServiceTypeDescription Service name in preferred language.
TransitTime Indicates the number of days from drop-off or pickup to 1st delivery attempt.
DeliveryDate The estimated date of delivery, starting from the expected mailing-date.
GuaranteedDescription Indicates if the delivery date is guaranteed ("true" or "false").
CanadaGstAmount Goods and services tax (numeric 99999.99).
CanadaPstAmount Provincial sales tax (numeric 99999.99).
CanadaHstAmount Harmonized sales tax (numeric 99999.99).

Note: Contract based rate quotes are also supported by setting CanadaContractId to your Canada Post Contract ID prior to calling GetRates.

The Canada Post URLS are:

Test (Development) https://ct.soa-gw.canadapost.ca
Production https://soa-gw.canadapost.ca

Property List

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

AccountLogin information for the specified Provider .
FirewallA set of properties related to firewall access.
PackagesA collection of packages contained in the shipment.
ProviderWhich provider to use.
ProxyA set of properties related to proxy access.
RecipientAddressIdentifies the recipient's address.
RequestedServiceService type for which the shipping rate is requested.
SenderAddressIdentifies the sender's address.
ServicesCollection of available services returned for the shipment being rated.
ShipmentSpecialServicesContains the collection of special services offered.
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.
TotalWeightTotal shipment's weight.

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 services.
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.

CanadaContractIdThe Contract Id of a Canada Post account used to identify a commercial contract.
CanadaGstAmount[i]The amount of Goods and Services Tax (GST) for the service, specified by 'i', when using Canada Post.
CanadaHstAmount[i]The amount of Harmonized Sales Tax (HST) for the service, specified by 'i', when using Canada Post.
CanadaPstAmount[i]The amount of Provincial Sales Tax (PST) for the service, specified by 'i', when using Canada Post.
CSPProductIdIdentifies the CSP product.
CSPProductVersionIdentifies the CSP product version.
CSPUserKeyCSP end user key.
CSPUserPasswordCSP end user password.
EndiciaInsuranceTypeThe Insurance type when using Endicia.
EndiciaInsuredMailUsed to request Endicia mailpiece insurance.
EndiciaTestModeControls whether requests are test requests or live requests.
HasXPathDetermines whether a specific element exists in the document.
PostageProviderThe postage provider to use.
RawRequestContains the complete request sent to the Server.
RawResponseContains the complete response returned by the Server.
TotalWeightThe total weight of the shipment.
XAttrCountThe number of records in the XAttr arrays.
XAttrName[i]The name of the indexed attribute.
XAttrValue[i]The value of the indexed attribute.
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.
XElementThe name of the current element.
XParentThe parent of the current element.
XPathUsed to set the XPath within the response from the server.
XTextThe text of the current element.
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.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
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.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
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.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
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.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
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.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformDeflateWhether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
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.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
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.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
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.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
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.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
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.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2023 4D Payments Inc. - All rights reserved.
4D Shipping SDK 2020 .NET Edition - Version 20.1 [Build 8435]