EzRates Component
Properties Methods Events Configuration Settings Errors
Provides domestic or international rates based on weight, service, and origin/destination information.
Syntax
DPayments.DShippingSDK.Ezrates
Remarks
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.
| Account | Login information for the specified Provider . |
| Firewall | A set of properties related to firewall access. |
| Packages | A collection of packages contained in the shipment. |
| Provider | Which provider to use. |
| 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. |
| SenderAddress | Identifies the sender's address. |
| Services | Collection of available services returned for the shipment being rated. |
| ShipmentSpecialServices | Contains the collection of special services offered. |
| 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. |
| TotalWeight | Total 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.
| Config | Sets or retrieves a configuration setting. |
| GetRates | Returns rate information for a specified or all available services. |
| Reset | Resets 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.
| 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. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| CanadaContractId | The 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. |
| CSPProductId | Identifies the CSP product. |
| CSPProductVersion | Identifies the CSP product version. |
| CSPUserKey | CSP end user key. |
| CSPUserPassword | CSP end user password. |
| EndiciaInsuranceType | The Insurance type when using Endicia. |
| EndiciaInsuredMail | Used to request Endicia mailpiece insurance. |
| EndiciaTestMode | Controls whether requests are test requests or live requests. |
| HasXPath | Determines whether a specific element exists in the document. |
| PostageProvider | The postage provider to use. |
| RawRequest | Contains the complete request sent to the Server. |
| RawResponse | Contains the complete response returned by the Server. |
| TotalWeight | The total weight of the shipment. |
| 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. |
| SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
| SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
| SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
| SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
| SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
| SSLNegotiatedVersion | Returns the negotiated protocol version. |
| 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. |